Skip to main content
API docs by Redocly

Aladdin SDS (1.0)

Download OpenAPI specification:Download

/

Responses

Response samples

Content type
application/json
{
  • "apiVersion": "string",
  • "version": "string",
  • "memoryUsage": {
    }
}

List devices

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "content": [
    ]
}

Send HID firmware update command

Send firmware update HID command to the device without device id

Request Body schema: application/json
optional

Firmware update payload for device command

uri
required
string
uriMacro
required
string
commandId
string or null

Responses

Request samples

Content type
application/json
{
  • "uri": "file:///C:/path/to/firmware.dfw",
  • "uriMacro": "file:///C:/path/to/macro.xml",
  • "commandId": "null"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Get device

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "content": {
    }
}

Send beep command

Send beep command to the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Request Body schema: application/json
optional

Beep configuration (count and delay). If not provided, defaults (count = 1 and 500 ms delay) will be used.

count
required
integer <int32>
delayMs
required
integer <int32>

Responses

Request samples

Content type
application/json
"{\"count\": 1, \"delayMs\": 500}"

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Send host command

Send generic host command to the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Request Body schema: text/plain
optional

Generic payload for device command

string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Send service command

Send generic service command to the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Request Body schema: text/plain
optional

Generic payload for device command

string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Send firmware update command

Send firmware update command to the device with device id

path Parameters
device_id
required
string

Device ID

Request Body schema: application/json
optional

Firmware update payload for device command

uri
required
string
uriMacro
required
string
commandId
string or null

Responses

Request samples

Content type
application/json
{
  • "uri": "file:///C:/path/to/firmware.dfw",
  • "uriMacro": "file:///C:/path/to/macro.xml",
  • "commandId": "null"
}

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Send disable host commands

Send disable host commands to the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Send enable host commands

Send enable host commands to the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Send command

Send generic command to the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Send reset command

Send reset command to the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Send response for devices with two way communication to the device

Send response for devices with two way communication to the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Request Body schema: text/plain
optional

Generic payload for two way response

string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Disable response for devices with two way communication to the device

Disable response for devices with two way communication to the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Enable response for devices with two way communication to the device

Enable response for devices with two way communication to the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Send disable scanner command

Send disable scanner command to the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Send enable scanner command

Send enable scanner command to the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Get config

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Save Config

path Parameters
device_id
required
string

Device ID

Request Body schema: text/plain
optional
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Execute zip package

Execute zip package on the device with id {device_id}

path Parameters
device_id
required
string

Device ID

Request Body schema: text/plain
optional

Zip package path

string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Get health

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "content": {
    }
}

Get info

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "content": {
    }
}

Get stats

path Parameters
device_id
required
string

Device ID

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "content": {
    }
}

Upload Config File

path Parameters
device_id
required
string

Device ID

Request Body schema: text/plain
optional
string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "code": 0,
  • "commandId": "string",
  • "content": "string"
}

Get host id

Allows our clients to get host id, in case hostname doesn't work for them

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "hostId": "string"
}

Set host id

Allows our clients to specify host id, in case hostname doesn't work for them

Request Body schema: text/plain
required

Host id payload for set host id command

string

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "content": {
    }
}

Get info

Responses

Response samples

Content type
application/json
{
  • "message": "string",
  • "apiVersion": "string",
  • "content": {
    }
}