The ContractService has only one API call associated to this service:
This service call provides all the various contract information (contract details, coverage, and site address info).
The input data (customer ID, inventory ID, and device ID) were obtained from the data returned in the first two Inventory API service calls (for more information see the "Manual Process Overview for API Service Calls" section).
It is recommended to use deviceIds as a parameter for request.
| Parameter | Required | Type | Description |
|---|---|---|---|
| customerID | Yes | string | This parameter is returned in the API service call getCustomersInventoryIds. customerId is the ID of the Entitlement Company. |
| inventoryId | Yes | string | This parameter was returned in the API service call getCustomersInventoryIds. inventoryId identifies the inventory whose data will be accessed for the chassis & card level details. |
| deviceIds | Optional | string | The deviceIds input can be zero or more. When not providing the deviceIds, the api will return a full collection of data for that given InventoryID, for that given CustomerId, of that given PartyGUID; all the devices collected for that inventory will be returned. |
| Parameter | Type | Length | Description |
|---|---|---|---|
| deviceId | string | 22 | Id of the device that we have the contract info for. |
| serialNumber | string | 50 | Serial number of the device. |
| productId | string | 255 | Product id (PID) of the device. |
CoverageDetails [ ] |
|||
| contractNumber | string | 120 | Contract number associated to the selected device. |
| coverageStatus | string | 30 | Status of the current coverage. |
| slaType | string | 240 | Indicates the type of service level agreement (SLA) that is noted in the contract. |
| serviceLevel | string | 40 | Indicates what service level is active. |
| coverageStartDate | date | DATE | Indicates when the contract coverage started. |
| coverageEndDate | date | DATE | Indicates when the contract coverage will end. |
| shipDate | date | DATE | Ship date of the device. |
| eosDate | date | DATE | End of sale date for the device. |
| serviceableFlag | string | 3 | This parameter indicates whether or not a PID or serial number is serviceable, or is covered under a parent contract. |
| shipToSiteID | string | 40 | Customer site id to where the device was shipped. |
| installAtSiteID | string | 40 | Id of the install site, where the device was installed. |
ContractDetail [ ] |
|||
| contractNumber | string | 120 | Device's contract number |
| serviceLevel | string | 40 | Identifies what level of service the contract has. |
| slaType | string | 240 | Indicates the type of service level agreement (SLA) that is noted in the contract. |
| contractStartDate | date | DATE | States the start date of the contract. |
| contractEndDate | date | DATE | States the end date of the contract. |
| ContactNameOfVendor | string | 30 | Contact name of the vendor. |
| BillToSiteID | string | 40 | Id used when billing the site for the device. |
SiteIdAddress [ ] |
|||
| siteID | string | 40 | Site id where the device resides. |
| siteName | string | 360 | Name of the site where the device resides. |
| addressLine1 | string | 240 | First address line of the site. |
| addressLine2 | string | 240 | Second address line of the site. |
| addressLine3 | string | 240 | Third address line of the site. |
| addressLine4 | string | 240 | Fourth address line of the site. |
| city | string | 60 | City where the site is located. |
| postalCode | string | 60 | Postal code where the site is located. |
| state | string | 60 | State where the site is located. |
| province | string | 60 | Province where the site is located. |
| country | string | 60 | Country where the site is located. |
responseTimestamp
| Parameter | Type | Length | Description |
|---|---|---|---|
| date | DATE | The time stamp indicates when this service call was performed. |
message[ ]
| Parameter | Type | Length | Description |
|---|---|---|---|
| See Message Format section for more details about the message[ ] parameter. | |||
| messageType | string | 255 | |
| messageDetail | string | 255 |
POST https://api.cisco.com/pss/v1.0/ContractService HTTP/1.1
Accept-Encoding: gzip,deflate
Content-Type: text/xml;charset=UTF-8
SOAPAction: "getContractCoverageDetails"
Authorization: Bearer yh4xkpx7cbgy6wqynre4wf4r
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/" xmlns:con="http://www.cisco.com/ContractService"›
‹soapenv:Header/›
‹soapenv:Body›
‹con:ContractCoverageRequest›
‹con:customerId›109757‹/con:customerId›
‹con:inventoryId›15224‹/con:inventoryId›
‹!--Zero or more repetitions:--›
‹con:deviceIds›‹/con:deviceIds›
‹/con:ContractCoverageRequest›
‹/soapenv:Body›
‹/soapenv:Envelope›
HTTP/1.1 200 OK
Date: Wed, 03 Apr 2013 15:35:10 GMT
Server: IBM_HTTP_Server
X-Mashery-Responder: APIX-PROD-01
Cache-Control: private
Pragma: private
Content-Type: text/xml; charset=UTF-8
Content-Language: en-US
Cache-Control: max-age=0
Expires: Wed, 03 Apr 2013 15:35:10 GMT
Set-Cookie: TOOLS-Loc=tools1.cisco.com; path=/; domain=.cisco.com
Set-Cookie: ObSSOCookie=J7l5hji1O0X7RkLI7K2M0V6aCaQb93n4Nf56NK8IAIM3b%2F%2BzZGAD5UhziM07UgA%2FzNwsrOCGwrNNn0UfbsVLi%2FSE16NkSfIJQFXfgRh5m05Jhpc1lplankbSNzaQMlosLOYS19jSHObhizGv0%2B5os4MDSlJ0srVIHGpJ6%2F7g6K0sNfPx75LTQxWRr%2BkyskfspRHhV3AF4HeB0fSkekBg0oa0REjfCxz24qoLyG%2F7SeQInvbh8f1voVHtsTjoKqPVPKdIaEHW2shppWMKS4Kmb4WOiZ0EjxQmny8epTsxSDDstF10oAi83f171RfywiaiRcfHzp3DZWAVasW4eBJ6qwXmnzJHpsEecjE3TePz1CTEr3dLLL%2Fk6L2EwasyOykd; path=/; domain=.cisco.com;
Connection: close
Transfer-Encoding: chunked
‹soapenv:Envelope xmlns:soapenv="http://schemas.xmlsoap.org/soap/envelope/"›
‹soapenv:Body›
‹con:ContractCoverageResponse xmlns:con="http://www.cisco.com/ContractService"
xmlns:fn="http://www.cisco.com/FNAlertService"
xmlns:hweox="http://www.cisco.com/HwEoxAlertService"
xmlns:inv="http://www.cisco.com/InventoryService"
xmlns:sweox="http://www.cisco.com/SwEoxAlertService"
xmlns:w3c="http://www.w3.org/2001/XMLSchema-instance"
xmlns:is="http://www.cisco.com/ISAlertService"
xmlns:psirt="http://www.cisco.com/PSIRTAlertService"›
‹con:deviceCoverageDetail›
‹con:deviceId›3740230‹/con:deviceId›
‹con:serialNumber›FCH15109LWV‹/con:serialNumber›
‹con:productId›CP-9951-CL-CAM-K9=‹/con:productId›
‹con:coverageDetails›
‹con:contractNumber›91488861‹/con:contractNumber›
‹con:serviceLevel›PU2P‹/con:serviceLevel›
‹con:coverageStatus›ACTIVE‹/con:coverageStatus›
‹con:coverageStartDate›2011-03-31T00:00:00.000‹/con:coverageStartDate›
‹con:coverageEndDate›2014-04-01T00:00:00.000‹/con:coverageEndDate›
‹con:shipDate›2011-03-22T00:00:00.000‹/con:shipDate›
‹con:serviceableFlag›YES‹/con:serviceableFlag›
‹con:shipToSiteID›400950019‹/con:shipToSiteID›
‹con:installAtSiteID›21261705‹/con:installAtSiteID›
‹/con:coverageDetails›
‹/con:deviceCoverageDetail›
‹con:deviceCoverageDetail›
‹con:deviceId›3740231‹/con:deviceId›
‹con:serialNumber›FCH15098FLQ‹/con:serialNumber›
‹con:productId›CP-9971-CL-CAM-K9=‹/con:productId›
‹con:coverageDetails›
‹con:contractNumber›91488861‹/con:contractNumber›
‹con:serviceLevel›PU2P‹/con:serviceLevel›
‹con:coverageStatus›ACTIVE‹/con:coverageStatus›
‹con:coverageStartDate›2011-03-31T00:00:00.000‹/con:coverageStartDate›
‹con:coverageEndDate›2014-04-01T00:00:00.000‹/con:coverageEndDate›
‹con:shipDate›2011-03-24T00:00:00.000‹/con:shipDate›
‹con:serviceableFlag›YES‹/con:serviceableFlag›
‹con:shipToSiteID›400950019‹/con:shipToSiteID›
‹con:installAtSiteID›21261705‹/con:installAtSiteID›
‹/con:coverageDetails›
‹/con:deviceCoverageDetail›
...
‹con:responseTimestamp›2013-04-03T08:35:10.671-07:00‹/con:responseTimestamp›
‹con:message›
‹con:messageType›SUCCESS‹/con:messageType›
‹con:messageDetail›Request processed successfully‹/con:messageDetail›
‹/con:message›
‹/con:ContractCoverageResponse›
‹/soapenv:Body›
‹/soapenv:Envelope›
©2016 Cisco Systems, Inc. · All Rights Reserved · This site is Cisco Confidential. For Cisco Field and Channel Partner use only. Not for public distribution.