Skip to main content

ResponseStatus

Codifies responses following some creation, update or delete operation

statusstringrequired

Type of status

Possible values: [ok, error]

codeinteger

Same numbering and semantics as HTTP status codes

messagestring

Descriptive message for error statuses or a error status with the following possible values

  • INVALID_OCCUPANCY_GREATER_THAN_PHYSICAL_COUNTER_CAPACITY: Count can not exceed physical capacity of the given location.
  • INVALID_OCCUPANCY_LESS_THEN_SPECIFIC_COUNTERS_SUM: Count can not be less then the sum of specific facility's counters.
ResponseStatus
{
"status": "ok",
"code": 0,
"message": "string"
}