SOAP API – GetUserServices

GetUserServices( username ) : ViewUserService[]

Since: EngageIP v25.2

Returns the list of a user's services, or throws an exception if the user does not exist.

This method returns an array of ViewUserService objects which consists of the following properties:

ID (Integer) -The unique ID of the user service
ServiceID (Integer) - The ID that references the service defined in the product catalog
UserID (Int) - The ID of the user that has the service in a package
CreatedDate (DateTime) - The date time stamp for when this usre service was created
UserPackageID (Integer) - ID referencing the user package to which this user service belongs
Service (String) -The name of the service in the product catalog
User(String) -The username reference by the UserID
Billtimes (Integer) - Indicates if a one-time service needs to be billed. 1 indicates the one-time service needs to be billed, zero indicates that it has been billed and null indicates that this is a recurring service.
Amount (Double) - Recurring charges for the service, null if one time charge
Optional (Boolean) - Indicates if the user service is optional
OptionalServiceStartDate (DateTime) - The date the optional service became active
OptionalServiceTransactionDate (DateTime) - Indicates the exact moment the optional service was created
OptionalServiceBillDate (Integer) -The date the optional service became billable
Canceled (Boolean) - Indicates if the user service has been canceled
OneTimeAmount (Double) - One time charges for the service, null if recurring charges
CreatedBy_UserID (Integer) - The ID of the user who created the user package
CreatedBy_User (String) - The name associated with the CreatedBy_UserID
LastUpdateDate (DateTime) - The date of the most recent change to the user service
CanceledDate (DateTime) - The date the service was canceled, otherwise null
PackageID (Integer) - The ID referencing the package in the product catalog

Parameters:

username (String) - The username for which to retrieve the user services. An exception will be thrown if the username does not exist.

Returns:

An array of ViewUserService Objects representing the user services

Possible Exceptions:

INVALID USERNAME

SOAP 1.2

The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.

POST /AdminPortal/webservice.asmx HTTP/1.1
Host: localhost
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap12:Header>
  <soap12:Body>
    <GetUserServices xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetUserServices>
  </soap12:Body>
</soap12:Envelope>
HTTP/1.1 200 OK
Content-Type: application/soap+xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap12:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap12="http://www.w3.org/2003/05/soap-envelope">
  <soap12:Body>
    <GetUserServicesResponse xmlns="Logisense_EngageIP">
      <GetUserServicesResult>
        <ViewUserService>
          <ID>int</ID>
          <ServiceID>int</ServiceID>
          <UserID>int</UserID>
          <CreatedDate>dateTime</CreatedDate>
          <UserPackageID>int</UserPackageID>
          <Service>string</Service>
          <User>string</User>
          <Name>string</Name>
          <BillTimes>int</BillTimes>
          <Amount>double</Amount>
          <Optional>boolean</Optional>
          <OptionalServiceStartDate>dateTime</OptionalServiceStartDate>
          <OptionalTransactionDate>dateTime</OptionalTransactionDate>
          <OptionalServiceBillDate>dateTime</OptionalServiceBillDate>
          <OneTimeAmount>double</OneTimeAmount>
          <CreatedBy_UserID>int</CreatedBy_UserID>
          <CreatedBy_User>string</CreatedBy_User>
          <Canceled>boolean</Canceled>
          <RelatedTo_UserServiceID>int</RelatedTo_UserServiceID>
          <RelatedTo_UserService>string</RelatedTo_UserService>
          <LastUpdateDate>dateTime</LastUpdateDate>
          <CanceledDate>dateTime</CanceledDate>
          <PackageID>int</PackageID>
        </ViewUserService>
        <ViewUserService>
          <ID>int</ID>
          <ServiceID>int</ServiceID>
          <UserID>int</UserID>
          <CreatedDate>dateTime</CreatedDate>
          <UserPackageID>int</UserPackageID>
          <Service>string</Service>
          <User>string</User>
          <Name>string</Name>
          <BillTimes>int</BillTimes>
          <Amount>double</Amount>
          <Optional>boolean</Optional>
          <OptionalServiceStartDate>dateTime</OptionalServiceStartDate>
          <OptionalTransactionDate>dateTime</OptionalTransactionDate>
          <OptionalServiceBillDate>dateTime</OptionalServiceBillDate>
          <OneTimeAmount>double</OneTimeAmount>
          <CreatedBy_UserID>int</CreatedBy_UserID>
          <CreatedBy_User>string</CreatedBy_User>
          <Canceled>boolean</Canceled>
          <RelatedTo_UserServiceID>int</RelatedTo_UserServiceID>
          <RelatedTo_UserService>string</RelatedTo_UserService>
          <LastUpdateDate>dateTime</LastUpdateDate>
          <CanceledDate>dateTime</CanceledDate>
          <PackageID>int</PackageID>
        </ViewUserService>
      </GetUserServicesResult>
    </GetUserServicesResponse>
  </soap12:Body>
