OASIS CAP

{
  "$schema": "http://json-schema.org/draft-07/schema#",
  "$id": "http://docs.oasis-open.org/emergency/cap/v1.2/CAP-v1.2.json",
  "title": "OASIS Common Alerting Protocol (CAP) 1.2",
  "description": "JSON Schema representation of OASIS CAP 1.2 for emergency alerting and public warnings",
  "type": "object",
  "required": ["alert"],
  "properties": {
    "alert": {
      "type": "object",
      "required": ["identifier", "sender", "sent", "status", "msgType", "scope"],
      "properties": {
        "identifier": {
          "type": "string",
          "description": "The identifier of the alert message"
        },
        "sender": {
          "type": "string",
          "description": "The identifier of the sender of the alert message"
        },
        "sent": {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}[\\-+\\.]\\d{2}:\\d{2}$",
          "description": "The time and date of the origination of the alert message (ISO 8601 with timezone offset)"
        },
        "status": {
          "type": "string",
          "enum": ["Actual", "Exercise", "System", "Test", "Draft"],
          "description": "The code denoting the appropriate handling of the alert message"
        },
        "msgType": {
          "type": "string",
          "enum": ["Alert", "Update", "Cancel", "Ack", "Error"],
          "description": "The code denoting the nature of the alert message"
        },
        "source": {
          "type": "string",
          "description": "The text identifying the source of the alert message"
        },
        "scope": {
          "type": "string",
          "enum": ["Public", "Restricted", "Private"],
          "description": "The code denoting the intended distribution of the alert message"
        },
        "restriction": {
          "type": "string",
          "description": "The text describing the rule for limiting distribution of the alert message (required if scope is 'Restricted')"
        },
        "addresses": {
          "type": "string",
          "description": "The group listing of intended recipients of the alert message (required if scope is 'Private')"
        },
        "code": {
          "type": "array",
          "items": {
            "type": "string"
          },
          "description": "Codes denoting special handling of the alert message"
        },
        "note": {
          "type": "string",
          "description": "The text describing the purpose or significance of the alert message"
        },
        "references": {
          "type": "string",
          "description": "The group listing identifying prior message(s) referenced by the alert message"
        },
        "incidents": {
          "type": "string",
          "description": "The group listing naming the referent incident(s) of the alert message"
        },
        "info": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/info"
          },
          "description": "Container for all component parts of the info sub-element of the alert message"
        }
      }
    }
  },
  "definitions": {
    "info": {
      "type": "object",
      "required": ["category", "event", "urgency", "severity", "certainty"],
      "properties": {
        "language": {
          "type": "string",
          "default": "en-US",
          "description": "The code denoting the language of the info sub-element (RFC 3066)"
        },
        "category": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": ["Geo", "Met", "Safety", "Security", "Rescue", "Fire", "Health", "Env", "Transport", "Infra", "CBRNE", "Other"]
          },
          "minItems": 1,
          "description": "The code denoting the category of the subject event"
        },
        "event": {
          "type": "string",
          "description": "The text denoting the type of the subject event"
        },
        "responseType": {
          "type": "array",
          "items": {
            "type": "string",
            "enum": ["Shelter", "Evacuate", "Prepare", "Execute", "Avoid", "Monitor", "Assess", "AllClear", "None"]
          },
          "description": "The code denoting the type of action recommended for the target audience"
        },
        "urgency": {
          "type": "string",
          "enum": ["Immediate", "Expected", "Future", "Past", "Unknown"],
          "description": "The code denoting the urgency of the subject event"
        },
        "severity": {
          "type": "string",
          "enum": ["Extreme", "Severe", "Moderate", "Minor", "Unknown"],
          "description": "The code denoting the severity of the subject event"
        },
        "certainty": {
          "type": "string",
          "enum": ["Observed", "Likely", "Possible", "Unlikely", "Unknown"],
          "description": "The code denoting the certainty of the subject event"
        },
        "audience": {
          "type": "string",
          "description": "The text describing the intended audience of the alert message"
        },
        "eventCode": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/keyValue"
          },
          "description": "A system-specific code identifying the event type"
        },
        "effective": {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}[\\-+\\.]\\d{2}:\\d{2}$",
          "description": "The effective time of the information of the info sub-element"
        },
        "onset": {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}[\\-+\\.]\\d{2}:\\d{2}$",
          "description": "The expected time of the beginning of the subject event"
        },
        "expires": {
          "type": "string",
          "pattern": "^\\d{4}-\\d{2}-\\d{2}T\\d{2}:\\d{2}:\\d{2}[\\-+\\.]\\d{2}:\\d{2}$",
          "description": "The expiry time of the information of the info sub-element"
        },
        "senderName": {
          "type": "string",
          "description": "The text naming the originator of the alert message"
        },
        "headline": {
          "type": "string",
          "description": "The text headline of the alert message"
        },
        "description": {
          "type": "string",
          "description": "The text describing the subject event"
        },
        "instruction": {
          "type": "string",
          "description": "The text describing the recommended action"
        },
        "web": {
          "type": "string",
          "format": "uri",
          "description": "The identifier of the hyperlink associating additional information with the alert message"
        },
        "contact": {
          "type": "string",
          "description": "The text describing the contact for follow-up and confirmation of the alert message"
        },
        "parameter": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/keyValue"
          },
          "description": "A system-specific additional parameter"
        },
        "resource": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/resource"
          },
          "description": "Container for all component parts of the resource sub-element"
        },
        "area": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/area"
          },
          "description": "Container for all component parts of the area sub-element"
        }
      }
    },
    "resource": {
      "type": "object",
      "required": ["resourceDesc", "mimeType"],
      "properties": {
        "resourceDesc": {
          "type": "string",
          "description": "The text describing the type and content of the resource"
        },
        "mimeType": {
          "type": "string",
          "description": "The identifier of the MIME content type and sub-type describing the resource (RFC 2046)"
        },
        "size": {
          "type": "integer",
          "minimum": 0,
          "description": "The integer indicating the size of the resource in bytes"
        },
        "uri": {
          "type": "string",
          "format": "uri",
          "description": "The identifier of the hyperlink for the resource"
        },
        "derefUri": {
          "type": "string",
          "description": "The base64-encoded data content of the resource"
        },
        "digest": {
          "type": "string",
          "description": "The code representing the digital digest of the resource (SHA-1)"
        }
      }
    },
    "area": {
      "type": "object",
      "required": ["areaDesc"],
      "properties": {
        "areaDesc": {
          "type": "string",
          "description": "The text describing the affected area"
        },
        "polygon": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^-?\\d+(\\.\\d+)?,-?\\d+(\\.\\d+)?( -?\\d+(\\.\\d+)?,-?\\d+(\\.\\d+)?)+$"
          },
          "description": "The paired values of points defining a polygon (WGS 84)"
        },
        "circle": {
          "type": "array",
          "items": {
            "type": "string",
            "pattern": "^-?\\d+(\\.\\d+)?,-?\\d+(\\.\\d+)? \\d+(\\.\\d+)?$"
          },
          "description": "The paired values of a point and radius defining a circle (WGS 84)"
        },
        "geocode": {
          "type": "array",
          "items": {
            "$ref": "#/definitions/keyValue"
          },
          "description": "A system-specific code identifying the affected area"
        },
        "altitude": {
          "type": "number",
          "description": "The specific or minimum altitude of the affected area (WGS 84 in meters)"
        },
        "ceiling": {
          "type": "number",
          "description": "The maximum altitude of the affected area (WGS 84 in meters)"
        }
      }
    },
    "keyValue": {
      "type": "object",
      "required": ["valueName", "value"],
      "properties": {
        "valueName": {
          "type": "string",
          "description": "The identifier of the type of value"
        },
        "value": {
          "type": "string",
          "description": "The value of the named type"
        }
      }
    }
  }
}

