Skip to content

OPS: Inspect Onboard

OPS: Inspect Onboard

Returns all the data about the onboard area necessary for a UI to display a dashboard.

Endpoint: /api/v1/ops/inspect/onboard/:showid

Verb: GET

Payload: None

Example Response:

{
    "api_code": 0,
    "error": null,
    "onboard_area": {
        "slot_count": 2,
        "occupied_slots": [
            {
                "gem_group_id": 32,
                "slot_num": 1,
                "progress_state": "Onboard",
                "progress_state_time": "2025-03-03T11:04:51.219051-08:00",
                "signup_groups": [
                    {
                        "signup_group_num": 3707892503523324490,
                        "gem_users": [
                            {
                                "id": 187,
                                "scan_id": "U_QR-56f20283",
                                "device_id": 551,
                                "device_scan_id": "D_QR12_032",
                                "handle": "Karen",
                                "language": "zh-TW",
                                "user_progress_state": "Onboard",
                                "progress_state_start": "2025-03-03T11:04:13.250241-08:00",
                                "gem_group_id": 32,
                                "subgroup_id": 3707892503523324490,
                                "adhoc": false
                            },
                            {
                                "id": 188,
                                "scan_id": "U_QR-3d166c58",
                                "device_id": 532,
                                "device_scan_id": "D_QR12_013",
                                "handle": "Isabella",
                                "language": "fr-FR",
                                "user_progress_state": "Onboard",
                                "progress_state_start": "2025-03-03T11:04:16.255364-08:00",
                                "gem_group_id": 32,
                                "subgroup_id": 3707892503523324490,
                                "adhoc": false
                            },
                            {
                                "id": 189,
                                "scan_id": "U_QR-f3131353",
                                "device_id": 592,
                                "device_scan_id": "D_QR12_073",
                                "handle": "Virginia",
                                "language": "fr-FR",
                                "user_progress_state": "Onboard",
                                "progress_state_start": "2025-03-03T11:04:19.24621-08:00",
                                "gem_group_id": 32,
                                "subgroup_id": 3707892503523324490,
                                "adhoc": false
                            },
                            {
                                "id": 190,
                                "scan_id": "U_QR-8d925cdf",
                                "device_id": 553,
                                "device_scan_id": "D_QR12_034",
                                "handle": "Caitlin",
                                "language": "zh-CN",
                                "user_progress_state": "Onboard",
                                "progress_state_start": "2025-03-03T11:04:23.243542-08:00",
                                "gem_group_id": 32,
                                "subgroup_id": 3707892503523324490,
                                "adhoc": false
                            },
                            {
                                "id": 191,
                                "scan_id": "U_QR-8a433be7",
                                "device_id": 521,
                                "device_scan_id": "D_QR12_002",
                                "handle": "Judy",
                                "language": "de-DE",
                                "user_progress_state": "Onboard",
                                "progress_state_start": "2025-03-03T11:04:27.242505-08:00",
                                "gem_group_id": 32,
                                "subgroup_id": 3707892503523324490,
                                "adhoc": false
                            },
                            {
                                "id": 192,
                                "scan_id": "U_QR-7fe9b4ae",
                                "device_id": 558,
                                "device_scan_id": "D_QR12_039",
                                "handle": "Vincent",
                                "language": "fr-FR",
                                "user_progress_state": "Onboard",
                                "progress_state_start": "2025-03-03T11:04:30.749757-08:00",
                                "gem_group_id": 32,
                                "subgroup_id": 3707892503523324490,
                                "adhoc": false
                            },
                            {
                                "id": 193,
                                "scan_id": "U_QR-2fedcb45",
                                "device_id": 527,
                                "device_scan_id": "D_QR12_008",
                                "handle": "Amy",
                                "language": "fr-CA",
                                "user_progress_state": "Onboard",
                                "progress_state_start": "2025-03-03T11:04:35.75209-08:00",
                                "gem_group_id": 32,
                                "subgroup_id": 3707892503523324490,
                                "adhoc": false
                            }
                        ]
                    }
                ]
            }
        ],
        "queue": [
            {
                "signup_groups": [
                    {
                        "signup_group_num": 1448679902342786655,
                        "gem_users": [
                            {
                                "id": 207,
                                "scan_id": "U_QR-5727cfe1",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Charlotte",
                                "language": "en-US",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:04:33.287671-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 1448679902342786655,
                                "adhoc": false
                            },
                            {
                                "id": 208,
                                "scan_id": "U_QR-9978a32d",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Gary",
                                "language": "en-US",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:04:36.76886-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 1448679902342786655,
                                "adhoc": false
                            },
                            {
                                "id": 209,
                                "scan_id": "U_QR-80de300c",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Kathy",
                                "language": "de-DE",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:04:40.30337-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 1448679902342786655,
                                "adhoc": false
                            },
                            {
                                "id": 210,
                                "scan_id": "U_QR-fff25288",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Justin",
                                "language": "zh-TW",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:04:44.276408-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 1448679902342786655,
                                "adhoc": false
                            },
                            {
                                "id": 211,
                                "scan_id": "U_QR-d8a15417",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Carolyn",
                                "language": "zh-TW",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:04:48.790769-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 1448679902342786655,
                                "adhoc": false
                            },
                            {
                                "id": 212,
                                "scan_id": "U_QR-0bc0d56a",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Gregory",
                                "language": "en-US",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:04:52.781515-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 1448679902342786655,
                                "adhoc": false
                            }
                        ]
                    },
                    {
                        "signup_group_num": 4018948737034794603,
                        "gem_users": [
                            {
                                "id": 197,
                                "scan_id": "U_QR-7cf9f69e",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Elijah",
                                "language": "de-DE",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:02:20.300335-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 4018948737034794603,
                                "adhoc": false
                            },
                            {
                                "id": 198,
                                "scan_id": "U_QR-a043fa97",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Olivia",
                                "language": "en-US",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:02:25.411897-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 4018948737034794603,
                                "adhoc": false
                            },
                            {
                                "id": 199,
                                "scan_id": "U_QR-fd7a224e",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Sabrina",
                                "language": "en-US",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:02:28.283842-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 4018948737034794603,
                                "adhoc": false
                            },
                            {
                                "id": 200,
                                "scan_id": "U_QR-4b23ddb8",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Sarah",
                                "language": "de-DE",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:02:31.775941-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 4018948737034794603,
                                "adhoc": false
                            },
                            {
                                "id": 201,
                                "scan_id": "U_QR-fec0aaa3",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Kenneth",
                                "language": "fr-CA",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:02:35.293096-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 4018948737034794603,
                                "adhoc": false
                            },
                            {
                                "id": 202,
                                "scan_id": "U_QR-f7d1bddf",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Stacey",
                                "language": "en-US",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:02:39.292591-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 4018948737034794603,
                                "adhoc": false
                            },
                            {
                                "id": 203,
                                "scan_id": "U_QR-5204ab37",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Gabriel",
                                "language": "en-US",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:02:42.274306-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 4018948737034794603,
                                "adhoc": false
                            },
                            {
                                "id": 204,
                                "scan_id": "U_QR-4c94f9f3",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Christian",
                                "language": "en-US",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:02:46.289721-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 4018948737034794603,
                                "adhoc": false
                            }
                        ]
                    },
                    {
                        "signup_group_num": 8926122616816101951,
                        "gem_users": [
                            {
                                "id": 205,
                                "scan_id": "U_QR-0631c629",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Lisa",
                                "language": "fr-FR",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:02:49.79774-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 8926122616816101951,
                                "adhoc": false
                            },
                            {
                                "id": 206,
                                "scan_id": "U_QR-587b1a6c",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Amy",
                                "language": "en-US",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T11:02:55.299661-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 8926122616816101951,
                                "adhoc": false
                            }
                        ]
                    },
                    {
                        "signup_group_num": 9089238825671524883,
                        "gem_users": [
                            {
                                "id": 177,
                                "scan_id": "U_QR-d189ca7b",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Howard",
                                "language": "zh-TW",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T10:57:09.79983-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 9089238825671524883,
                                "adhoc": false
                            },
                            {
                                "id": 178,
                                "scan_id": "U_QR-ee925916",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Stephanie",
                                "language": "fr-CA",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T10:57:13.285364-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 9089238825671524883,
                                "adhoc": false
                            },
                            {
                                "id": 179,
                                "scan_id": "U_QR-765281bb",
                                "device_id": 0,
                                "device_scan_id": "",
                                "handle": "Anna",
                                "language": "de-DE",
                                "user_progress_state": "Queue",
                                "progress_state_start": "2025-03-03T10:57:20.297611-08:00",
                                "gem_group_id": 0,
                                "subgroup_id": 9089238825671524883,
                                "adhoc": false
                            }
                        ]
                    }
                ]
            }
        ]
    }
}

or

{
    "api_code": xxxx,
    "error": {
        "error_code": xxxxx,
        "error_message": "Erorr message",
        "error_detail": "Optional additional details about error",
        "suggestion": "Optional suggestion on how to resolve error",
        "callstack": "Optional debug callstack."
    }
}

See https://studio.wevr.com/wevr/projects/gem/gem-platform/-/wikis/GEM-API-Codes for error codes contained therein.

See https://studio.wevr.com/wevr/projects/gem/gem-platform/-/wikis/GEM-Server-Codes for error codes contained therein.