Guides

Get Device Type

Suggest Edits

This page presents how to retrieve a specific device's type using the Lynx API. In the step-by-step guide below, you'll use the following endpoints:

get Get All Devices

get Get Device by DeviceID

get Get Lookup Value by Lookup ID

🚧

Authentication

Refer to the Security & Token page of this documentation to learn how to access your tokens, and how to properly use it to authenticate your API requests.

Step 1: Retrieve the Device ID

Before identifying a device's type, you need its Device ID. You can obtain this by using the Get All Devices endpoint. Provide the Actor ID (operator's ID) to get a list of all devices under that operator.

The code block below presents an example request and response for this endpoint:

curl -X GET "https://lynx.nayax.com/operational/api/v1/devices?actorID=<YOUR_ACTOR_ID>" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
-H "Content-Type: application/json"

[
  {
    "VposChipId": "A3C5F4",
    "IsDeviceExists": true,
    "FWVersionNumber": "3.1.7",
    "VposVersionNumber": "2.5.4",
    "DeviceID": 123456,
    "ActorID": 2001492652,
    "DeviceTypeLutID": 555003,
    "DeviceSerial": "SN12345X",
    "IMEI": "356789012345678",
    "DeviceDescription": "Car Accessories Device",
    "SimCardID": 67890,
    "FWVersionID": 102,
    "RequestedFwID": 103,
    "PollInterval": 15,
    "StatusID": 1,
    "LastUpdated": "2024-10-09T14:16:23.392Z",
    "IsCollectMultipleParameters": true,
    "IsLogged": true,
    "FRequestedNewVersionDate": "2024-09-01T08:00:00.000Z",
    "FTookNewVersionDate": "2024-09-02T10:30:00.000Z",
    "HardwareVersion": "1.2",
    "IsRental": true,
    "RentalEndMonth": 12,
    "RentalEndYear": 2024,
    "IsToBeReturned": false,
    "FeeCommunicationThreshold": 500,
    "BillingPlanID": 305,
    "BillingPlanActivationDate": "2023-11-15T00:00:00.000Z",
    "DeviceCreationDate": "2022-06-25T10:30:00.000Z",
    "CreatedBy": 105,
    "UpdatedBy": 107,
    "DistributorBillingPlanID": 400,
    "ChipID": "CHIP7890",
    "OrderID": 789012,
    "ExternalFlashSize": 64,
    "BoardSerial": "BOARD56789",
    "FlashSize": 32,
    "DeviceFamily": "Automotive",
    "ModemModel": "XModemPro",
    "TrialEndDate": "2024-12-31T23:59:59.000Z",
    "VerticalTypeID": 1,
    "VerticalProductTypeID": 2,
    "VerticalTypeLutID": 555004,
    "VerticalProductTypeLutID": 555005,
    "Refs": {
      "Documentation": "https://lynx.docs.com/device/123456"
    }
  }
]

📘

Replace <YOUR_ACTOR_ID> with the operator's actual unique identifier.

The response will include details of an array of devices. You will use the DeviceID in Step 2.

Step 2: Use the Device ID to Get the Device Type

With the Device ID in hand, use the Get Device by DeviceID endpoint to retrieve the device's type:

curl -X GET "https://lynx.nayax.com/operational/api/v1/devices/<DeviceID>" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
-H "Content-Type: application/json"

{
  "VposChipId": "A3C5F4",
  "IsDeviceExists": true,
  "FWVersionNumber": "3.1.7",
  "VposVersionNumber": "2.5.4",
  "DeviceID": 123456,
  "ActorID": 2001492652,
  "DeviceTypeLutID": 555003,
  "DeviceSerial": "SN12345X",
  "IMEI": "356789012345678",
  "DeviceDescription": "Car Accessories Device",
  "SimCardID": 67890,
  "FWVersionID": 102,
  "RequestedFwID": 103,
  "PollInterval": 15,
  "StatusID": 1,
  "LastUpdated": "2024-10-09T14:16:23.392Z",
  "IsCollectMultipleParameters": true,
  "IsLogged": true,
  "FRequestedNewVersionDate": "2024-09-01T08:00:00.000Z",
  "FTookNewVersionDate": "2024-09-02T10:30:00.000Z",
  "HardwareVersion": "1.2",
  "IsRental": true,
  "RentalEndMonth": 12,
  "RentalEndYear": 2024,
  "IsToBeReturned": false,
  "FeeCommunicationThreshold": 500,
  "BillingPlanID": 305,
  "BillingPlanActivationDate": "2023-11-15T00:00:00.000Z",
  "DeviceCreationDate": "2022-06-25T10:30:00.000Z",
  "CreatedBy": 105,
  "UpdatedBy": 107,
  "DistributorBillingPlanID": 400,
  "ChipID": "CHIP7890",
  "OrderID": 789012,
  "ExternalFlashSize": 64,
  "BoardSerial": "BOARD56789",
  "FlashSize": 32,
  "DeviceFamily": "Automotive",
  "ModemModel": "XModemPro",
  "TrialEndDate": "2024-12-31T23:59:59.000Z",
  "VerticalTypeID": 1,
  "VerticalProductTypeID": 2,
  "VerticalTypeLutID": 555004,
  "VerticalProductTypeLutID": 555005,
  "Refs": {
    "Documentation": "https://lynx.docs.com/device/123456"
  }
}

📘

Replace <DeviceID> with the actual Device ID obtained in Step 1.

The response will include a field named DeviceTypeLutID, which represents the device type. You will need to look it up to understand what this ID means.

Step 3: Get the Verbal Meaning of the Device Type

To translate the DeviceTypeLutID into a readable format, use the Get Lookup Value by Lookup ID endpoint:

curl -X GET "https://lynx.nayax.com/operational/api/v1/lookups/values/<DeviceTypeLutID>" \
-H "Authorization: Bearer <YOUR_ACCESS_TOKEN>" \
-H "Content-Type: application/json"

{
  "LutTypeRef": "DeviceType",
  "LutID": 555003,
  "LutTypeID": 1001,
  "LutValue": "VPOS Touch",
  "LastUpdated": "2024-10-09T14:16:23.392Z",
  "OrderKey": 1,
  "LutCode": 203,
  "Ckey": "pair_vpos_touch",
  "ServiceLutId": 2001,
  "CreatedDT": "2021-05-24T07:16:28.343Z",
  "CreatedBT": 12345,
  "UpdatedBy": 105,
  "LinkedLutId": 0
}

📘

Replace <DeviceTypeLutID> with the value received from step 2.

The response will present a LutValue field, which is the verbal type of the device being searched.


Updated 6 months ago