Introduction

Overview

Cisco’s customers and partners today use Cisco hosted web applications to gather product information using serial numbers for products either already installed at a customer site or being considered for new purchases. While serial numbers are normally unique within a product family, they are not always unique across all Cisco devices (for example, devices from companies acquired by Cisco). Therefore, it is necessary and required to track both the serial number and the product identifier (PID) to uniquely identify a network device. The Cisco Serial Number to Information API assists customers and partners in identifying an orderable PID and coverage status based on a serial number.

Features

The Cisco Serial Number to Information API provides the following features:

Supports RESTful interface
Supports JSON data format
Includes web services that return:
- Contract coverage status for specified serial number(s)
- Coverage summary for specified serial number(s)
- Coverage summary for specified instance number(s)
- Orderable PIDs for specified serial number(s)
- Owner coverage status for specified serial number(s)

Cisco Serial Number to Information API Reference

This topic describes the methods provided by this API.

Notes:

Pagination is supported for Get Coverage Summary by Serial Number(s).
For information on error codes returned by these methods, see Error Codes.
You can download the WADL for this API by clicking the following link: Cisco Serial Number to Information API WADL
This API reference provides information related to the latest version of this API. Cisco encourages you to use the latest version of the Cisco Support APIs; however, if you use the legacy version of this API, refer to the Cisco Serial Number to Information 1.0 Reference for details.

Get Coverage Status by Serial Number(s)

Returns coverage status for a set of serial numbers.

URI

https://apix.cisco.com/sn2info/v2/coverage/status/serial_numbers/{sr_no,sr_no,sr_no}

Request Parameter

Parameter	Required	Type	Length	Description
sr_no	Yes	string	40	Device serial number or numbers for which to return results. You can enter up to 75 serial numbers (each with a maximum length of 40) separated by commas.

Response Parameters

Parameter	Type	Length	Description
coverage_end_date	string	10	End date of the coverage for the specifed serial number in the following format: YYYY-MM-DD; for example, 2010-01-01.
is_covered	string	3	Indicates whether the specified serial number is covered by a service contract; one of the following values: YES or NO. If the serial number is covered by a service contract, the value is Yes.
sr_no	string	40	Serial number of the device.

Note: If no connection is found between the user, contract, and device, this method returns data only for the following fields; coverage_end_date is visible but displays no data:

is_covered
sr_no

Sample Request

GET https://apix.cisco.com/sn2info/v2/coverage/status/serial_numbers/FOC10220LK9

Sample Response

{
   "serial_numbers": [{
      "sr_no": "FOC10220LK9",
      "is_covered": "YES",
      "coverage_end_date": "2014-12-31"
   }]
}

Get Coverage Summary by Serial Number(s)

Returns coverage status, warranty, and product identifier details for a set of serial numbers.

URI

https://apix.cisco.com/sn2info/v2/coverage/summary/serial_numbers/{sr_no,sr_no,sr_no}

Request Parameters

Parameter	Required	Type	Length	Description
page_index	No	integer	2	Index number of the page to return; a maximum of 50 records per page are returned.
sr_no	Yes	string	40	Device serial number or numbers for which to return results. You can enter up to 75 serial numbers (each with a maximum length of 40) separated by commas.

Response Parameters

