Skip to content

Latest commit

 

History

History
47 lines (39 loc) · 1.52 KB

list-device-codes-response.md

File metadata and controls

47 lines (39 loc) · 1.52 KB

List Device Codes Response

Structure

ListDeviceCodesResponse

Fields

Name Type Tags Description
errors Error[] | undefined Optional Any errors that occurred during the request.
deviceCodes DeviceCode[] | undefined Optional The queried DeviceCode.
cursor string | undefined Optional A pagination cursor to retrieve the next set of results for your
original query to the endpoint. This value is present only if the request
succeeded and additional results are available.

See Paginating results for more information.

Example (as JSON)

{
  "device_codes": [
    {
      "code": "EBCARJ",
      "created_at": "2020-02-06T18:44:33.000Z",
      "device_id": "907CS13101300122",
      "id": "B3Z6NAMYQSMTM",
      "location_id": "B5E4484SHHNYH",
      "name": "Counter 1",
      "pair_by": "2020-02-06T18:49:33.000Z",
      "product_type": "TERMINAL_API",
      "status": "PAIRED",
      "status_changed_at": "2020-02-06T18:47:28.000Z"
    },
    {
      "code": "GVXNYN",
      "created_at": "2020-02-07T19:55:04.000Z",
      "id": "YKGMJMYK8H4PQ",
      "location_id": "A6SYFRSV4WAFW",
      "name": "Unused device code",
      "pair_by": "2020-02-07T20:00:04.000Z",
      "product_type": "TERMINAL_API",
      "status": "UNPAIRED",
      "status_changed_at": "2020-02-07T19:55:04.000Z"
    }
  ]
}