cap.schema.json

{
  "$schema": "http://json-schema.org/draft-07/schema",
  "title": "CAP v1.2 JSON schema",
  "description": "JSON Schema for Common Alerting Protocol v1.2",
  "type": "object",
  "properties": {
    "identifier": {
      "type": "string"
    },
    "sender": {
      "type": "string",
      "pattern": "[^<&,\\s]"
    },
    "sent": {
      "type": "string",
      "format": "date-time"
    },
    "status": {
      "type": "string",
      "enum": [
        "Actual",
        "Exercise",
        "System",
        "Test"
      ]
    },
    "msgType": {
      "type": "string",
      "enum": [
        "Alert",
        "Update",
        "Cancel"
      ]
    },
    "source": {
      "type": "string"
    },
    "scope": {
      "type": "string",
      "enum": [
        "Public"
      ]
    },
    "restriction": {
      "type": "string"
    },
    "addresses": {
      "type": "string"
    },
    "code": {
      "type": "array",
      "items": {
        "type": "string"
      }
    },
    "note": {
      "type": "string"
    },
    "references": {
      "type": "string"
    },
    "incidents": {
      "type": "string"
    },
    "info": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "language": {
            "type": "string"
          },
          "category": {
            "type": "array",
            "minItems": 1,
            "items": {
              "type": "string",
              "enum": [
                "Geo",
                "Met",
                "Safety",
                "Rescue",
                "Fire",
                "Health",
                "Env",
                "Transport",
                "Infra",
                "CBRNE",
                "Other"
              ]
            }
          },
          "event": {
            "type": "string",
            "minLength": 1
          },
          "responseType": {
            "type": "array",
            "items": {
              "type": "string",
              "enum": [
                "Shelter",
                "Evacuate",
                "Prepare",
                "Execute",
                "Avoid",
                "Monitor",
                "Assess",
                "AllClear",
                "None"
              ]
            }
          },
          "urgency": {
            "type": "string",
            "enum": [
              "Immediate",
              "Expected",
              "Future",
              "Past",
              "Unknown"
            ]
          },
          "severity": {
            "type": "string",
            "enum": [
              "Extreme",
              "Severe",
              "Moderate",
              "Minor",
              "Unknown"
            ]
          },
          "certainty": {
            "type": "string",
            "enum": [
              "Observed",
              "Likely",
              "Possible",
              "Unlikely",
              "Unknown"
            ]
          },
          "audience": {
            "type": "string"
          },
          "eventCode": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "name": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              },
              "required": [
                "name",
                "value"
              ],
              "additionalProperties": false
            }
          },
          "effective": {
            "type": "string",
            "format": "date-time"
          },
          "onset": {
            "type": "string",
            "format": "date-time"
          },
          "expires": {
            "type": "string",
            "format": "date-time"
          },
          "senderName": {
            "type": "string"
          },
          "headline": {
            "type": "string",
            "minLength": 1
          },
          "description": {
            "type": "string",
            "minLength": 1
          },
          "instruction": {
            "type": "string",
            "minLength": 1
          },
          "web": {
            "type": "string",
            "format": "uri"
          },
          "contact": {
            "type": "string"
          },
          "parameter": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "valueName": {
                  "type": "string"
                },
                "value": {
                  "type": "string"
                }
              },
              "required": [
                "valueName",
                "value"
              ],
              "additionalProperties": false
            }
          },
          "resource": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "resourceDesc": {
                  "type": "string",
                  "minLength": 1
                },
                "mimeType": {
                  "type": "string",
                  "minLength": 1
                },
                "size": {
                  "type": "number"
                },
                "uri": {
                  "type": "string",
                  "format": "uri"
                },
                "drefUri": {
                  "type": "string"
                },
                "digest": {
                  "type": "string"
                }
              },
              "required": [
                "resourceDesc",
                "mimeType",
                "uri"
              ],
              "additionalProperties": false
            }
          },
          "area": {
            "type": "array",
            "items": {
              "type": "object",
              "properties": {
                "areaDesc": {
                  "type": "string",
                  "minLength": 1
                },
                "polygon": {
                  "type": "array",
                  "items": {
                    "type": "array",
                    "items": {
                      "anyOf": [
                        {
                          "type": "array",
                          "items": {
                            "anyOf": [
                              {
                                "type": "array",
                                "items": {
                                  "type": "number"
                                }
                              },
                              {
                                "type": "number"
                              }
                            ]
                          }
                        },
                        {
                          "type": "number"
                        }
                      ]
                    }
                  }
                },
                "circle": {
                  "type": "array",
                  "items": {
                    "type": "string"
                  }
                },
                "geocode": {
                  "type": "array",
                  "items": {
                    "type": "object",
                    "properties": {
                      "valueName": {
                        "type": "string"
                      },
                      "value": {
                        "type": "string"
                      }
                    },
                    "required": [
                      "valueName",
                      "value"
                    ],
                    "additionalProperties": false
                  }
                },
                "altitude": {
                  "type": "number"
                },
                "ceiling": {
                  "type": "number"
                }
              },
              "required": [
                "areaDesc"
              ],
              "additionalProperties": false
            }
          }
        },
        "required": [
          "category",
          "event",
          "urgency",
          "severity",
          "certainty"
        ],
        "additionalProperties": false
      }
    }
  },
  "required": [
    "identifier",
    "sender",
    "sent",
    "status",
    "msgType",
    "scope"
  ],
  "additionalProperties": false,
  "allOf": [
    {
      "if": {
        "properties": {
          "scope": {
            "const": "Restricted"
          }
        }
      },
      "then": {
        "required": [
          "restriction"
        ]
      }
    },
    {
      "if": {
        "properties": {
          "scope": {
            "const": "Private"
          }
        }
      },
      "then": {
        "required": [
          "addresses"
        ]
      }
    }
  ]
}