Parameter	Type	Length	Description
base_pid	string	20	For Future Use Base or manufacturing product identifiers related to the specified serial number.
contract_site_address1	string	100	Address field for the contract install site; for example, 170 WEST TASMAN DR.
contract_site_city	string	20	City field for the contract install site; for example, SAN JOSE.
contract_site_country	string	20	Country field for the contract install site; for example, US.
contract_site_customer_name	string	100	Customer name associated to the contract install site; for example, CISCO SYSTEMS, INC..
contract_site_state_province	string	20	State field for the contract install site; for example, CA.
covered_product_line_end_date	date	10	End date of the covered product line in the following format: YYYY-MM-DD; for example, 2010-01-01.
id	integer	5	Number of the record in the results.
is_covered	string	3	Indicates whether the specified serial number is covered by a service contract; one of the following values: YES or NO. If the serial number is covered by a service contract, the value is Yes.
item_description	string	300	Description of the item identified by the orderable_pid value.
item_position	string	1	Specifies whether the item specified by orderable_pid is MAJOR, MINOR, or STANDALONE; one of the following values: P = PARENT (MAJOR) C = CHILD (MINOR) S = STANDALONE
item_type	string	100	For Future Use Type of item identified by the orderable_pid value; for example, card or chassis.
last_index	integer	2	Last page number.
orderable_pid	string	20	Orderable product identifiers for the specified serial number; for example, HWIC-4ESW.
page_index	integer	2	Current page number.
page_records	integer	2	Number of results per page returned.
parent_sr_no	string	40	Parent serial number. The value of parent_sr_no will be the same as the value for sr_no if the item is a MAJOR item; that is, if item_position = P (Parent) or item_position = S (Stand Alone). The value of parent_sr_no will be different than the value for sr_no if the item is a MINOR item; that is, item_position = C (Child).
pillar_code	string	20	Specifies the contract service line for the item specified by orderable_pid; one of the following values: 1 = TAC Support 2 = Hardware replacement 3 = Software Support A single service line can be associated to multiple pillars.
self_link	string	3200	Complete URI of the submitted request
service_contract_number	string	200	Service contract number; for example, 1234567, 2345678, 3456789.
service_line_descr	string	20	Description of the service type; for example, SMARTnet Premium 24x7x4.
sr_no	string	40	Serial number of the device.
title	string	128	Title of the request.
total_records	integer	2	Total number of records returned.
warranty_end_date	date	10	End date of the warranty for the specified serial number in the following format: YYYY-MM-DD; for example, 2010-01-01.
warranty_type	string	20	Warranty service type; for example, WARR-3YR-HW-90D-SW.
warranty_type_description	string	100	Link to the description of the warranty type.

Note: If no connection is found between the user, contract, and device, this method displays data only for the following fields; all other fields are visible but display no data:

base_pid_list (and associated children)
is_covered
orderable_pid_list (and associated children)
sr_no
warranty_end_date

Sample Request

GET https://apix.cisco.com/sn2info/v2/coverage/summary/serial_numbers/SAL09232Q0Z,32964768,FOC0903N5J9,INM07501EC3,SWCAT1239A0CJ?page_index=1

Sample Response

