icarResponseMessageResource.json

{
  "description": "An RFC7807 compliant problem response for JSON APIs.",

  "type": "object",

  "properties": {
    "type": {
      "type": "string",
      "description": "Machine readable URI or code that defines the type of error or warning."
    },
    "severity": {
      "$ref": "../enums/icarBatchResultSeverityType.json",
      "description": "Distinguish errors, warnings, and informational messages."
    },
    "status": {
      "type": "integer",
      "description": "The HTTP status code applicable to this problem.",
      "format": "int32",
      "nullable": true
    },
    "title": {
      "type": "string",
      "description": "A short, human-readable summary of the problem that SHOULD NOT change from occurrence to occurrence of the problem, except for purposes of localization."
    },
    "detail": {
      "type": "string",
      "description": "A human-readable explanation specific to this occurrence of the problem. Like title, this field’s value can be localized."
    },
    "instance": {
      "type": "string",
      "description": "A URI reference or internal JSON document reference to the specific data item that caused the problem.",
      "nullable": true
    }
  }
}