SOAP API - GetUserPackageFromResource

GetUserPackageFromResource( resoruceTypeID, resourceName ) : ViewUserPackage

Since: EngageIP v25.2

Returns userpackage related to the supplied ResourceName and ResourceType, in ViewUserPackage object; if record is found for the supplied ResourceName and ResourceType , if no match found returns null

This method returns a ViewUserPackage object which have the following properties:

  • ID (Integer) - The unique ID for the user package

  • UserID (Integer) - The ID of the user

  • User (String) - The name of the user associated with the UserID

  • PackageID (Integer) - The ID of the package associated with this user package

  • Package (String) - The name of the assigned package associated with the PackageID

  • Amount (Double) - The amount of the recurring charges of the package

  • CreatedDate (DateTime) - The date/time stamp of when the record was created

  • NextBillDate (DateTime) - The date/time for the next billing cycle

  • Name (String) - The name of the user package

  • CreditRatingID (Integer) - The ID of the associated credit rating

  • BillGroupID (Integer) - The ID of the associated bill group

  • ActingOwnerID (Integer) - The ID of the owner who defines the package

  • Current_StatusTypeID (Integer) - The current status of the user package, the ID corresponds to the four base status types of Active, Canceled, Prospect and Suspended

  • Pending (String) - Indicates if the packages is waiting for a resource or equipment before becoming billable

  • OneTimeAmount (Double) - One time charge amount or non-recurring charges for the user package, for example a setup or installation fee

  • SKU (String) - The SKU for this user package

  • EffectiveDate (DateTime) - The effective date of this user package

  • CanceledDate (DateTime) - The date/time stamp when this user package was cancelled

  • EffectiveCancelDate (DateTime) - The effective date of the cancellation

  • BulkQuantity (Integer) - A billing multiplier that can be used if there is no unique data required for the user package

  • UserPackageStatusTypeD (Integer) - The ID of the status type associated with this user package

  • UserPackageStatusType (String) - The name of the status type associated with the UserPackageStatusTypeID

  • StatusTypeID (Integer) - The package status

  • StatusType (String) - The name of the status type associated with the StatusTypeID as defined by the four base status types of Active, Canceled, Prospect and Suspended

  • UserPackageParentID (Integer) - The ID of the parent package

  • CreatedBy_UserID (Integer) - The ID of the user who created the user package

  • CreatedBy_User (String) - The name associated with the CreatedBy_UserID

  • User_OwnerID (Integer) - The ID of the owner to which the user belongs. NOTE: In the case of an unbranded owner the acting owner and owner are distinct.

  • Parent_UserID (Integer) - Parent account ID if the the user is a child account, otherwise null

Parameters:

  • resourceTypeID(Integer) - The ID that references the resource type, for example DID

  • resourceName(String) - The value for the resource, for example 555-555-5555

Returns:

A ViewUserPackage object

Possible Exceptions:

  • INVALID RESOURCE TYPE ID

  • INVALID RESOURCE NAME


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> <GetUserPackageFromResource xmlns="Logisense_EngageIP"> <resourceTypeID>int</resourceTypeID> <resourceName>string</resourceName> </GetUserPackageFromResource> </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> <GetUserPackageFromResourceResponse xmlns="Logisense_EngageIP"> <GetUserPackageFromResourceResult> <ID>int</ID> <UserID>int</UserID> <PackageID>int</PackageID> <Amount>double</Amount> <CreatedDate>dateTime</CreatedDate> <NextBillDate>dateTime</NextBillDate> <Name>string</Name> <Package>string</Package> <User>string</User> <CreditRatingID>int</CreditRatingID> <BillGroupID>int</BillGroupID> <ActingOwnerID>int</ActingOwnerID> <Current_StatusTypeID>int</Current_StatusTypeID> <Pending>string</Pending> <OneTimeAmount>double</OneTimeAmount> <SKU>string</SKU> <EffectiveDate>dateTime</EffectiveDate> <CanceledDate>dateTime</CanceledDate> <BulkQuantity>int</BulkQuantity> <UserPackageStatusTypeID>int</UserPackageStatusTypeID> <UserPackageStatusType>string</UserPackageStatusType> <StatusTypeID>int</StatusTypeID> <StatusType>string</StatusType> <UserPackageParentID>int</UserPackageParentID> <EffectiveCancelDate>dateTime</EffectiveCancelDate> <CreatedBy_UserID>int</CreatedBy_UserID> <CreatedBy_User>string</CreatedBy_User> <User_OwnerID>int</User_OwnerID> <Parent_UserID>int</Parent_UserID> </GetUserPackageFromResourceResult> </GetUserPackageFromResourceResponse> </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/GetUserPackageFromResource" <?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> <GetUserPackageFromResource xmlns="Logisense_EngageIP"> <resourceTypeID>int</resourceTypeID> <resourceName>string</resourceName> </GetUserPackageFromResource> </soap:Body> </soap:Envelope>