{
  "pagination_response_record": {
    "last_index": 1,
    "page_index": 1,
    "page_records": 5,
    "self_link": "https://apix.cisco.com/sn2info/v2/coverage/summary/serial_numbers/SAL09232Q0Z,32964768,FOC0903N5J9,INM07501EC3,SWCAT1239A0CJ?page_index=1",
    "title": "Get Coverage Summary by Serial Numbers - SN2INFO API",
    "total_records": 5
  },
  "serial_numbers": [{
    "base_pid_list": [{
      "base_pid": ""
    }],
    "contract_site_customer_name": "CISCO SYSTEMS, INC.", 
    "contract_site_address1": "170 WEST TASMAN DR.", 
    "contract_site_city": "SAN JOSE",
    "contract_site_state_province": "CA", 
    "contract_site_country": "US", 
    "covered_product_line_end_date": "2014-12-31",
    "id": "1",
    "is_covered": "YES",
    "orderable_pid_list": [{
      "item_description": "Catalyst 6500/Cisco 7600 Supervisor 720 Fabric MSFC3 PFC3BXL",
      "item_position": "S",
      "item_type": "",
      "orderable_pid": "WS-SUP720-3BXL=",
      "pillar_code": "1,2,3"
    }],
    "parent_sr_no": "SAL09232Q0Z",
    "service_contract_number": "1234567",
    "service_line_descr": "SMARTnet 2x3xNB",
    "sr_no": "SAL09232Q0Z",
    "warranty_end_date": "2007-08-08",
    "warranty_type": "WARR-3YR-HW-90D-SW",
    "warranty_type_description": "http://www.cisco.com/c/en/us/products/warranty-listing.html”
  },{
    "base_pid_list": [{
      "base_pid": ""
    }],
    "contract_site_customer_name": "CISCO SYSTEMS, INC.", 
    "contract_site_address1": "170 WEST TASMAN DR.", 
    "contract_site_city": "SAN JOSE",
    "contract_site_state_province": "CA", 
    "contract_site_country": "US", 
    "covered_product_line_end_date": "2013-12-12",
    "id": "2",
    "is_covered": "YES",
    "orderable_pid_list": [{
      "item_description": "^2-Port Serial WAN Interface Card spare",
      "item_position": "S",
      "item_type": "",
      "orderable_pid": "WIC-2T=",
      "pillar_code": "1,2,3"
    }],
    "parent_sr_no": "12345678",
    "service_contract_number": "1234567",
    "service_line_descr": "SMARTnet 2x3xNB",
    "sr_no": "32964768",
    "warranty_end_date": "2005-08-07",
    "warranty_type": "WARR-3YR-HW-90D-SW",
    "warranty_type_description": "http://www.cisco.com/c/en/us/products/warranty-listing.html”
  },{
    "base_pid_list": [{
      "base_pid": ""
    }],
    "contract_site_customer_name": "CISCO SYSTEMS, INC.", 
    "contract_site_address1": "170 WEST TASMAN DR.", 
    "contract_site_city": "SAN JOSE",
    "contract_site_state_province": "CA", 
    "contract_site_country": "US", 
    "covered_product_line_end_date": "2015-06-30",
    "id": "3",
    "is_covered": "NO",
    "orderable_pid_list": [{
      "item_description": "Rel. 8.5.0 SW, Pre-loaded on TCC",
      "item_position": "C",
      "item_type": "",
      "orderable_pid": "SF15454-R8.5.0K9",
      "pillar_code": "1,2,3,5"
    }],
    "parent_sr_no": "CAT1239A0CJ",
    "service_contract_number": "2345678",
    "service_line_descr": "SMARTnet 1y2yMD",
    "sr_no": "SWCAT1239A0CJ",
    "warranty_end_date": "2014-01-17",
    "warranty_type": "WARR-3YR-HW-90D-SW",
    "warranty_type_description": "http://www.cisco.com/c/en/us/products/warranty-listing.html”
  },{
    "base_pid_list": [{
      "base_pid": ""
    }],
    "contract_site_customer_name": "CISCO SYSTEMS, INC.", 
    "contract_site_address1": "170 WEST TASMAN DR.", 
    "contract_site_city": "SAN JOSE",
    "contract_site_state_province": "CA", 
    "contract_site_country": "US", 
    "covered_product_line_end_date": "",
    "id": "4",
    "is_covered": "NO",
    "orderable_pid_list": [{
      "item_description": "802.11a/b/g Cardbus Adapter; FCC Cnfg",
      "item_position": "S",
      "item_type": "",
      "orderable_pid": "AIR-CB21AG-A-K9",
      "pillar_code": ""
    }],
    "parent_sr_no": "FOC0903N5J9",
    "service_contract_number": "2345678",
    "service_line_descr": "SMARTnet 1y2yMD",
    "sr_no": "FOC0903N5J9",
    "warranty_end_date": "2015-05-07",
    "warranty_type": "WARR-3YR-HW-90D-SW",
    "warranty_type_description": "http://www.cisco.com/c/en/us/products/warranty-listing.html”
  },{
    "base_pid_list": [{
      "base_pid": ""
    }],
    "contract_site_customer_name": "CISCO SYSTEMS, INC.", 
    "contract_site_address1": "170 WEST TASMAN DR.", 
    "contract_site_city": "SAN JOSE",
    "contract_site_state_province": "CA", 
    "contract_site_country": "US", 
    "covered_product_line_end_date": "",
    "id": "5",
    "is_covered": "NO",
    "orderable_pid_list": [{
      "item_description": "7940 IP Phone with one Station User License",
      "item_position": "S",
      "item_type": "",
      "orderable_pid": "CP-7940G-CH1",
      "pillar_code": ""
    }],
    "parent_sr_no": "ABC123456DE7",
    "service_contract_number": "1234567",
    "service_line_descr": "SMARTnet 2x3xNB",
    "sr_no": "INM07501EC3",
    "warranty_end_date": "2005-05-04",
    "warranty_type": "WARR-3YR-HW-90D-SW",
    "warranty_type_description": "http://www.cisco.com/c/en/us/products/warranty-listing.html”
  }]
}

Get Coverage Summary by Instance Number(s)

Returns coverage status, warranty, and product identifier details for a set of instance numbers.

URI

https://apix.cisco.com/sn2info/v2/coverage/summary/instance_numbers/{instance_no,instance_no,instance_no}

Request Parameters

