Update Device

Update Device

curl --request PUT \
  --url https://qa-lynx.nayax.com/operational/v1/devices/{DeviceID} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ActorID": 123,
  "StatusID": 1
}
'

{
  "VposChipId": "<string>",
  "IsDeviceExists": true,
  "FWVersionNumber": "<string>",
  "VposVersionNumber": "<string>",
  "DeviceID": 123,
  "ActorID": 123,
  "DeviceTypeLutID": 123,
  "DeviceSerial": "<string>",
  "IMEI": "<string>",
  "DeviceDescription": "<string>",
  "SimCardID": 123,
  "FWVersionID": 123,
  "RequestedFwID": 123,
  "PollInterval": 123,
  "StatusID": 123,
  "LastUpdated": "2023-11-07T05:31:56Z",
  "IsCollectMultipleParameters": true,
  "IsLogged": true,
  "FRequestedNewVersionDate": "2023-11-07T05:31:56Z",
  "FTookNewVersionDate": "2023-11-07T05:31:56Z",
  "HardwareVersion": "<string>",
  "IsRental": true,
  "RentalEndMonth": 123,
  "RentalEndYear": 123,
  "IsToBeReturned": true,
  "FeeCommunicationThreshold": 123,
  "BillingPlanID": 123,
  "BillingPlanActivationDate": "2023-11-07T05:31:56Z",
  "DeviceCreationDate": "2023-11-07T05:31:56Z",
  "CreatedBy": 123,
  "UpdatedBy": 123,
  "DistributorBillingPlanID": 123,
  "ChipID": "<string>",
  "OrderID": 123,
  "ExternalFlashSize": 123,
  "BoardSerial": "<string>",
  "FlashSize": 123,
  "DeviceFamily": "<string>",
  "ModemModel": "<string>",
  "TrialEndDate": "2023-11-07T05:31:56Z",
  "VerticalTypeID": 123,
  "VerticalProductTypeID": 123,
  "VerticalTypeLutID": 123,
  "VerticalProductTypeLutID": 123,
  "Refs": {}
}

PUT

devices

{DeviceID}

Update Device

curl --request PUT \
  --url https://qa-lynx.nayax.com/operational/v1/devices/{DeviceID} \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "ActorID": 123,
  "StatusID": 1
}
'

{
  "VposChipId": "<string>",
  "IsDeviceExists": true,
  "FWVersionNumber": "<string>",
  "VposVersionNumber": "<string>",
  "DeviceID": 123,
  "ActorID": 123,
  "DeviceTypeLutID": 123,
  "DeviceSerial": "<string>",
  "IMEI": "<string>",
  "DeviceDescription": "<string>",
  "SimCardID": 123,
  "FWVersionID": 123,
  "RequestedFwID": 123,
  "PollInterval": 123,
  "StatusID": 123,
  "LastUpdated": "2023-11-07T05:31:56Z",
  "IsCollectMultipleParameters": true,
  "IsLogged": true,
  "FRequestedNewVersionDate": "2023-11-07T05:31:56Z",
  "FTookNewVersionDate": "2023-11-07T05:31:56Z",
  "HardwareVersion": "<string>",
  "IsRental": true,
  "RentalEndMonth": 123,
  "RentalEndYear": 123,
  "IsToBeReturned": true,
  "FeeCommunicationThreshold": 123,
  "BillingPlanID": 123,
  "BillingPlanActivationDate": "2023-11-07T05:31:56Z",
  "DeviceCreationDate": "2023-11-07T05:31:56Z",
  "CreatedBy": 123,
  "UpdatedBy": 123,
  "DistributorBillingPlanID": 123,
  "ChipID": "<string>",
  "OrderID": 123,
  "ExternalFlashSize": 123,
  "BoardSerial": "<string>",
  "FlashSize": 123,
  "DeviceFamily": "<string>",
  "ModemModel": "<string>",
  "TrialEndDate": "2023-11-07T05:31:56Z",
  "VerticalTypeID": 123,
  "VerticalProductTypeID": 123,
  "VerticalTypeLutID": 123,
  "VerticalProductTypeLutID": 123,
  "Refs": {}
}

