Wiki

Clone wiki

Numera.LibrisAPI / device.replace

Home > API Reference Documentation > device.replace

device.replace

The device.replace action (also known as a "swap") is used to swap the active device for a patient with a new device, commonly used during device replacements. It requires Agent Supervisor or higher permissions to invoke.

Input Parameters

PropertyRequiredDescription
old_imeiyesThe imei of their current device
new_imeiyesThe imei of their new device

Output

The result object will be empty.

Possible Status Codes

Status CodeReasonDescription
1001DEVICE_DOES_NOT_EXISTCould not locate the device or the user does not have access to it
1002OLD_DEVICE_NOT_ACTIVEThe old device must be their current active device
1003OLD_DEVICE_NO_EVENT_COLLECTORThe old device must have an event collector
1004NEW_DEVICE_NOT_UNMANAGEDThe new device must be new and not in any other status
1005NEW_DEVICE_HAS_EVENT_COLLECTORThe new device already has an event collector
1006DEVICES_ARE_IN_DIFFERENT_REALMSThe devices must be in the same realm

Updated