Responses Reference
Complete reference for REST API response definitions including status codes, schemas, headers, and content types.
Response definitions describe what an API endpoint returns for different status codes. Document all possible responses to help API consumers handle them correctly.
Response Properties
| Property | Type | Description |
|---|---|---|
| statusCode | string | HTTP status code (e.g., 200, 404) |
| description | string | Response description |
| content | object | Content type and schema |
| headers | object | Response header definitions |
HTTP Status Codes
Response Content
| Property | Description |
|---|---|
| mediaType | Content type (application/json, text/plain, etc.) |
| schema | Response body schema (link to NeoArc schema) |
| examples | Example responses with names and values |
Response Headers
| Header | Description |
|---|---|
| X-RateLimit-Limit | Maximum requests allowed per window |
| X-RateLimit-Remaining | Requests remaining in current window |
| X-RateLimit-Reset | Unix timestamp when limit resets |
| X-Request-ID | Unique request identifier for debugging |
| Location | URL of created resource (201 responses) |
| ETag | Entity tag for caching |
| Last-Modified | Last modification timestamp |
Error Response Schema
| Property | Type | Description |
|---|---|---|
| code | string | Machine-readable error code |
| message | string | Human-readable error message |
| details | array | Additional error details or field errors |
| timestamp | string | ISO 8601 timestamp of error |
| path | string | Request path that caused the error |