Item/GetAvailable
Summary
These API will let you:
Get all available items
EndPoints:
Item/GetAvailable
Response
Field | Data Type | Definition |
ItemRecords | Array | List of matching item records |
Itemcode | String | Unique code provided for an item by CDS (internal item identified) |
ThirdPartyItemCode | String | Unique code provided for an item by the client or a third party (external item identified) |
LongName | String | Full name of the item |
Base URL
The base URL for all API endpoints is:
https://bridge.cdsreg.com/Item/GetAvailable
URL:
https://bridge.cdsreg.com/Item/GetAvailableMethod: Get
Parameters (Swagger)
Record Limit: The number of records the user wishes to pull.
Page: The page number to be sent.
Auth Key: Authorization Key needed to call API endpoint.
Example Request:
curl -X 'GET' \
'https://bridge.cdsreg.com/Item/GetAvailable?AuthKey=(Omitted)' \
-H 'accept: text/plain'Example Response:
"RecordCount": 0,
"StatusCode": 0,
"ReturnMessages": [
"string"
],
"Success": true,
"OperationId": "string",
"ItemRecords": [
{
"ItemCode": "string",
"ThirdPartyItemCode": "string",
"LongName": "string"
}
]
}Error Responses
400 Bad Request:
If [describe the error condition].
Example Error Response:
{
"RecordCount": 0,
"StatusCode": 400,
"ReturnMessages": [
"INVALID AUTH KEY"
],
"Success": false,
"OperationId": "4739ef76fa187cac9de91dfd8fe829c7",
"RegRecords": []
}