Skip to content

OPS markready

OPS: Device Mark Ready

This call should be made in order to indicate that a device has been manually processed and is ready to be assigned to a user. The specifics of the processing are up to the operations staff but they usually include the sterilization of the device and the replacement of batteries.

Once a device is assigned to a user, whether the application completes naturally or is terminated unnaturally before or after it starts, the expectation is that the device will be put into a "post experience" state which indicates that it must be processed. In this post experience state, it cannot be assigned to anyone else unless this API call is made. This is to ensure that devices are cleaned an prepared for the next user.

This API call is the only way a device can be freed up to be assigned to another user if it is in a "post expereience state".

This API call will return an error if the device has been quarantined. Quarantined devices must first be unquarantined before they can be marked as processed.

This API call will also return an error if the device is unrecognized (i.e. not found in the GEM database).

This API call does not actually communicate with the device, allowing for bulk processing of devices during off hours.

If the device is in a suit-up, onboarding, or in-experience state, this API call will silently succeed without doing anything.

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

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.