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

GET : https://apix.cisco.com/cs/api/v1/contracts/contract-details

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/cs/api/v1/contracts/contract-details?customerId=1234

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

GET : https://apix.cisco.com/cs/api/v1/contracts/coverage?customerId=1234

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/cs/api/v1/contracts/coverage?customerId=1234&page=1&rows=1

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

GET : https://apix.cisco.com/cs/api/v1/contracts/not-covered?customerId=1234

Request Parameters

Response Parameters

Sample Request

https://apix.cisco.com/cs/api/v1/contacts/not-covered?customerId=1234

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
    }
}