Note: This page has not yet been converted to the new developer portal format. Please use Swagger to test this API.

Nixle

The Nixle Notification API is a part of /notifications/ API. It only adxds a new channel to publicMessage (see below). The response of the API remains the same.

GET /notifications - Response (Nixle Only)

{
  "publicMessages": {
    "nixleAlertMessage": {
      "event": "Mountain Rescue",
      "urgency": "Expected",
      "severity": "Moderate",
      "certainty": "Likely",
      "category": "Rescue",
      "expire": "8",
      "smsMessage": "Mandatory Security Training",
      "instructions": "There is a security training that we have to go through and security team needs proof that people take it. It’s a FedRAMP requirement.",
      "action": "create",
      "type": 2,
      "applyZipCodeToEventGroups": false,
      "community": {
        "contactName": "Ellie Pei",
        "contactEmail": "[email protected]",
        "contactDivision": "Development",
        "contactPhone": "123",
        "jurisdictionType": "some",
        "regionIds": [
          61289,
          61291
        ]
      },
      "eventGroups": [
        25000881
      ]
    }
  }
}

POST /notifications - Body (Nixle Only)

{
  "publicMessages": {
    "nixleAlertMessage": {
      "event": "Mountain Rescue",
      "urgency": "Expected",
      "severity": "Moderate",
      "certainty": "Likely",
      "category": "Rescue",
      "expire": "8",
      "smsMessage": "Mandatory Security Training",
      "instructions": "There is a security training that we have to go through and security team needs proof that people take it. It’s a FedRAMP requirement.",
      "action": "create",
      "type": 2,
      "applyZipCodeToEventGroups": false,
      "community": {
        "contactName": "Ellie Pei",
        "contactEmail": "[email protected]",
        "contactDivision": "Development",
        "contactPhone": "123",
        "jurisdictionType": "some",
        "regionIds": [
          61289,
          61291
        ]
      },
      "eventGroups": [
        25000881
      ]
    }
  }
}

Field Descriptions

Field	Data Type	Required	Description
category	string	y	The value should be one of the following case-sensitive categories: ◊ CBRNE ◊ Env ◊ Fire ◊ Geo ◊ Health ◊ Infra ◊ Met ◊ Other ◊ Rescue ◊ Safety ◊ Security ◊ Transport
event	string	y	Refer to the CAP Events section below. The event must be one of the selected categories.
urgency	string	y	The value should be one of the following case-sensitive urgencies: ◊ Expected ◊ Unknown ◊ Immediate ◊ Past ◊ Future
severity	string	y	The value should be one of the following case-sensitive severities: ◊ Moderate ◊ Unknown ◊ Extreme ◊ Minor ◊ Severe
certainty	string	y	The value should be one of the following case-sensitive certainties: ◊ Unknown ◊ Possible ◊ Observed ◊ Unlikely ◊ Likely
expire	string	y	The value should be 1-24 hours in string; i.e., “1”, “2”, “3”, ..., “24”.
smsMessage	string	y
instructions	string	n
action	string	y	The value should only be Create, where the Update and Cancel actions will be supported in a future release. ◊ create
type	int	y	The value should be one of the following types: ◊ 2-Alert ◊ 3-Advisory ◊ 5-Community
applyZipCodeToEventGroups	boolean	n	If both 'community' and 'eventGroups' have values, the fields 'applyZipCodeToEventGroups' could be true; otherwise it should always be false..
contactName	string	n
contactEmail	string	n
contactDivision	string	n
contactPhone	string	n	◊ The phone number must be numeric. ◊ The length can only be 3 or 10.
jurisdictionType	string	n	The value should be one of the following two case-sensitive types: ◊ all ◊ some
regionIds	int[]	n	The value should be an array of the “id” returned from GET /nixleRegionIds/{organizationId}
eventGroups	int[]	n	The value should be an array of the ‘id” returned from GET /nixleEventGroups/{organizationId}

NOTE: The “regionIds” and “eventGroups” need to be dynamically retrieved by the following two APIs:
◊ GET /nixleRegionIds/{organizationId}
◊ GET /nixle/EventGroups/{organizationId}