Parameter	Required	Type	Length	Description
page_index	No	integer	2	Index number of the page to return; a maximum of 50 records per page are returned.
instance_no	Yes	string	40	Device instance number(s) for which to return results. You can enter up to 75 instance numbers (each with a maximum length of 40) separated by commas.

Response Parameters

Parameter	Type	Length	Description
base_pid	string	20	Base or manufacturing product identifiers related to the specified instance number.
contract_site_address1	string	100	Address field for the contract install site; for example, 170 WEST TASMAN DR.
contract_site_city	string	20	City field for the contract install site; for example, SAN JOSE.
contract_site_country	string	20	Country field for the contract install site; for example, US.
contract_site_customer_name	string	100	Customer name associated to the contract install site; for example, CISCO SYSTEMS, INC..
contract_site_postal_code	string	20	Postal (zip) code for the contract install site; for example, 95134.
contract_site_state_province	string	20	State field for the contract install site; for example, CA.
covered_product_line_end_date	date	10	End date of the covered product line in the following format: YYYY-MM-DD; for example, 2010-01-01.
id	integer	5	Number of the record in the results.
instance_number	string	40	Instance number of the device.
is_covered	string	3	Indicates whether the specified serial number is covered by a service contract; one of the following values: YES or NO. If the serial number is covered by a service contract, the value is Yes.
item_description	string	300	Description of the item identified by the orderable_pid value.
item_position	string	1	Specifies whether the item specified by orderable_pid is MAJOR, MINOR, or STANDALONE; one of the following values: P = PARENT (MAJOR) C = CHILD (MINOR) S = STANDALONE
item_type	string	100	For Future Use Type of item identified by the orderable_pid value; for example, card or chassis.
last_index	integer	2	Last page number.
orderable_pid	string	20	Orderable product identifiers for the specified instance number; for example, HWIC-4ESW.
page_index	integer	2	Current page number.
page_records	integer	2	Number of results per page returned.
parent_instance_no	string	40	Parent instance number.
self_link	string	3200	Complete URI of the submitted request
service_contract_number	string	200	Service contract number; for example, 1234567, 2345678, 3456789.
service_line_descr	string	20	Description of the service type; for example, SMARTnet Premium 24x7x4.
sr_no	string	40	Serial number of the device.
title	string	128	Title of the request.
total_records	integer	2	Total number of records returned.
warranty_end_date	date	10	End date of the warranty for the specified serial number in the following format: YYYY-MM-DD; for example, 2010-01-01.
warranty_type	string	20	Warranty service type; for example, WARR-3YR-HW-90D-SW.
warranty_type_description	string	100	Link to the description of the warranty type.

Note: If no connection is found between the user, contract, and device, this method displays data only for the following fields; all other fields are visible but display no data:

base_pid_list (and associated children)
orderable_pid
warranty_type_description

Sample Request

GET https://apix.cisco.com/sn2info/v2/coverage/summary/instance_numbers/917280220

Sample Response

{
  "pagination_response_record": {
    "last_index": 1,
    "page_index": 1,
    "page_records": 1,
    "self_link": "https://apix.cisco.com/sn2info/v2/coverage/summary/instance_numbers/917280220?page_index=1",
    "title": "Get Coverage Summary by Instance Numbers - SN2INFO API",
    "total_records": 1
  },
  "instance_numbers": [
    {
      "id": "1",
      "base_pid": {
        "base_pid": "CISCO891-K9"
      },
      "contract_site_customer_name": "NC-RTP 9 - RIDGE",
      "contract_site_address1": "7100 KIT CREEK RDBUILDING 9",
      "contract_site_city": "RESEARCH TRIANGLE PARK",
      "contract_site_state_province": "NC",
      "contract_site_postal_code": "27709-4987",
      "contract_site_country": "US",
      "covered_product_line_end_date": "2018-08-26",
      "instance_number": "917280220",
      "parent_instance_no": "917280220",
      "is_covered": "YES",
      "orderable_pid": {
        "item_description": "^Cisco 891 GigaE SecRouter",
        "item_position": "P",
        "item_type": "",
        "orderable_pid": "CISCO891-K9"
      },
      "service_contract_number": "92645456",
      "service_line_descr": "SMARTnet 8x5xNBD",
      "sr_no": "FTX16148509",
      "warranty_end_date": "2013-07-06",
      "warranty_type": "WARR-1YR-LTD-HW",
      "warranty_type_description": "http://www.cisco.com/go/warranty"
    }
  ]
}

