TM Forum · Schema

ErrorMessage

TelcoTelecommunicationsBSSOSSOpen APIsStandards
View JSON Schema on GitHub

JSON Schema

tm-forum-errormessage-schema.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "#/components/schemas/ErrorMessage",
  "title": "ErrorMessage",
  "allOf": [
    {
      "$ref": "#/components/schemas/Extensible"
    },
    {
      "type": "object",
      "description": "represents an Error",
      "properties": {
        "code": {
          "type": "string",
          "description": "error code"
        },
        "reason": {
          "type": "string",
          "description": "Explanation of the reason for the error"
        },
        "message": {
          "type": "string",
          "description": "More details and corrective actions related to the error"
        },
        "status": {
          "type": "string",
          "description": "error code extension like sys-ABC-2001"
        },
        "referenceError": {
          "type": "string",
          "description": "URI of documentation describing the error"
        }
      }
    }
  ],
  "discriminator": {
    "propertyName": "@type",
    "mapping": {
      "ErrorMessage": "#/components/schemas/ErrorMessage",
      "ProductOrderErrorMessage": "#/components/schemas/ProductOrderErrorMessage"
    }
  }
}