v1

latestOpenAPI 3.0.12026-07-26181265484.9 KB

Devices

Update Device

Update the details of an existing device using its DeviceID. The unique identifier of the device is provided in the path to ensure that the correct device is updated.

put/v1/devices/{DeviceID}

Path parameters

DeviceIDinteger required

The unique identifier of the device to be updated.

Request body

ActorIDinteger nullable

The identifier of the actor associated with the device.

{"stackTrail":"components:schemas:ActiveInactiveEnum","oasType":"schema","type":"unknown","extensionFields":{"x-enumDescriptions":{"1":"Active","2":"Inactive"}}}

Response

Device details updated successfully.

VposChipIdstring nullable

The unique identifier for the VPOS chip in the device.

IsDeviceExistsboolean

Indicates whether the device exists in the system.

FWVersionNumberstring nullable

The firmware version number of the device.

VposVersionNumberstring nullable

The VPOSS version number installed on the device.

DeviceIDinteger nullable

The unique identifier of the device.

ActorIDinteger nullable

The identifier of the actor associated with the device.

DeviceTypeLutIDinteger nullable

The lookup identifier for the device type.

DeviceSerialstring nullable

The serial number of the device.

IMEIstring nullable

The International Mobile Equipment Identity number of the device.

DeviceDescriptionstring nullable

A brief description of the device.

SimCardIDinteger nullable

The identifier of the SIM card associated with the device.

FWVersionIDinteger nullable

The identifier for the firmware version installed on the device.

RequestedFwIDinteger nullable

The identifier for the requested firmware update.

PollIntervalinteger nullable

The polling interval for the device in seconds.

StatusIDinteger nullable

The current status identifier of the device.

LastUpdatedstring date-time nullable

The date and time when the device was last updated.

IsCollectMultipleParametersboolean nullable

Indicates if the device is set to collect multiple parameters.

IsLoggedboolean nullable

Indicates if the device activity is logged.

FRequestedNewVersionDatestring date-time nullable

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

FTookNewVersionDatestring date-time nullable

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

HardwareVersionstring nullable

The hardware version of the device.

IsRentalboolean nullable

Indicates if the device is rented.

RentalEndMonthinteger nullable

The month when the device rental period ends.

RentalEndYearinteger nullable

The year when the device rental period ends.

IsToBeReturnedboolean nullable

Indicates if the device is scheduled to be returned.

FeeCommunicationThresholdinteger nullable

The communication fee threshold for the device.

BillingPlanIDinteger nullable

The identifier of the billing plan associated with the device.

BillingPlanActivationDatestring date-time nullable

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

DeviceCreationDatestring date-time nullable

The date when the device was created in the system.

CreatedByinteger nullable

The identifier of the user who created the device entry.

UpdatedByinteger nullable

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

DistributorBillingPlanIDinteger nullable

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

ChipIDstring nullable

The unique identifier for the chip in the device.

OrderIDinteger nullable

The identifier of the order associated with the device.

ExternalFlashSizeinteger nullable

The size of the external flash memory in the device.

BoardSerialstring nullable

The serial number of the device's mainboard.

FlashSizeinteger nullable

The size of the internal flash memory in the device.

DeviceFamilystring nullable

The family classification of the device.

ModemModelstring nullable

The model of the modem installed in the device.

TrialEndDatestring date-time nullable

The date when the device's trial period ends.

VerticalTypeIDinteger nullable

The identifier of the vertical type associated with the device.

VerticalProductTypeIDinteger nullable

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

VerticalTypeLutIDinteger nullable

The lookup identifier for the vertical type.

VerticalProductTypeLutIDinteger nullable

The lookup identifier for the vertical product type.

Refsobject nullable

A collection of additional references associated with the device.