Authorizations

Authorization

string

header

required

Enter your API key. It's required to authenticate API requests.

Path Parameters

DeviceID

integer<int32>

required

The unique identifier of the device to be updated.

Body

application/json

The updated details of the device.

Contains data required to update a device's information, including actor and status details.

ActorID

integer<int64> | null

The identifier of the actor associated with the device.

StatusID

enum<integer> | null

The status identifier of the device.

Available options:

1,

2

Response

200 - application/json

Device details updated successfully.

Contains detailed information about a device, including hardware, software versions, and operational status.

VposChipId

string | null

The unique identifier for the VPOS chip in the device.

IsDeviceExists

boolean

Indicates whether the device exists in the system.

FWVersionNumber

string | null

The firmware version number of the device.

VposVersionNumber

string | null

The VPOSS version number installed on the device.

DeviceID

integer<int32> | null

The unique identifier of the device.

ActorID

integer<int64> | null

The identifier of the actor associated with the device.

DeviceTypeLutID

integer<int32> | null

The lookup identifier for the device type.

DeviceSerial

string | null

The serial number of the device.

IMEI

string | null

The International Mobile Equipment Identity number of the device.

DeviceDescription

string | null

A brief description of the device.

SimCardID

integer<int64> | null

The identifier of the SIM card associated with the device.

FWVersionID

integer<int64> | null

The identifier for the firmware version installed on the device.

RequestedFwID

integer<int64> | null

The identifier for the requested firmware update.

PollInterval

integer<int64> | null

The polling interval for the device in seconds.

StatusID

integer<int32> | null

The current status identifier of the device.

LastUpdated

string<date-time> | null

The date and time when the device was last updated.

IsCollectMultipleParameters

boolean | null

Indicates if the device is set to collect multiple parameters.

IsLogged

boolean | null

Indicates if the device activity is logged.

FRequestedNewVersionDate

string<date-time> | null

The date and time when a new firmware version was requested for the device.

FTookNewVersionDate

string<date-time> | null

The date and time when the new firmware version was applied to the device.

HardwareVersion

string | null

The hardware version of the device.

IsRental

boolean | null

Indicates if the device is rented.

RentalEndMonth

integer<int32> | null

The month when the device rental period ends.

RentalEndYear

integer<int32> | null

The year when the device rental period ends.

IsToBeReturned

boolean | null

Indicates if the device is scheduled to be returned.

FeeCommunicationThreshold

integer<int32> | null

The communication fee threshold for the device.

BillingPlanID

integer<int32> | null

The identifier of the billing plan associated with the device.

BillingPlanActivationDate

string<date-time> | null

The date when the billing plan was activated for the device.

DeviceCreationDate

string<date-time> | null

The date when the device was created in the system.

CreatedBy

integer<int64> | null

The identifier of the user who created the device entry.

UpdatedBy

integer<int64> | null

The identifier of the user who last updated the device entry.

DistributorBillingPlanID

integer<int32> | null

The identifier of the distributor billing plan associated with the device.

ChipID

string | null

The unique identifier for the chip in the device.

OrderID

integer<int32> | null

The identifier of the order associated with the device.

ExternalFlashSize

integer<int32> | null

The size of the external flash memory in the device.

BoardSerial

string | null

The serial number of the device's mainboard.

FlashSize

integer<int32> | null

The size of the internal flash memory in the device.

DeviceFamily

string | null

The family classification of the device.

ModemModel

string | null

The model of the modem installed in the device.

TrialEndDate

string<date-time> | null

The date when the device's trial period ends.

VerticalTypeID

integer<int32> | null

The identifier of the vertical type associated with the device.

VerticalProductTypeID

integer<int32> | null

The identifier of the vertical product type associated with the device.

VerticalTypeLutID

integer<int32> | null

The lookup identifier for the vertical type.

VerticalProductTypeLutID

integer<int32> | null

The lookup identifier for the vertical product type.

Refs

object

A collection of additional references associated with the device.

Show child attributes

Get Device by DeviceID Get All Devices

⌘I

Guides

API Reference

Authorizations

Path Parameters

Body

Response