APIs¶
The restful Application Programming Interfaces (API) support analysis ready data distribution through a frame work of microservices that retrieve, subset, and convert the data into user community specific Analysis Ready Data (ARD) formats.
Types¶
| Category | Description |
|---|---|
| Temporal | The APIs that return user community specific Analysis Ready Data (ARD) products. |
| Application | The APIs that return user specified reports and validation products that use the Temporal APIs. |
| System | The APIs that supply consistent configuration information across the APIs. |
API Response Times Vary
The response times vary between the different services and load a given time.
- As a general rule the higher the temporal level (Hourly vs a Climatology) and the greater number of parameters requested will slightly slow down the API's response.
- The Application API's are the slowest to respond; they typically include multiple temporal data request that run simultaneously. Additionally, have more intensive back end processing, but they requests will complete in under a minute.
Errors¶
POWER microservice API uses conventional HTTP response codes to indicate the success or failure of an API request.
| Code | Explanation | Description |
|---|---|---|
| 200 | Success | The request was successful. |
| 422 | Validation Error | lists all syntax and parameter violations in the response. |
| 429 | Too Many Requests | Too Many Requests. |