Get Orderable Product Identifier(s) by Serial Number(s)

Returns the orderable PID for the specified device serial number.

URI

https://apix.cisco.com/sn2info/v2/identifiers/orderable/serial_numbers/{sr_no,sr_no,sr_no}

Request Parameter

Parameter	Required	Type	Length	Description
sr_no	Yes	string	40	Device serial number or numbers for which to return results. You can enter up to 75 serial numbers (each with a maximum length of 40) separated by commas.

Response Parameters

Parameter	Type	Length	Description
orderable_pid	string	20	Orderable product identifier associated with the serial number; for example, HWIC-4ESW.
pillar_code	string	2	Specifies the contract service line for the item specified by orderable_pid; one of the following values: 1 = TAC Support 2 = Hardware replacement 3 = Software Support A single service line can be associated to multiple pillars.
pillar_description	string	50	Description of the pillar code.
sr_no	string	40	Serial number of the device.

Sample Request

GET https://apix.cisco.com/sn2info/v2/identifiers/orderable/serial_numbers/FOC10220LK9

Sample Response

{ 
  "serial_numbers": [{
    "sr_no": "FOC10220LK9",
    "orderable_pid_list":[{
      "orderable_pid": "PVDM2-64",
      "pillar_code": "",
      "pillar_description": ""
    },{
      "orderable_pid": "PVDM2-64",
      "pillar_code": "3",
      "pillar_description": "SOFTWARE SUPPORT"
    },{
      "orderable_pid": "PVDM2-64",
      "pillar_code": "1",
      "pillar_description": "TAC SUPPORT"
    },{
      "orderable_pid": "PVDM2-64",
      "pillar_code": "2",
      "pillar_description": "HARDWARE REPLACEMENT"
    }]
  }]
}

Get Owner Coverage Status by Serial Number(s)

Returns owner coverage status information for a set of serial numbers.

URI

https://apix.cisco.com/sn2info/v2/coverage/owner_status/serial_numbers/{sr_no,sr_no,sr_no}

Request Parameter

Parameter	Required	Type	Length	Description
sr_no	Yes	string	40	Device serial number or numbers for which to return results. You can enter up to 75 serial numbers (each with a maximum length of 40) separated by commas.

Response Parameters

Parameter	Type	Length	Description
coverage_end_date	date	10	End date of the coverage for the specifed serial number in the following format: YYYY-MM-DD; for example, 2010-01-01.
is_covered	string	3	Indicates whether the specified serial number is covered by a service contract; one of the following values: YES or NO. If the serial number is covered by a service contract, the value is Yes.
sr_no	string	40	Serial number of the device.
sr_no_owner	string	3	Indicates whether the serial number or numbers are associated to the CCO ID provided. One of the following values: Yes No

Note: If no connection is found between the user, contract, and device, this method displays data only for the following fields; coverage_end_date is visible but displays no data:

is_covered
sr_no
sr_no_owner

Sample Request

GET https://apix.cisco.com/sn2info/v2/coverage/owner_status/serial_numbers/FOC0717W107,FOC11517LEX,FOC0737Y43K

Sample Response

{ 
    "serial_numbers": [{
        "sr_no": "FOC0717W107",
        "is_covered": "YES",
        "coverage_end_date": "2003-03-05",
        "sr_no_owner": "NO"
    },{
        "sr_no": "FOC11517LEX",
        "is_covered": "NO",
        "coverage_end_date": "",
        "sr_no_owner": "NO"
    },{
        "sr_no": "FOC0737Y43K",
        "is_covered": "YES",
        "coverage_end_date": "2003-03-21",
        "sr_no_owner": "NO"
    }]
}

Error Codes

This table describes the status codes returned by the Cisco Serial Number to Information API.

Status Code	Message	Description
200	NO_RECORDS_FOUND	No records found.
200	EXCEEDED_OUTPUT	Server error; too many results.
400	API_MISSING_PARAMETERS	Input parameters are missing.
400	API_INVALID_INPUT	Input parameters are invalid; only one input parameter provided.
400	EXCEEDED_INPUTS	Too many input parameters.
403	API_NOTAUTHORIZED	User not authorized.
500	API_ERROR_01	Internal error occurred.