Customer Info

The objective of the Customer Details and Inventory Groups API is to provide detail information about a customer and inventory groups that have been created to group their devices.

Features

The Customer Information API provides the following features:

Supports RESTful interface, using a RAML definition file.
Supports JSON data format
Includes web services that return:
- Information about a customer
- Inventories associated with a specific customer

Customer Details

The Customer Details API returns information about a customer. The information returned includes customer name, customer Id and address details. For a partner user, the API returns a list of customers that have granted the partner user the CBR API Developer role.

URL

GET : https://apix.cisco.com/cs/api/v1/customer-info/customer-details

Request Parameters

Parameter	Type	Required	Description
page	NUMBER	Optional	Page number of the response.
rows	NUMBER	Optional	Number of rows of data per page.
format	STRING	Optional	Supported extension of files such as JSON, CSV, TSV.
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.
customerName	STRING	1005	Name of the customer.
streetAddress1	STRING		First address line of the customer.
streetAddress2	STRING		Second address line of the customer.
streetAddress3	STRING		Third address line of the customer.
streetAddress4	STRING		Fourth address line of the customer.
city	STRING		City name of the customer.
state	STRING		State name of the customer.
country	STRING		Country name of the customer.
postalcode	STRING		postalCode of the customer.
theatreCode	STRING		Theatre code of the customer.

Sample Request

https://apix.cisco.com/cs/api/v1/customer-info/customer-details

Sample JSON Response

{
  "data": [
    {
        "customerId": 1234,
        "customerName": "ABC HEALTH SYSTEM",
        "streetAddress1": "272 HOSPITAL RD",
        "streetAddress2": null,
        "streetAddress3": null,
        "streetAddress4": null,
        "city": "CHILLICOTHE",
        "state": "OH",
        "country": "US",
        "postalcode": "45601",
        "theatreCode": "AMERICAS"
    }
  ],
  "pagination": {
    "page": 1,
    "pages": 1,
    "rows": 1,
    "total": 1
  }
}

Inventory Groups

The Inventory Groups API returns a list of inventories associated with specified customer.

URL

GET : https://apix.cisco.com/cs/api/v1/customer-info/inventory-groups?customerId=123

Parameter	Type	Max Length	Required	Description
customerId	NUMBER	12	Required	Unique identifier of a Cisco customer.
page	NUMBER		Optional	Page number of the response.
rows	NUMBER		Optional	Number of rows of data per page.
format	STRING		Optional	Supported extension of files such as JSON, CSV, TSV.
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
inventoryId	NUMBER	19	Unique identifier of the inventory.
inventoryName	STRING	25	Name of the inventory given by customers.

Sample Request

https://apix.cisco.com/cs/api/v1/customer-info/inventory-groups?customerId=123

Sample JSON Response

{
  "data": [
    {
      "inventoryId": 123,
      "inventoryName": "ABC_CSV"
    }
  ],
  "pagination": {
    "page": 1,
    "pages": 1,
    "rows": 1,
    "total": 1
  }
}