GetUserPackageContract( userPackageID ) : ViewUserPackageAttributeContract
Since: EngageIP v25.2
Gets Contract information for the supplied UserPackage and returns a ViewUserPackageAttributeContract object if a contract is found, otherwise returns null.
This method returns a ViewUserPackageAttributeContract object which have the following properties:
ID (Integer) - The unique ID for the contract
UserPackageID (Integer) - The ID referencing the user package that has the contract
Penalty (Double) - The penalty to be charged for breaking the contract
ChargeRemainder (Boolean) - The ID of the package associated with this user package
StartDate (DateTime) - The date the contract began
EndDate (DateTime) - The date the contract expires
Name (String) - The attribute name, in this case "Contract"
UserPackage (String) - The name of the user package
BaseTimeUnitTypeID (Integer) - The ID referencing the base time unit for the contract length
Term (Integer) - Numeric portion of the contract length, for example 3 months
BaseTimeUnitType (String) - The time measurement unit of the contract length, for example every 3 months
TransactionPenaltyService (String) - The name of the service to be used for billing contract breaking fees
TransactionPenaltyServiceID (Integer) - The ID referencing the service to used for billing contract breaking fees
Parameters:
userPackageID (Integer) - The ID of the user package. Will return an exception if not found
Returns:
A ViewUserPackageAttributeContract object
Possible Exceptions:
INVALID USERPACKAGE ID
SOAP 1.2
The following is a sample SOAP 1.2 request and response. The placeholders shown need to be replaced with actual values.
Code Block |
---|
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>
<GetUserPackageContract xmlns="Logisense_EngageIP">
<userPackageID>int</userPackageID>
</GetUserPackageContract>
</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>
<GetUserPackageContractResponse xmlns="Logisense_EngageIP">
<GetUserPackageContractResult>
<ID>int</ID>
<UserPackageID>int</UserPackageID>
<Penalty>double</Penalty>
<ChargeRemainder>boolean</ChargeRemainder>
<StartDate>dateTime</StartDate>
<EndDate>dateTime</EndDate>
<Name>string</Name>
<UserPackage>string</UserPackage>
<BaseTimeUnitTypeID>int</BaseTimeUnitTypeID>
<Term>int</Term>
<BaseTimeUnitType>string</BaseTimeUnitType>
<TransactionPenaltyService>string</TransactionPenaltyService>
<TransactionPenaltyServiceID>int</TransactionPenaltyServiceID>
<InitialTermStartDate>dateTime</InitialTermStartDate>
</GetUserPackageContractResult>
</GetUserPackageContractResponse>
</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.
Code Block |
---|
POST /AdminPortal/webservice.asmx HTTP/1.1
Host: localhost
Content-Type: text/xml; charset=utf-8
Content-Length: length
SOAPAction: "Logisense_EngageIP/GetUserPackageContract"
<?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>
<GetUserPackageContract xmlns="Logisense_EngageIP">
<userPackageID>int</userPackageID>
</GetUserPackageContract>
</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>
<GetUserPackageContractResponse xmlns="Logisense_EngageIP">
<GetUserPackageContractResult>
<ID>int</ID>
<UserPackageID>int</UserPackageID>
<Penalty>double</Penalty>
<ChargeRemainder>boolean</ChargeRemainder>
<StartDate>dateTime</StartDate>
<EndDate>dateTime</EndDate>
<Name>string</Name>
<UserPackage>string</UserPackage>
<BaseTimeUnitTypeID>int</BaseTimeUnitTypeID>
<Term>int</Term>
<BaseTimeUnitType>string</BaseTimeUnitType>
<TransactionPenaltyService>string</TransactionPenaltyService>
<TransactionPenaltyServiceID>int</TransactionPenaltyServiceID>
<InitialTermStartDate>dateTime</InitialTermStartDate>
</GetUserPackageContractResult>
</GetUserPackageContractResponse>
</soap:Body>
</soap:Envelope> |