</soap12:Envelope>

SOAP 1.1

The following is a sample SOAP 1.1 request and response. The placeholders shown need to be replaced with actual values.

POST /AdminPortal/webservice.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/GetUserServices"

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Header>
    <AuthHeader xmlns="Logisense_EngageIP">
      <Username>string</Username>
      <Password>string</Password>
    </AuthHeader>
  </soap:Header>
  <soap:Body>
    <GetUserServices xmlns="Logisense_EngageIP">
      <username>string</username>
    </GetUserServices>
  </soap:Body>
</soap:Envelope>
HTTP/1.1 200 OK
Content-Type: text/xml; charset=utf-8
Content-Length: length

<?xml version="1.0" encoding="utf-8"?>
<soap:Envelope xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/">
  <soap:Body>
    <GetUserServicesResponse xmlns="Logisense_EngageIP">
      <GetUserServicesResult>
        <ViewUserService>
          <ID>int</ID>
          <ServiceID>int</ServiceID>
          <UserID>int</UserID>
          <CreatedDate>dateTime</CreatedDate>
          <UserPackageID>int</UserPackageID>
          <Service>string</Service>
          <User>string</User>
          <Name>string</Name>
          <BillTimes>int</BillTimes>
          <Amount>double</Amount>
          <Optional>boolean</Optional>
          <OptionalServiceStartDate>dateTime</OptionalServiceStartDate>
          <OptionalTransactionDate>dateTime</OptionalTransactionDate>
          <OptionalServiceBillDate>dateTime</OptionalServiceBillDate>
          <OneTimeAmount>double</OneTimeAmount>
          <CreatedBy_UserID>int</CreatedBy_UserID>
          <CreatedBy_User>string</CreatedBy_User>
          <Canceled>boolean</Canceled>
          <RelatedTo_UserServiceID>int</RelatedTo_UserServiceID>
          <RelatedTo_UserService>string</RelatedTo_UserService>
          <LastUpdateDate>dateTime</LastUpdateDate>
          <CanceledDate>dateTime</CanceledDate>
          <PackageID>int</PackageID>
        </ViewUserService>
        <ViewUserService>
          <ID>int</ID>
          <ServiceID>int</ServiceID>
          <UserID>int</UserID>
          <CreatedDate>dateTime</CreatedDate>
          <UserPackageID>int</UserPackageID>
          <Service>string</Service>
          <User>string</User>
          <Name>string</Name>
          <BillTimes>int</BillTimes>
          <Amount>double</Amount>
          <Optional>boolean</Optional>
          <OptionalServiceStartDate>dateTime</OptionalServiceStartDate>
          <OptionalTransactionDate>dateTime</OptionalTransactionDate>
          <OptionalServiceBillDate>dateTime</OptionalServiceBillDate>
          <OneTimeAmount>double</OneTimeAmount>
          <CreatedBy_UserID>int</CreatedBy_UserID>
          <CreatedBy_User>string</CreatedBy_User>
          <Canceled>boolean</Canceled>
          <RelatedTo_UserServiceID>int</RelatedTo_UserServiceID>
          <RelatedTo_UserService>string</RelatedTo_UserService>
          <LastUpdateDate>dateTime</LastUpdateDate>
          <CanceledDate>dateTime</CanceledDate>
          <PackageID>int</PackageID>
        </ViewUserService>
      </GetUserServicesResult>
    </GetUserServicesResponse>
  </soap:Body>
</soap:Envelope>