CIList-post
post
CIList-post
CIList returns a list of service identifiers. Details will not be included.
Resource URL
| Environment | URL |
|---|---|
| Production |
/CIList |
| Test |
https://digitalconnectproxy.verizon.com:443/InventoryManagementTest/CIList |
Header Parameters
| Name | Values | Description |
|---|---|---|
| Content-Type |
|
Request Body Parameters
| Attribute Name | Type | Description |
|---|---|---|
| version * required | string(2) | Service version of the request. Example: V1. |
| transactionID * required | string(50) | A unique identifier for the request. |
| period * required | date/time | 1 today and up to 7 days of inventory information. |
| fullInventory optional | boolean | Only the Delta list will be pulled. Defaults to false. |
| productGroupName optional | string | Product group name eg: Managed Network Solutions, CPE Services. |
| billingAccount optional | string | Billing Account Number (BAN) for the service. |
| serviceGroupName optional | string | Service Group Name (aka Customer Defined Group name (CDG name)). |
| ciStatus optional | string | Status of the seviceID. Example: Active, Abandoned, Deactive |
| nextKey optional | string | Will be required if the previous response did not return the complete response set (max 5000 serviceIDs will be returned in a response). |
| Attribute Name | Type | Description |
|---|---|---|
| succeeded | boolean | True on success, false on failure. |
| transactionID | string(50) | A unique identifier for the request. |
| ciName | string | A Verizon configuration item name, such as a circuit ID, DNS entity name, Toll Free number, etc. |
| serviceID | string | A Verizon configuration item. Example - W0F98607,BCB123450001,8005551212. |
| productServiceName | string | Product name. |
| productGroupName | string | Product group name eg: Managed Network Solutions, CPE Services. |
| ban | string | Billing Account Number of the service. |
| topCustomerName | string(100) | The customer name at the top of the Global Customer Hierarchy. |
| ciStatus | string | Status of the Verizon Services. Example: Active, Abandoned, Deactive |
| lastModifiedDate | string | Date the serviceID was last modified. |
| installationDate | string | Date of the service installed. |
| disconnectedDate | string | Date of the service disconnect. |
| recordsReturned | int | Returns the total number of records. |
| nextKey | int | This is used for pagination and will be required if the response does not have the complete response set (max 5000 serviceIDs). Send the next key in the CiList request to retrieve the next set of serviceIDs. |
| errorCode | string | Error code of failure transaction. |
| errorMessage | string | Error Level - Critical, Warning, Information |
Response Body Parameters
| Attribute Name | Type | Description |
|---|---|---|
| version * required | string(2) | Service version of the request. Example: V1. |
| transactionID * required | string(50) | A unique identifier for the request. |
| period * required | date/time | 1 today and up to 7 days of inventory information. |
| fullInventory optional | boolean | Only the Delta list will be pulled. Defaults to false. |
| productGroupName optional | string | Product group name eg: Managed Network Solutions, CPE Services. |
| billingAccount optional | string | Billing Account Number (BAN) for the service. |
| serviceGroupName optional | string | Service Group Name (aka Customer Defined Group name (CDG name)). |
| ciStatus optional | string | Status of the seviceID. Example: Active, Abandoned, Deactive |
| nextKey optional | string | Will be required if the previous response did not return the complete response set (max 5000 serviceIDs will be returned in a response). |
| Attribute Name | Type | Description |
|---|---|---|
| succeeded | boolean | True on success, false on failure. |
| transactionID | string(50) | A unique identifier for the request. |
| ciName | string | A Verizon configuration item name, such as a circuit ID, DNS entity name, Toll Free number, etc. |
| serviceID | string | A Verizon configuration item. Example - W0F98607,BCB123450001,8005551212. |
| productServiceName | string | Product name. |
| productGroupName | string | Product group name eg: Managed Network Solutions, CPE Services. |
| ban | string | Billing Account Number of the service. |
| topCustomerName | string(100) | The customer name at the top of the Global Customer Hierarchy. |
| ciStatus | string | Status of the Verizon Services. Example: Active, Abandoned, Deactive |
| lastModifiedDate | string | Date the serviceID was last modified. |
| installationDate | string | Date of the service installed. |
| disconnectedDate | string | Date of the service disconnect. |
| recordsReturned | int | Returns the total number of records. |
| nextKey | int | This is used for pagination and will be required if the response does not have the complete response set (max 5000 serviceIDs). Send the next key in the CiList request to retrieve the next set of serviceIDs. |
| errorCode | string | Error code of failure transaction. |
| errorMessage | string | Error Level - Critical, Warning, Information |
Body Parameters
Sample Request
Please login to send the sample request and get a reponse back.
Working...