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    

Name Values Description
Content-Type

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/time1 today and up to 7 days of inventory information.
fullInventory
optional
booleanOnly the Delta list will be pulled. Defaults to false.
productGroupName
optional
stringProduct group name eg: Managed Network Solutions, CPE Services.
billingAccount
optional
stringBilling Account Number (BAN) for the service.
serviceGroupName
optional
stringService Group Name (aka Customer Defined Group name (CDG name)).
ciStatus
optional
stringStatus of the seviceID. Example: Active, Abandoned, Deactive
nextKey
optional
stringWill 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
succeededbooleanTrue on success, false on failure.
transactionIDstring(50)A unique identifier for the request.
ciNamestringA Verizon configuration item name, such as a circuit ID, DNS entity name, Toll Free number, etc.
serviceIDstring A Verizon configuration item. Example - W0F98607,BCB123450001,8005551212.
productServiceNamestringProduct name.
productGroupNamestringProduct group name eg: Managed Network Solutions, CPE Services.
banstringBilling Account Number of the service.
topCustomerNamestring(100)The customer name at the top of the Global Customer Hierarchy.
ciStatusstringStatus of the Verizon Services. Example: Active, Abandoned, Deactive
lastModifiedDatestringDate the serviceID was last modified.
installationDatestringDate of the service installed.
disconnectedDatestringDate of the service disconnect.
recordsReturnedintReturns the total number of records.
nextKeyintThis 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.
errorCodestringError code of failure transaction.
errorMessagestringError Level - Critical, Warning, Information
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/time1 today and up to 7 days of inventory information.
fullInventory
optional
booleanOnly the Delta list will be pulled. Defaults to false.
productGroupName
optional
stringProduct group name eg: Managed Network Solutions, CPE Services.
billingAccount
optional
stringBilling Account Number (BAN) for the service.
serviceGroupName
optional
stringService Group Name (aka Customer Defined Group name (CDG name)).
ciStatus
optional
stringStatus of the seviceID. Example: Active, Abandoned, Deactive
nextKey
optional
stringWill 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
succeededbooleanTrue on success, false on failure.
transactionIDstring(50)A unique identifier for the request.
ciNamestringA Verizon configuration item name, such as a circuit ID, DNS entity name, Toll Free number, etc.
serviceIDstring A Verizon configuration item. Example - W0F98607,BCB123450001,8005551212.
productServiceNamestringProduct name.
productGroupNamestringProduct group name eg: Managed Network Solutions, CPE Services.
banstringBilling Account Number of the service.
topCustomerNamestring(100)The customer name at the top of the Global Customer Hierarchy.
ciStatusstringStatus of the Verizon Services. Example: Active, Abandoned, Deactive
lastModifiedDatestringDate the serviceID was last modified.
installationDatestringDate of the service installed.
disconnectedDatestringDate of the service disconnect.
recordsReturnedintReturns the total number of records.
nextKeyintThis 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.
errorCodestringError code of failure transaction.
errorMessagestringError Level - Critical, Warning, Information

Body Parameters


Name Values Description
body
(required)

Sample Request

 

Please login to send the sample request and get a reponse back.

Working...