alert (object) [required]
├── identifier (string) [required]
├── sender (string) [required]
├── sent (datetime) [required]
├── status (enum) [required]
├── msgType (enum) [required]
├── source (string)
├── scope (enum) [required]
├── restriction (string) [conditional]
├── addresses (string) [conditional]
├── code (array of string)
├── note (string)
├── references (string)
├── incidents (string)
└── info (array of object)
    ├── language (string) [default: "en-US"]
    ├── category (array of enum) [required]
    ├── event (string) [required]
    ├── responseType (array of enum)
    ├── urgency (enum) [required]
    ├── severity (enum) [required]
    ├── certainty (enum) [required]
    ├── audience (string)
    ├── eventCode (array of keyValue)
    ├── effective (datetime)
    ├── onset (datetime)
    ├── expires (datetime)
    ├── senderName (string)
    ├── headline (string)
    ├── description (string)
    ├── instruction (string)
    ├── web (URI)
    ├── contact (string)
    ├── parameter (array of keyValue)
    ├── resource (array of object)
    │   ├── resourceDesc (string) [required]
    │   ├── mimeType (string) [required]
    │   ├── size (integer)
    │   ├── uri (URI)
    │   ├── derefUri (string)
    │   └── digest (string)
    └── area (array of object)
        ├── areaDesc (string) [required]
        ├── polygon (array of string)
        ├── circle (array of string)
        ├── geocode (array of keyValue)
        ├── altitude (number)
        └── ceiling (number)

{
  "alert": {
    "identifier": "TMD-EARTHQUAKE-2024-0215-001",
    "sender": "https://www.tmd.go.th",
    "sent": "2024-02-15T14:30:00+07:00",
    "status": "Actual",
    "msgType": "Alert",
    "scope": "Public",
    "source": "เครือข่ายสถานีเขย่าไหวอัตโนมัติ",
    "info": [
      {
        "language": "th-TH",
        "category": ["Geo"],
        "event": "แผ่นดินไหว",
        "urgency": "Immediate",
        "severity": "Severe",
        "certainty": "Observed",
        "headline": "แผ่นดินไหวขนาด 5.2 แมกนิจูด จ.เชียงใหม่",
        "description": "เกิดแผ่นดินไหวขนาด 5.2 ความลึก 12 กม. ศูนย์กลางบริเวณอ.แม่ริม จ.เชียงใหม่ รู้สึกสั่นไหวในพื้นที่ใกล้เคียง",
        "instruction": "หลบใต้โต๊ะแข็งแรง อย่าออกจากอาคารขณะสั่นไหว ระวังอาฟเตอร์ช็อก",
        "parameter": [
          {
            "valueName": "magnitude",
            "value": "5.2"
          },
          {
            "valueName": "depth",
            "value": "12"
          }
        ],
        "area": [
          {
            "areaDesc": "อำเภอแม่ริม จังหวัดเชียงใหม่",
            "circle": ["18.9264,98.8912 15.0"],
            "geocode": [
              {
                "valueName": "ISO3166-2",
                "value": "TH-50"
              }
            ]
          }
        ],
        "resource": [
          {
            "resourceDesc": "แผนที่ศูนย์กลางแผ่นดินไหว",
            "mimeType": "image/png",
            "uri": "https://www.tmd.go.th/images/eq-20240215.png"
          }
        ]
      }
    ]
  }
}