Get Subscriber Information

Last updated
Save as PDF

getSubscriberInfo

The getSubscriberInfo web service returns detailed information about an ESS subscriber.

SubscriberInfo getSubscriberInfo(int SubscriberID) throws WSException

SubscriberID: An integer identifier of the subscriber from whose queue transactions will be retrieved. The valid range for this field is 1-999999999.

For more information about the SubscriberInfo object returned, see SubscriberInfo.

Authorization Requirements

The credentials supplied with this method call (as specified in the accompanying WS-Security header) must be authorized to the following application(s) and their associated role-based permissions.

Required Application Licenses
- Remote Integration

Required User Permissions
- Can maintain integration

Customer integrators are authorized to their own company's data only.

Exceptions

002 Required field not specified.
003 User not authorized.
004 Subscriber ID not found.
005 Subscriber ID out of range.
007 User not authorized.

Sample getSubscriberInfo Request

Only the SOAP body is shown. To see a sample SOAP Envelope and Header, view the Web Service Security page.

<soapenv:Body>

<getSubscriberInfo>

<subscriberID>1</subscriberID>

</getSubscriberInfo>

</soapenv:Body>

Sample getSubscriberInfo Response

<soapenv:Body>

<getSubscriberInfoResponse>

<getSubscriberInfoReturn>

<enqueueEnabled>1</enqueueEnabled>

<enqueueCount>64</enqueueCount>

<enqueueCountResetTime>2008-03-04T01:48:34.000Z</enqueueCountResetTime>

<enqueueEnabledTime>2008-03-04T01:48:34.000Z</enqueueEnabledTime>

<fullThreshold>500000</fullThreshold>

<lastDequeueTime>2008-03-05T21:17:43.000Z</lastDequeueTime>

<lastEnqueueTime>2008-03-05T21:45:02.000Z</lastEnqueueTime>

<dequeueBlockCount>500</dequeueBlockCount>

<queueDepth>64</queueDepth>

<warnThreshold>50000</warnThreshold>

</getSubscriberInfoReturn>

<getSubscriberInfoResponse>

</soapenv:Body>