Difference between revisions of "V2 API"
Jump to navigation
Jump to search
(Created page with "== 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 === ==== GetRe...") |
|||
| Line 1: | Line 1: | ||
| − | == Overview == | + | ==Overview== |
These notes apply to all Floodzilla services. | These notes apply to all Floodzilla services. | ||
| Line 6: | Line 6: | ||
All date/time fields are in UTC. | All date/time fields are in UTC. | ||
| − | === General Client API === | + | ===General Client API=== |
| − | ==== GetRegion ==== | + | ====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: | 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: | ||
{| class="wikitable" | {| class="wikitable" | ||
|- | |- | ||
| − | | Region 1|| The main SVPA region. Should always be used in production mode. | + | |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. | + | |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> | + | Endpoint: <code>GET /api/v2/GetRegion?regionId=<region></code> |
Revision as of 18:05, 20 March 2023
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>
