Get the information of a status given.

v1.0.0

What

Obtain the information about the status of an object in the registry as a parameter.

Parameters

The endpoint accepts only the following parameter in the path:

code: (Mandatory) The code that identifies uniquely the status in the registry. Possible values are: assigned, reserved, allocated, available.

Result

The result is a JSON object with the following structure:

self: the URI to individual status.
name: the human readable name of the status.
code: the internal code of the status in the system.

Errors

a 422 Unprocessable Entity error if the code is not one of the available.

It will also return the API Global errors described in the API description.

Input

{
  "type": "object",
  "properties": {
    "code": {
      "type": "string",
      "enum": [
        "assigned",
        "reserved",
        "available",
        "allocated"
      ]
    }
  },
  "required": [
    "code"
  ],
  "additionalProperties": false
}

Output

{
  "type": "object",
  "description": "The Status information",
  "required": [
    "code",
    "name",
    "self"
  ],
  "properties": {
    "code": {
      "type": "string"
    },
    "name": {
      "type": "string"
    },
    "self": {
      "type": "string"
    }
  }
}