Requesting Hazard Categories

To request the list of hazard categories configured in the system please use the route defined here:

get

Returns the full set of hazard category reference values (e.g. EVENT, NATURAL).

Authorizations

AuthorizationstringRequired

JWT access token obtained from POST /authorize. Tokens expire after 15 minutes.

Responses

200

Array of hazard categories.

application/json

category_idstringOptional

Unique category identifier.

Example: EVENT

category_namestringOptional

Human-readable category name.

Example: Event

403

Forbidden -- invalid or expired token.

text/plain

get/hazards/categories

GET /hazards/categories HTTP/1.1
Host: api-v2.disasteraware.com
Authorization: Bearer YOUR_SECRET_TOKEN
Accept: */*

[
  {
    "category_id": "EVENT",
    "category_name": "Event"
  }
]

See Authorizing Requests page to get your accessToken.

This request will return an array that contains all of the hazard categories. Each element in the array will have two properties:

Properties

Definitions

category_id

This is like the primary key for the hazard category. This is the value that will be found on the hazard object.

category_name

A human readable value for the category e.g. Event.

The following shapes are associated with each hazard category: