API OPS: getdevices

OPS: Get Devices

This API call will list all the devices managed by the showrunner server. This is equivalent to the list of devices assigned to the onboard area that is assigned to the show(s) managed by the showrunner.

The call accepts an optional query string "state" which represents the device state to filter the response by. If multiple states are listed in a comma separated list, they are treated as an "OR" list where any of those states will be acceptable.

** Note: showrunner must be used for this

Endpoint:

    /api/v1/ops/getdevices
    /api/v1/ops/getdevices?state=InExperience
    /api/v1/ops/getdevices?state=Onboard,InExperience

Verb: GET

Payload:

Type	Attribute	Required	Description
number	show_id	Yes	Unique ID for corresponding show

Example Response:

{
    "devices": [
        {
            "id": 1,
            "mac_address": "DevOA1_1",
            "scan_id": "ScanOA1_1",
            "type": "PC",
            "version": "GemTest",
            "onboard_area_id": 2,
            "state": 0,
            "gem_user_id": 1,
            "gem_show_id": 0,
            "last_scan": "0000-12-31T16:07:02-07:52",
            "last_contact": "0000-12-31T16:07:02-07:52"
        },
        {
            "id": 2,
            "mac_address": "DevOA1_2",
            "scan_id": "ScanOA1_2",
            "type": "PC",
            "version": "GemTest",
            "onboard_area_id": 2,
            "state": 0,
            "gem_user_id": 1,
            "gem_show_id": 0,
            "last_scan": "0000-12-31T16:07:02-07:52",
            "last_contact": "0000-12-31T16:07:02-07:52"
        }
    ],
    "api_code": 0,
    "error": null
}