Skip to content

OPS markquarantined

OPS: Device Mark Quarantined

This call should be made in order to indicate that the device is quarantined. Once in this state, the GEM system will return an error if an attendant/operator attempt to give the device to a user. It will not be usable until the markunquarantined API is called.

Because an attendant usually places a device into the quarantined state when it exhibits a problem, the GEM system tries to be very permissive as to when such a state can be set.

Endpoint: /api/v1/ops/device/:scanid/markquarantined

Verb: POST

Payload: None

Example Response: 

{
    "api_code": 0,
    "error": null
}

or

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

If an error occurred, the api_code will be one of the following:

  • ApiErrorInvalidURLFields
  • ApiErrorRequestStructureInvalid
  • ApiErrorGemServerError

If the api code is ApiErrorGemServerError, the error_code in the error structure provides more detail. See https://studio.wevr.com/wevr/projects/gem/gem-platform/-/wikis/GEM-Server-Codes for error codes contained therein.