Schema bulk-response-schema.json

Resolve referenced schemas (may reorder keys)

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Describes a response to a bulk activation request",
  "title": "Bulk activation response",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "code"
    ],
    "properties": {
      "id": {
        "description": "ID of a device to be activated",
        "type": "string",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
      },
      "code": {
        "description": "HTTP status code that would have resulted from an individual activation on this device",
        "type": "integer",
        "anyOf": [
          { "minimum": 200, "maximum": 299 },
          { "minimum": 400, "maximum": 599 }
        ]
      },
      "error": {
        "description": "Human readable message which is suitable for user interface display, and helpful to the user. Only included if 'code' indicates an error state",
        "type": "string"
      },
      "debug": {
        "description": "Debug information which may assist a programmer working with the API. Only included if 'code' indicates an error state",
        "type": ["null", "string"]
      }
    }
  }
}

​x
 
{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "description": "Describes a response to a bulk activation request",
  "title": "Bulk activation response",
  "type": "array",
  "items": {
    "type": "object",
    "required": [
      "id",
      "code"
    ],
    "properties": {
      "id": {
        "description": "ID of a device to be activated",
        "type": "string",
        "pattern": "^[0-9a-f]{8}-[0-9a-f]{4}-[1-5][0-9a-f]{3}-[89ab][0-9a-f]{3}-[0-9a-f]{12}$"
      },
      "code": {
        "description": "HTTP status code that would have resulted from an individual activation on this device",
        "type": "integer",
        "anyOf": [
          { "minimum": 200, "maximum": 299 },
          { "minimum": 400, "maximum": 599 }
        ]
      },
      "error": {
        "description": "Human readable message which is suitable for user interface display, and helpful to the user. Only included if 'code' indicates an error state",
        "type": "string"
      },
      "debug": {
        "description": "Debug information which may assist a programmer working with the API. Only included if 'code' indicates an error state",
        "type": ["null", "string"]
      }
    }
  }
}
​

Documentation built at 06:41:25 CDT on 2025-03-12.
(c) AMWA 2025. RAML/JSON licensed under Apache 2.0. Documentation licensed under CC BY-ND 4.0.