FOR OFFICIAL USE ONLY (FOUO) UNCLASSIFIED CONTROLLED INFORMATION (UCI)
UCI/FOUO may be distributed only after permission of the public information officer and the regional records access officer has granted and identified the recipient(s) and use of information. Mark conspicuously each part of an electronically transmitted message that contains UCI/FOUO information.

GET Alerts

Returns all alert notifications.

Request Information

https://511ny.org/api/v2/get/alerts

URI Parameters

URI Parameters
NameDescriptionTypeAdditional information
key

Developer Key

 string

Required
format

Valid values are 'xml' or 'json', default 'json'.

 string

Optional

Response Information

Resource Description


Resource Description
NameDescriptionType
Id

A unique identifier.

integer
Message

The alert details.

string
Notes

Additional alert details.

string
StartTime

The start time of the alert in Unix time. More information

integer
EndTime

The end time of the alert in Unix time. More information

integer
Regions

A list of regions affected.

list
HighImportance

Whether the alert is flagged as high importance.

boolean
SendNotification

Whether the alert is disseminated over communication channels (SMS, Email, IVR).

boolean

Response Formats

JSON

Sample: 
[
  {
    "Id": 88,
    "Message": "MOBILE QA TEST HIGH IMPORTANCE ALERT - STAGING",
    "Notes": "TESTING TESTING TESTING",
    "StartTime": 1624978980,
    "EndTime": 1625583720,
    "Regions": [
      "Adirondack Watertown Plattsburgh Area",
      "Capital Region Albany Saratoga Area",
      "Central Syracuse Utica Area",
      "Finger Lakes Rochester Area",
      "Hudson Valley Catskill Area",
      "Long Island Area",
      "New York City Area",
      "New York Statewide",
      "Niagara Buffalo Area",
      "Southern Tier Homell Elmira Binghamton Area"
    ],
    "HighImportance": true,
    "SendNotification": true
  }
]

XML

Sample: 
<AlertsList>
    <Alerts>
        <Id>88</Id>
        <Message>MOBILE QA TEST HIGH IMPORTANCE ALERT - STAGING</Message>
        <Notes>TESTING TESTING TESTING</Notes>
        <StartTime>1624978980</StartTime>
        <EndTime>1625583720</EndTime>
        <Regions>Adirondack Watertown Plattsburgh Area Capital Region Albany Saratoga Area Central Syracuse Utica Area Finger Lakes Rochester Area Hudson Valley Catskill Area Long Island Area New York City Area New York Statewide Niagara Buffalo Area Southern Tier Homell Elmira Binghamton Area</Regions>
        <HighImportance>true</HighImportance>
        <SendNotification>true</SendNotification>
    </Alerts>
</AlertsList>