Device API

Get Device #

Service URL: GET /devices/{deviceId}

Tokens:

deviceId – The id of the device to return

Response Body:

GetDeviceResponse –

device – IDevice – The requested device

Remarks:

Loads the device with the device Id.

Example Request:

ET: http://localhost:8080/WebRestApi/rest/devices/pos1@0001.enactor

Example Response:

{
    "@type": "getDeviceResponse",
    "device": {
        "@type": "device",
        "deviceId": "pos1@0001.enactor",
        "deviceName": "POS 1@ 0001",
        "deviceNotInUse": false,
        "deviceType": "POS",
        "hostName": "localhost",
        "locationId": {
            "@type": "locationKey",
            "id": "0001"
        },
        "dataSource": {
            "@type": "dataSource"
        },
        "lastUpdated": 1606127787675
    }
}

Contents
Go to Top