OPS: deboardgemuser

OPS: Deboard GEM User

This call should be made in order to remove a Gem usert from whatever state they may be in and put them back into a one of two states, based on the "requeue" parameter. If requeue is true, they will be placed back into the onboarding queue. The deboarded user will have a new subgroup created for them and they will become the only member, effectively becoming separated from their previous subgroup.

Endpoint: /api/v1/ops/deboard/gemuser

Verb: POST

Payload:

The request payload contains several optional field which allow you to choose how you wish to reference the user to be deboarded. One of them must be provided. If more than one is provided, only one will be used to select the user and the others will be ignored.

Type	Attribute	Required	Description
Bool	requeue	Yes	Specifies whether the deboarded user should be placed back in the onboard area queue. If this value is false, they will be placed into the general pool of usrs that have valid tickets but have not been scanned to enter the onboard area yet.
uint64	user_id	No	Specifies the ID of the GemUser record that is being deboarded
string	user_scan_id	No	Specifies the Scan ID of the GemUser record that is being deboarded
uint64	device_id	No	Specifies the ID of the Device that has been assigned to the user
string	device_scan_id	No	Specifies the Scan ID of the Device that is being deboarded

Example Response:

{
    "api_code": 0,
}

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.