DWD-Warn API specification (3.0.5)

Download OpenAPI specification:Download

The dwd-warn service publishes new dwd weather warnings to our application

Authentication

API_Token

To use this API, you need an API-Token from the RBAC settings of your GroupAlarm organization. Place the token inside the HTTP-Header API-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security Scheme Type API Key
Header parameter name: API-TOKEN

Personal-Access-Token

To use this API, you need a Personal Access Token from your profile settings. Place the token inside the HTTP-Header Personal-Access-Token for every request, otherwise the API will return an "401 Unauthorized" error for your request.

Security Scheme Type API Key
Header parameter name: Personal-Access-Token

cells

GetCell

Get the cell with the passed cellID in path

path Parameters
cellID
required
string

id of a DWD warn cell

Responses

200

DWD warn cell with the requested id

400

Passed parameters in wrong format

500

Unexpected database error

get /cell/{cellID}
https://app.groupalarm.com/api/v1/cell/{cellID}

Response samples

Content type
application/json
Copy
Expand all Collapse all
{
  • "identifier_nuts": "string",
  • "identifier_sign": "string",
  • "name": "string",
  • "short_name": "string",
  • "warn_cell_id": "string"
}

GetCells

Get the best 20 cell matches for the passed search string

query Parameters
name
required
string

searched name

Responses

200

Matched warn cells

400

Passed query parameters in wrong format

500

Unexpected database error

get /cells
https://app.groupalarm.com/api/v1/cells

Response samples

Content type
application/json
Copy
Expand all Collapse all
[
  • {
    }
]