Response Codes
Netify datasets and APIs implement a multi-layered response model to clearly communicate request outcomes and error conditions.
HTTP Response Codes
All APIs and dataset downloads use standard HTTP status codes to indicate the result of a request.
| Code | Response | Description |
|---|---|---|
| 200 | OK | Request was successful |
| 400 | Bad Request | The client request was invalid |
| 401 | Unauthorized | The API key or credentials were invalid |
| 403 | Forbidden | The API key or credentials were valid, but access was not permitted |
| 404 | Not Found | The resource was not found |
| 405 | Method Not Allowed | The method is not supported by the API |
| 409 | Conflict | Resource already exists |
| 422 | Validation Error | Parameters sent in the request were invalid |
| 429 | Too Many Requests | Too many requests were sent to the server |
| 500 | Server Error | Server-side error (rare) |
Extended Error Information
In addition to HTTP status codes, API responses may include extended error details within the JSON payload. These fields provide additional context to help diagnose issues. Not all error responses include extended information. For example, rate-limiting responses (HTTP 429) may return only the HTTP status code.
Extended Error Example
{
"status_code": "403.000",
"status_message": "Subscription has expired."
}
Validation Error Responses
The APIs provide extended validation information in the response payload. When a validation error occurs (HTTP Response code 422), the status_fields object returns detailed validation information on each field.
Validation Example
{
"status_code": "422.000",
"status_message": "Validation error",
"status_fields": {
"key": [ "The application tag is invalid." ],
"label": [ "Label must be more than 2 characters." ]
}
}