V2 API

From floodzilla-wiki
Revision as of 18:05, 20 March 2023 by DaveSanderman (talk | contribs)
Jump to navigation Jump to search

Overview

These notes apply to all Floodzilla services.

All object payloads are in JSON format.

All date/time fields are in UTC.

General Client API

GetRegion

Returns all of the necessary information about a region. The client should hardcode (or, eventually, allow choosing from a list, maybe?) a region id. Currently available region IDs:

Region 1 The main SVPA region. Should always be used in production mode.
Region 17 A Testing region. There's nothing there, yet, but hopefully it will have testing data eventually.

Endpoint: GET /api/v2/GetRegion?regionId=<region>