Difference between revisions of "V2 API"
Jump to navigation
Jump to search
| Line 19: | Line 19: | ||
Endpoint: <code>GET /api/v2/GetRegion?regionId=<region></code> | Endpoint: <code>GET /api/v2/GetRegion?regionId=<region></code> | ||
| + | |||
| + | Example return value: | ||
| + | <pre>{ | ||
| + | "id": 1, | ||
| + | "name": "Snoqualmie Valley", | ||
| + | "timezone": "America/Los_Angeles", | ||
| + | "baseUrl": "https://floodzilla.com", | ||
| + | "defaultForecastGageList": [ | ||
| + | "USGS-SF17/USGS-NF10/USGS-MF11", | ||
| + | "USGS-38", | ||
| + | "USGS-22" | ||
| + | ] | ||
| + | }</pre> | ||
| + | |||
| + | Notes: | ||
| + | * Internally, all times are represented as UTC. Whenever a client displays a time/date, it must be converted to "Region Time" using the region timezone. | ||
Revision as of 18:09, 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>
Example return value:
{
"id": 1,
"name": "Snoqualmie Valley",
"timezone": "America/Los_Angeles",
"baseUrl": "https://floodzilla.com",
"defaultForecastGageList": [
"USGS-SF17/USGS-NF10/USGS-MF11",
"USGS-38",
"USGS-22"
]
}
Notes:
- Internally, all times are represented as UTC. Whenever a client displays a time/date, it must be converted to "Region Time" using the region timezone.
