Contracts and Coverage

The Contracts API provides details about the contracts associated to the devices in a customer’s inventory. The Coverage API provides a list of all devices that are covered under the selected Cisco Contract number. If a device is not covered by a partner invoking the API, then information like contract number and other related API attributes are marked “confidential”.

Features

The Contracts API provides the following features:

• Supports RESTful interface, using a RAML definition file.
• Supports JSON data format
• Includes web services that return:
  • Contracts owned by customers or partners
  • Devices that are covered by a Cisco Service contract belonging to the customer or partner.
  • Devices in the inventory that are not covered by Cisco Service contract.

  Contract Details

  The contract details API returns details about specific contracts owned by customers or partners for devices in the customer’s inventory. This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see General API Feature section for examples and features that allow you to optimize and manipulate the response.

  URL

  Request Parameters

  Parameter	Type	Max Length	Required	Description
  customerId	NUMBER	12	Required	Unique identifier of a Cisco customer.
  inventoryName	STRING	25	Optional	Name of the inventory.
  contractStatus	STRING	128	Optional	[Masking Applicable] Status of the contract. For example, unmasked value can be Active, Signed, QA Hold, Overdue, Terminated, Service, Entered, Expired & Inactive and masked value will be Confidential. For more details, refer Masking Details section.
  contractStartDate	DATE	Optional	[Masking Applicable] Provides the service contract details from start date to current date. GMT date format: YYYY-MM-DD. For example, unmasked value can be YYYY-MM-DD and masked value will be Confidential. For more details, refer Masking Details section.
  contractEndDate	DATE	Optional	[Masking Applicable] Lists the details of service contract from commencing to end date. GMT date format: YYYY-MM-DD. For example, unmasked value can be YYYY-MM-DD and masked value will be Confidential. For more details, refer Masking Details section.
  contractNumber	NUMBER	512	Optional	Contract identifier of the service contract. For example, 2689444, 91488861, 92246411.
  serviceLevel	STRING	128	Optional	[Masking Applicable] Alphanumeric code that denotes the purchased support service. For example, unmasked value can be NSOP, PSSE, NC2P and masked value will be Confidential. For more details, refer Masking Details section.
  page	NUMBER	Optional	Page number of the response.
  rows	NUMBER	Optional	Number of rows of data per page.
  snapshot	STRING	Optional	Option is "LATEST" and value is case insensitive. Report includes contract details of latest inventory upload only.
  sort	STRING	Optional	Supported sort criteria are either ‘asc’ for ascending or ‘desc’ for descending.
  fields	STRING	Optional	Requested fields in the response.

  Response Parameters

  Parameter	Type	Max Length	Description
  customerId	NUMBER	12	Unique identifier of a Cisco customer.
  contractNumber	NUMBER	512	Contract identifier of the service contract. For example, 2689444, 91488861, 92246411.
  contractStatus	STRING	128	[Masking Applicable] Status of the contract. For example, unmasked value can be Active, Signed, QA Hold, Overdue, Terminated, Service, Entered, Expired & Inactive and masked value will be Confidential. For more details, refer Masking Details section.
  contractStartDate	DATE	[Masking Applicable] Provides the service contract details from start date to current date. GMT date format: YYYY-MM-DD. For example, unmasked value can be YYYY-MM-DD and masked value will be Confidential. For more details, refer Masking Details section.
  contractEndDate	DATE	[Masking Applicable] Lists the details of service contract from commencing to end date. GMT date format: YYYY-MM-DD. For example, unmasked value can be YYYY-MM-DD and masked value will be Confidential. For more details, refer Masking Details section.
  serviceProgram	STRING	512	[Masking Applicable] A program designed to support Cisco customers or partners. For example, unmasked value can be SNTC and masked value will be Confidential. For more details, refer Masking Details section.
  serviceLevel	STRING	128	[Masking Applicable] Alphanumeric code that denotes the purchased support service. For example, unmasked value can be NSOP, PSSE, NC2P and masked value will be Confidential. For more details, refer Masking Details section.
  billtoSiteId	NUMBER	128	[Masking Applicable] Unique identifier of a site where the contract was billed to. For example, unmasked value can be 30411234 and masked value will be Confidential. For more details, refer Masking Details section.
  billtoSiteName	STRING	512	[Masking Applicable] Name of a site where the contract was billed to. For example, unmasked value can be BRITISH TELECOMMUNICATIONS PLC (IBUY) and masked value will be Confidential. For more details, refer Masking Details section.
  billtoAddressLine1	STRING	512	[Masking Applicable] First address line of the bill-to site. For example, unmasked value can be PO BOX 817 and masked value will be Confidential. For more details, refer Masking Details section.
  billtoAddressLine2	STRING	512	[Masking Applicable] Second address line of the bill-to site. For example, unmasked value can be 1ST FLOOR BRUNDRETT PLACE and masked value will be Confidential. For more details, refer Masking Details section.
  billtoAddressLine3	STRING	512	[Masking Applicable] Third address line of the bill-to site. For example, unmasked value can be 1 BRUNDRETT STREET and masked value will be Confidential. For more details, refer Masking Details section.
  billtoAddressLine4	STRING	512	[Masking Applicable] Fourth address line of the bill-to site. For example, unmasked value can be 31 BRUNDRETT4 STREET or blank and masked value will be Confidential. For more details, refer Masking Details section.
  billtoCity	STRING	128	[Masking Applicable] City name of the bill-to site. For example, unmasked value can be STOCKPORT and masked value will be Confidential. For more details, refer Masking Details section.
  billtoState	STRING	128	[Masking Applicable] State name of the bill-to site. For example, unmasked value can be CA and masked value will be Confidential. For more details, refer Masking Details section.
  billtoPostalCode	STRING	128	[Masking Applicable] Postal code of the bill-to site. For example, unmasked value can be 96001 and masked value will be Confidential. For more details, refer Masking Details section.
  billtoProvince	STRING	128	[Masking Applicable] Province name of the bill-to site. For example, unmasked value can be CA and masked value will be Confidential. For more details, refer Masking Details section.
  billtoCountry	STRING	128	[Masking Applicable] Country name of the bill-to site. For example, unmasked value can be US and masked value will be Confidential. For more details, refer Masking Details section.
  billtoGuName	STRING	250	Name of a company where the contract was billed to.
  siteUseName	STRING	512	Contract Site Usename.
  siteUseId	STRING	128	Contract Site UseID.
  siteAddress1	STRING	512	Address field for the contract install site.
  siteCity	STRING	128	City field for the contract install site.
  siteStateProvince	STRING	128	State or Province field for the contract install site.
  sitePostalCode	STRING	128	Postal Code field for the contract install site.
  siteCountry	STRING	128	Country field for the contract install site.
  baseProductId	STRING	128	Base or manufacturing product identifiers related to the specified serial number.

  Sample Request

  Sample JSON Response

   < "data": [ < "customerId": 1234, "contractNumber": 94966374, "contractStatus": "ACTIVE", "contractStartDate": "2012-02-01T00:00:00", "contractEndDate": "2018-06-22T00:00:00", "serviceProgram": "SNTC", "serviceLevel": "PSUP", "billtoSiteId": "1669196", "billtoSiteName": "CISCO SYSTEMS INC CREDIT CARD", "billtoAddressLine1": "1657 RIVERSIDE DRIVE", "billtoAddressLine2": null, "billtoAddressLine3": null, "billtoAddressLine4": null, "billtoCity": "REDDING", "billtoState": "CA", "billtoPostalCode": "96001", "billtoProvince": "CA", "billtoCountry": "US", "billtoGuName": "CISCO SYSTEMS INC", "siteUseName": "CISCO SYSTEMS INC", "siteUseId": "5657767", "siteAddress1": "170 WEST TASMAN DR.", "siteCity": "SAN JOSE.", "siteStateProvince": "CA", "sitePostalCode": "23857", "siteCountry": "US", "baseProductId": "UBR12101" >], "pagination": < "page": 1, "pages": 4, "rows": 1, "total": 4 >> 

  Contracts Coverage

  The coverage API returns information for devices that are covered by a Cisco Services contract belonging to the customer or partner. The API returns all devices that are in the inventory, however hides specific coverage related information of devices that are not resold by partners or on contracts owned by customers making the request to retrieve coverage information.

  This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section for examples and features that allow you to optimize and manipulate the response.

  URL

  Request Parameters

  Parameter	Type	Max Length	Required	Description
  customerId	NUMBER	12	Required	Unique identifier of a Cisco customer.
  inventoryName	STRING	25	Optional	Name of the inventory.
  serialNumber	STRING	512	Optional	A serial number is a unique number used for identification. For example: FTX1512AHK2, FDO1541Z067, SAD07370169.
  productId	STRING	128	Optional	The alphanumeric unique identifier of a Cisco Product. The id is used by customers to order Cisco products. For example: CISCO2921/K9, WS-C3750X-24S-S, WS-X6748-GE-TX.
  coverageStatus	STRING	128	Optional	The contract coverage status of a piece of hardware. For example, Active, Signed, QA Hold, Overdue.
  coverageStartDate	DATE	Optional	[Masking Applicable] Start date of the coverage. GMT date format: YYYY-MM-DD. For example, unmasked value can be YYYY-MM-DD and masked value will be Confidential. For more details, refer Masking Details section.
  coverageEndDate	DATE	Optional	[Masking Applicable] End date of the coverage. GMT date format: YYYY-MM-DD. For example, unmasked value can be YYYY-MM-DD and masked value will be Confidential. For more details, refer Masking Details section.
  contractStatus	STRING	128	Optional	[Masking Applicable] Status of the contract. For example, unmasked value can be Active, Signed, QA Hold, Overdue, Terminated, Service, Entered, Expired & Inactive and masked value will be Confidential. For more details, refer Masking Details section.
  contractNumber	NUMBER	512	Optional	Contract identifier of the service contract. For example, 2689444, 91488861, 92246411.
  serviceLevel	STRING	128	Optional	[Masking Applicable] Alphanumeric code that denotes the purchased support service. For example, unmasked value can be NSOP, PSSE, NC2P and masked value will be Confidential. For more details, refer Masking Details section.
  serviceLineStatus	STRING	128	Optional	Status of the service line. For example: Active, Signed, QA Hold, Overdue.
  billtoPartyId	NUMBER	Optional	[Masking Applicable] Unique identifier of an Entitled Party where the contract was billed to. For example, unmasked value can be 30411234 and masked value will be Confidential. For more details, refer Masking Details section.
  page	NUMBER	Optional	Page number of the response.
  rows	NUMBER	Optional	Number of rows of data per page.
  snapshot	STRING	Optional	Option is "LATEST" and value is case insensitive. Report includes coverage details of latest inventory upload only.
  sort	STRING	Optional	Supported sort criteria are either ‘asc’ for ascending or ‘desc’ for descending.
  fields	STRING	Optional	Requested fields in the response.

  Response Parameters

  Parameter	Type	Max Length	Description
  customerId	NUMBER	12	Unique identifier of a Cisco customer.
  serialNumber	STRING	512	A serial number is a unique number used for identification. For example: FTX1512AHK2, FDO1541Z067, SAD07370169.
  productId	STRING	128	The alphanumeric unique identifier of a Cisco Product. The id is used by customers to order Cisco products. For example: CISCO2921/K9, WS-C3750X-24S-S, WS-X6748-GE-TX.
  productFamily	STRING	512	Grouping of similar Cisco Products. For example, Cisco 2900 Series Integrated Services Routers, Cisco Catalyst 3750 Series Switches.
  coverageStatus	STRING	128	The contract coverage status of a piece of hardware. For example, Active, Signed, QA Hold, Overdue.
  contractInstanceNumber	STRING	128	Unique identifier for a contract.
  parentContractInstanceId	STRING	Instance ID within a network configuration of the parent item, under which a child item resides.
  orderShipDate	DATE	Date when the product was initially shipped. GMT date format YYYY-MM-DD"T"HH24:MI:SS (Time is displayed in 24 hour format).
  serviceable	NUMBER	Indicates whether the item (PID or serial number) is serviceable/is covered under a parent contract or not.
  coverageStartDate	DATE	[Masking Applicable] Start date of the coverage. GMT date format: YYYY-MM-DD. For example, unmasked value can be YYYY-MM-DD and masked value will be Confidential. For more details, refer Masking Details section.
  coverageEndDate	DATE	[Masking Applicable] End date of the coverage. GMT date format: YYYY-MM-DD. For example, unmasked value can be YYYY-MM-DD and masked value will be Confidential. For more details, refer Masking Details section.
  warrantyStartDate	DATE	Start date of the device warranty. GMT date format: YYYY-MM-DD.
  warrantyEndDate	DATE	The date warranty expires on a piece of purchased hardware. GMT date format YYYY-MM-DD.
  warrantyType	STRING	512	Type of the device warranty.
  contractNumber	STRING	512	Contract identifier of the service contract. For example, 2689444, 91488861, 92246411.
  serviceLevel	STRING	128	[Masking Applicable] Alphanumeric code that denotes the purchased support service. For example, unmasked value can be NSOP, PSSE, NC2P and masked value will be Confidential. For more details, refer Masking Details section.
  slaType	STRING	128	Indicates the type of service level agreement (SLA) that is noted in the contract. For example, WARR-90-DAY-LTD-HW, WARR-LTD-LIFE-HW.
  serviceProgram	STRING	512	[Masking Applicable] A program designed to support Cisco customers or partners. For example, unmasked value can be SNTC and masked value will be Confidential. For more details, refer Masking Details section.
  contractStartDate	DATE	[Masking Applicable] Provides the service contract details from start date to current date. GMT date format: YYYY-MMDD. For example, unmasked value can be YYYY-MM-DD and masked value will be Confidential. For more details, refer Masking Details section.
  contractEndDate	DATE	[Masking Applicable] Lists the details of service contract from commencing to end date. GMT date format: YYYY-MM-DD. For example, unmasked value can be YYYY-MM-DD and masked value will be Confidential. For more details, refer Masking Details section.
  contractStatus	STRING	128	[Masking Applicable] Status of the contract. For example, unmasked value can be Active, Signed, QA Hold, Overdue, Terminated, Service, Entered, Expired & Inactive and masked value will be Confidential. For more details, refer Masking Details section.
  shiptoSiteId	STRING	128	[Masking Applicable] Unique identifier of a site where the product was shipped to. For example, unmasked value can be 400950019 and masked value will be Confidential. For more details, refer Masking Details section.
  shiptoSiteName	STRING	512	[Masking Applicable] Name of a site where the product was shipped to. For example, unmasked value can be CA-SJ-I and masked value will be Confidential. For more details, refer Masking Details section.
  shiptoAddressLine1	STRING	512	[Masking Applicable] First address line of the ship-to site. For example, unmasked value can be 285 WEST TASMAN DRIVE and masked value will be Confidential. For more details, refer Masking Details section.
  shiptoAddressLine2	STRING	512	[Masking Applicable] Second address line of the ship-to site. For example, unmasked value can be CA-SJ-J and masked value will be Confidential. For more details, refer Masking Details section.
  shiptoAddressLine3	STRING	512	[Masking Applicable] Third address line of the ship-to site. For example, unmasked value can be CA-SJ-J or blank and masked value will be Confidential. For more details, refer Masking Details section.
  shiptoAddressLine4	STRING	512	[Masking Applicable] Fourth address line of the ship-to site. For example, unmasked value can be CA-SJ-J and masked value will be Confidential. For more details, refer Masking Details section.
  shiptoCity	STRING	128	[Masking Applicable] City name of the ship-to site. For example, unmasked value can be SAN JOSE and masked value will be Confidential. For more details, refer Masking Details section.
  shiptoState	STRING	128	[Masking Applicable] State name of the ship-to site. For example, unmasked value can be CA and masked value will be Confidential. For more details, refer Masking Details section.
  shiptoPostalCode	STRING	128	[Masking Applicable] Postal code of the ship-to site. For example, unmasked value can be 95134-1706 and masked value will be Confidential. For more details, refer Masking Details section.
  shiptoProvince	STRING	128	[Masking Applicable] Province name of the ship-to site. For example, unmasked value can be SAN JOSE or blank and masked value will be Confidential. For more details, refer Masking Details section.
  shiptoCountry	STRING	128	[Masking Applicable] Country name of the ship-to site. For example, unmasked value can be US or blank and masked value will be Confidential. For more details, refer Masking Details section.
  installedatSiteId	STRING	128	[Masking Applicable] Unique identifier of a site where the product was installed. For example, unmasked value can be 30411234 and masked value will be Confidential. For more details, refer Masking Details section.
  installedatSiteName	STRING	512	[Masking Applicable] Name of a site where the product was installed. For example, unmasked value can be ABC CORPORATION and masked value will be Confidential. For more details, refer Masking Details section.
  installedatAddressLine1	STRING	512	[Masking Applicable] First address line of the installed-at site. For example, unmasked value can be 2116 SOUTH 17TH STREET and masked value will be Confidential. For more details, refer Masking Details section.
  installedatAddressLine2	STRING	512	[Masking Applicable] Second address line of the installed-at site. For example, unmasked value can be BEDFONT LAKES and masked value will be Confidential. For more details, refer Masking Details section.
  installedatAddressLine3	STRING	512	[Masking Applicable] Third address line of the installed-at site. For example, unmasked value can be FELTHAM MIDDLESEX and masked value will be Confidential. For more details, refer Masking Details section.
  installedatAddressLine4	STRING	512	[Masking Applicable] Fourth address line of the installed-at site. For example, unmasked value can be XYZ or blank and masked value will be Confidential. For more details, refer Masking Details section.
  installedatCity	STRING	128	[Masking Applicable] City name of the installed-at site. For example, unmasked value can be FELTHAM and masked value will be Confidential. For more details, refer Masking Details section.
  installedatState	STRING	128	[Masking Applicable] State name of the installed-at site. For example, unmasked value can be CA and masked value will be Confidential. For more details, refer Masking Details section.
  installedatPostalCode	STRING	128	[Masking Applicable] Postal code of the installed-at site. For example, unmasked value can be TW14 8HA and masked value will be Confidential. For more details, refer Masking Details section.
  installedatProvince	STRING	128	[Masking Applicable] Province name of the installed-at site. For example, unmasked value can be D.C and masked value will be Confidential. For more details, refer Masking Details section.
  installedatCountry	STRING	128	[Masking Applicable] Country name of the installed-at site. For example, unmasked value can be GB and masked value will be Confidential. For more details, refer Masking Details section.
  billtoSiteId	STRING	128	[Masking Applicable] Unique identifier of a site where the contract was billed to. For example, unmasked value can be 30411234 and masked value will be Confidential. For more details, refer Masking Details section.
  billtoSiteName	STRING	512	[Masking Applicable] Name of a site where the contract was billed to. For example, unmasked value can be BRITISH TELECOMMUNICATIONS PLC (IBUY) and masked value will be Confidential. For more details, refer Masking Details section.
  billtoAddressLine1	STRING	512	[Masking Applicable] First address line of the bill-to site. For example, unmasked value can be PO BOX 817 and masked value will be Confidential. For more details, refer Masking Details section.
  billtoAddressLine2	STRING	512	[Masking Applicable] Second address line of the bill-to site. For example, unmasked value can be 1ST FLOOR BRUNDRETT PLACE and masked value will be Confidential. For more details, refer Masking Details section.
  billtoAddressLine3	STRING	512	[Masking Applicable] Third address line of the bill-to site. For example, unmasked value can be 1 BRUNDRETT STREET and masked value will be Confidential. For more details, refer Masking Details section.
  billtoAddressLine4	STRING	512	[Masking Applicable] Fourth address line of the bill-to site. For example, unmasked value can be 31 BRUNDRETT4 STREET or blank and masked value will be Confidential. For more details, refer Masking Details section.
  billtoCity	STRING	128	[Masking Applicable] City name of the bill-to site. For example, unmasked value can be STOCKPORT and masked value will be Confidential. For more details, refer Masking Details section.
  billtoState	STRING	128	[Masking Applicable] State name of the bill-to site. For example, unmasked value can be CA and masked value will be Confidential. For more details, refer Masking Details section.
  billtoPostalCode	STRING	128	[Masking Applicable] Postal code of the bill-to site. For example, unmasked value can be 96001 and masked value will be Confidential. For more details, refer Masking Details section.
  billtoProvince	STRING	128	[Masking Applicable] Province name of the bill-to site. For example, unmasked value can be CA and masked value will be Confidential. For more details, refer Masking Details section.
  billtoCountry	STRING	128	[Masking Applicable] Country name of the bill-to site. For example, unmasked value can be US and masked value will be Confidential. For more details, refer Masking Details section.
  neInstanceId	NUMBER	19	Unique id used to identify an instance of a network element. Network element is a manageable logical entity uniting one or more physical devices. This allows distributed devices to be managed in a unified way using one management system.
  billtoPartyId	NUMBER	[Masking Applicable] Unique identifier of an Entitled Party where the contract was billed to. For example, unmasked value can be 30411234 and masked value will be Confidential. For more details, refer Masking Details section.
  installAtGuPartyId	STRING	128	Unique identifier of a company where the product was installed.
  contractInstanceId	NUMBER	Internally generated ID for unique entry of instance detail table. Unique association between PID and SN.
  serviceLineId	STRING	Service Line ID.
  serviceLineStatus	STRING	128	Service Line Status.
  lineCustomerName	STRING	512	Line Customer Name.
  businessProcessName	STRING	Business Process Names.
  entitledParty	STRING	Entitled Party.
  installGUName	STRING	128	Install GU Name.

  Sample Request

  Sample JSON Response

   < "data": [ < "customerId": 1234, "serialNumber": "FDO1536Y1FS", "productId": "WS-C3750G-24T-S", "productFamily": "C3750", "coverageStatus": "ACTIVE", "contractInstanceNumber": "858932761", "parentContractInstanceId": null, "orderShipDate": "2011-10-28T00:00:00", "serviceable": 1, "coverageStartDate": "Confidential", "coverageEndDate": "Confidential", "warrantyStartDate": "2011-10-28T00:00:00", "warrantyEndDate": "2018-01-31T00:00:00", "warrantyType": "WARR-LTD-LIFE-HW", "contractNumber": "OTHERS", "serviceLevel": "Confidential", "slaType": "PSUP", "serviceProgram": "Confidential", "contractStartDate": "Confidential", "contractEndDate": "Confidential", "contractStatus": "Confidential", "shiptoSiteId": "Confidential", "shiptoSiteName": "Confidential", "shiptoAddressLine1": "Confidential", "shiptoAddressLine2": "Confidential", "shiptoAddressLine3": "Confidential", "shiptoAddressLine4": "Confidential", "shiptoCity": "Confidential", "shiptoState": "Confidential", "shiptoPostalCode": "Confidential", "shiptoProvince": "Confidential", "shiptoCountry": "Confidential", "installedatSiteId": "Confidential", "installedatSiteName": "Confidential", "installedatAddressLine1": "Confidential", "installedatAddressLine2": "Confidential", "installedatAddressLine3": "Confidential", "installedatAddressLine4": "Confidential", "installedatCity": "Confidential", "installedatState": "Confidential", "installedatPostalCode": "Confidential", "installedatProvince": "Confidential", "installedatCountry": "Confidential", "billtoSiteId": "Confidential", "billtoSiteName": "Confidential", "billtoAddressLine1": "Confidential", "billtoAddressLine2": "Confidential", "billtoAddressLine3": "Confidential", "billtoAddressLine4": "Confidential", "billtoCity": "Confidential", "billtoState": "Confidential", "billtoPostalCode": "Confidential", "billtoProvince": "Confidential", "billtoCountry": "Confidential", "networkElementId": 265924591, "billtoPartyId": "Confidential", "installAtGuPartyId": 5769294, "contractInstanceId": 858932761, "serviceLineId": "57501894550", "serviceLineStatus": "ACTIVE", "lineCustomerName": "CWPS1", "businessProcessName": "Software Center Access", "entitledParty": "Install-at", "installGUName": "INSIGHT ENTERPRISES INC" >], "pagination": < "page": 1, "pages": 4, "rows": 1, "total": 4 >> 

  Devices Not Covered

  This API returns information for all devices in the inventory that are not covered by Cisco Service contract.

  This API supports filtering, pagination, sorting and chunked transfer encoding. For more information, see the General API Feature section for examples and features that allow you to optimize and manipulate the response.

  URL

  Request Parameters

  Parameter	Type	Max Length	Required	Description
  customerId	NUMBER	12	Required	Unique identifier of a Cisco customer.
  inventoryName	STRING	25	Optional	Name of the inventory.
  serialNumber	STRING	512	Optional	A serial number is a unique number used for identification. For example: FTX1512AHK2, FDO1541Z067, SAD07370169.
  productId	STRING	128	Optional	The alphanumeric unique identifier of a Cisco Product. The id is used by customers to order Cisco products. For example: CISCO2921/K9, WS-C3750X-24S-S, WS-X6748-GE-TX.
  contractInstanceNumber	NUMBER	128	Optional	Unique identifier for a contract.
  page	NUMBER	Optional	Page number of the response.
  rows	NUMBER	Optional	Number of rows of data per page.
  snapshot	STRING	Optional	Option is "LATEST" and value is case insensitive. Report includes inventory not covered by any contract from latest upload only.
  sort	STRING	Optional	Supported sort criteria are either ‘asc’ for ascending or ‘desc’ for descending.
  fields	STRING	Optional	Requested fields in the response.

  Response Parameters

  Parameter	Type	Max Length	Description
  customerId	NUMBER	12	Unique identifier of a Cisco customer.
  contractInstanceNumber	NUMBER	128	Unique identifier for a contract.
  serialNumber	STRING	512	A serial number is a unique number used for identification. For example: FTX1512AHK2, FDO1541Z067, SAD07370169.
  productId	STRING	512	The alphanumeric unique identifier of a Cisco Product. The id is used by customers to order Cisco products. For example: CISCO2921/K9, WS-C3750X-24S-S, WS-X6748-GE-TX.
  hwType	STRING	512	Physical type of the hardware such as Chassis, Module, Fan, Power Supply, and Other.
  orderShipDate	DATE	Date when the product was initially shipped. GMT date format YYYY-MM-DD.
  installedatSiteId	NUMBER	[Masking Applicable] Unique identifier of a site where the product was installed. For example, unmasked value can be 30411234 and masked value will be Confidential. For more details, refer Masking Details section.
  installedatSiteName	STRING	512	[Masking Applicable] Name of a site where the product was installed. For example, unmasked value can be ABC CORPORATION and masked value will be Confidential. For more details, refer Masking Details section.
  installedatAddressLine1	STRING	512	[Masking Applicable] First address line of the installed-at site. For example, unmasked value can be 2116 SOUTH 17TH STREET and masked value will be Confidential. For more details, refer Masking Details section.
  installedatAddressLine2	STRING	512	[Masking Applicable] Second address line of the installed-at site. For example, unmasked value can be BEDFONT LAKES and masked value will be Confidential. For more details, refer Masking Details section.
  installedatAddressLine3	STRING	512	[Masking Applicable] Third address line of the installed-at site. For example, unmasked value can be FELTHAM MIDDLESEX and masked value will be Confidential. For more details, refer Masking Details section.
  installedatAddressLine4	STRING	512	[Masking Applicable] Fourth address line of the installed-at site. For example, unmasked value can be XYZ or blank and masked value will be Confidential. For more details, refer Masking Details section.
  installedatCity	STRING	128	[Masking Applicable] City name of the installed-at site. For example, unmasked value can be FELTHAM and masked value will be Confidential. For more details, refer Masking Details section.
  installedatState	STRING	128	[Masking Applicable] State name of the installed-at site. For example, unmasked value can be CA and masked value will be Confidential. For more details, refer Masking Details section.
  installedatPostalCode	STRING	128	[Masking Applicable] Postal code of the installed-at site. For example, unmasked value can be TW14 8HA and masked value will be Confidential. For more details, refer Masking Details section.
  installedatProvince	STRING	128	[Masking Applicable] Province name of the installed-at site. For example, unmasked value can be D.C and masked value will be Confidential. For more details, refer Masking Details section.
  installedatCountry	STRING	128	[Masking Applicable] Country name of the installed-at site. For example, unmasked value can be GB and masked value will be Confidential. For more details, refer Masking Details section.
  warrantyType	STRING	512	Type of the device warranty.
  warrantyStartDate	DATE	Start date of the device warranty. GMT date format: YYYY-MM-DD.
  warrantyEndDate	DATE	The date warranty expires on a piece of purchased hardware. GMT date format: YYYY-MM-DD.
  neInstanceId	NUMBER	19	Unique id used to identify an instance of a network element. Network element is a manageable logical entity uniting one or more physical devices. This allows distributed devices to be managed in a unified way using one management system.
  billtoPartyId	NUMBER	[Masking Applicable] Unique identifier of an Entitled Party where the contract was billed to. For example, unmasked value can be 30411234 and masked value will be Confidential. For more details, refer Masking Details section.

  Sample Request

  Sample JSON Response

   < "data": [ < "customerId": 1234, "contractInstanceNumber": 823855020, "serialNumber": "FCH1529FT60", "productId": "CP-7975G", "hwType": "IP_PHONE", "orderShipDate": "08-NOV-2011", "installedatSiteId": "Confidential", "installedatSiteName": "Confidential", "installedatAddressLine1": "Confidential", "installedatAddressLine2": "Confidential", "installedatAddressLine3": "Confidential", "installedatAddressLine4": "Confidential", "installedatCity": "Confidential", "installedatState": "Confidential", "installedatPostalCode": "95134", "installedatProvince": "Confidential", "installedatCountry": "Confidential", "warrantyType": "WARR-90-DAY-LTD-HW", "warrantyStartDate": "2011-11-08T00:00:00", "warrantyEndDate": "2011-12-11T00:00:00", "networkElementId": 265924586, "billtoPartyId": "Confidential" >], "pagination": < "page": 1, "pages": 200, "rows": 1, "total": 200 >>