GOgovernment-digital-service

Broadcast emergency alerts

Changed on
post/broadcast

Request

  • Base URL
    https://api.emergency-alerts.service.gov.uk/v2
  • URL
    https://api.emergency-alerts.service.gov.uk/v2/broadcast
  • Auth
    HTTP bearer

Request body application/cap+xml

identifierstring required
senderstring required
sentstring \d\d\d\d-\d\d-\d\dT\d\d:\d\d:\d\d[-,+]\d\d:\d\d required
status'Actual' | 'Exercise' | 'System' | 'Test' | 'Draft' required
msgType'Alert' | 'Update' | 'Cancel' | 'Ack' | 'Error' required
scope'Public' | 'Restricted' | 'Private' required
referencesstring

Required when cancelling an alert - provide extra comma-separated data points, such as 'sender', 'sent' timestamp or alert content ('description'), to ensure that the alert to be cancelled is uniquely identified (see 'Cancel Alert' example)

Example request

{
  "sent": "2024-11-15T15:32:43-01:00",
  "info": {
    "area": {
      "polygon": "53.10569,0.24453 53.10593,0.24430 53.10601,0.24375 53.10615,0.24349"
    }
  }
}

Response

CREATED

approved_atstring nullable
approved_by_idstring nullable
cancelled_atstring nullable
cap_eventstring
contentstring
created_atstring
durationstring nullable
finishes_atstring nullable
idstring
referencestring
service_idstring
starts_atstring nullable
statusstring
updated_atstring nullable

Changes

  • 58af30dd1fe9Revision changes
    • breaking

      added to the request property allOf list

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • breaking

      the response property became nullable for the status

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • warning

      removed the request property /

    • info

      the request property type was generalized from object to no type