CAP Event Categories

Category	Event
Security	Missing Person
Amber Alert
Attempted Child Abduction
Missing Child
Traffic Emergency
Wanted Person
Suspect Wanted
Attempted Kidnapping
Kidnapping
Ongoing Investigation
Police Activity
Criminal Activity
Blue Alert
Silver Alert
Safety	Missing Person
Amber Alert
Attempted Child Abduction
Missing Child
Severe Weather Warning
Severe Weather Watch
Debris Removal
Road Closure
Power Outage
Gas Leak
Campus Lockdown
Campus Shooting
Weapons on Campus
School Hostage Situation
Evacuation Immediate
Met	NWS Rebroadcast
NOAA Rebroadcast
Severe Thunderstorm Warning
Severe Thunderstorm Statement
Winter Storm Watch
Winter Storm Warning
Blizzard Warning
Blizzard Watch
Tornado Warning
Tornado Watch
Flash Flood Warning
Flash Flood Watch
Tropical Storm Warning
Tropical Storm Watch
Hurricane Warning
Hurricane Watch
Flood Warning
Flood Watch
Excessive Heat Warning
Excessive Heat Watch
High Wind Warning
High Wind Watch
Dense Fog Advisory
Freeze Warning
Freeze Watch
Frost Advisory
Geo	Earthquake
Tsunami Warning
Tsunami Watch
Avalanche
Volcanic Eruption
Landslide
Mudslide
Wildfire
Geomagnetic Storm
Solar Radiation Storm
Radio Blackouts
Fire	Structure Fire
Forest Fire
Wildfire
Industrial Fire
Rescue Operation
Transport	Road Closure
Vehicle Accident
Travel Warning
Travel Emergency
Travel Derailment
Snow Emergency
Rescue	Mountain Rescue
Ground Search and Rescue
Urban Search and Rescue
Air-Sea Search and Rescue
Infra	Power Outage
Gas Leak
Utility Emergency
Telecommunications Emergency
Water Control Facilities
Buildings and Equipment
Health	Influenza Epidemic
Virus or Contagious Disease Outbreak
Foodborne Disease Outbreak
Boil Order
Env	Air Pollution
Soil Contamination
Water Pollution
Noise Pollution
Acid Rain
Toxic Waste
CBRNE	Chemical Emergency
Bioterrorism Attack
Nuclear Attack
High-Yield Explosive Threat
High-Yield Explosive Attack
Radiation Emergency
Mass Casualties
Nuclear Power Plant Warning
Other	Routine Monthly Test
Routine Weekly Test

GET /nixleEventGroups/{organizationId}

Description

Retrieve all event groups within an organization.

Return type

[nixleEventGroup][collection]

Parameters

Name	Data Type	Required?	Description
organizationId	long	y	The ID of the organization.

Response

HTTP Status	Response Body
200 OK	Get Nixle event groups successfully: [ { "id": 25000881, "groupName": "Developers" } ]
401 Unauthorized	◊ incorrect User ID or Password. { "status": 401, "message": "Invalid credentials: Get User failed" } ◊ Require REST API Access. { "status": 401, "message": "User does not have API permissions for this method" } ◊ Missing feature: { "status": 401, "message": "User does not have API permissions for this method" }

GET /nixleRegionIds/{organizationId}

Description

Retrieve city/town, county, or ZIP code within my jurisdiction.

Return type

[collection]

Parameters

Name	Data Type	Required?	Description
organizationId	long	y	The ID of the organization.

Response

HTTP Status	Response Body
200 OK	Get Nixle regionIDs successfully: { "cities": [ { "state": "CA", "id": 172527, "name": "Glendale" } ], "zipcodes": [ { "state": "CA", "id": 61289, "name": "90039" }, { "state": "CA", "id": 61242, "name": "91506" } ], "counties": [] }
401 Unauthorized	◊ incorrect User ID or Password. { "status": 401, "message": "Invalid credentials: Get User failed" } ◊ Require REST API Access. { "status": 401, "message": "User does not have API permissions for this method" } ◊ Missing feature: { "status": 401, "message": "User does not have API permissions for this method" }