Responses

Standard HTTP Status Codes

200 OK

Generic success response indicating the request was processed successfully.

201 Created

The resource was successfully created. Typically includes the newly created resource in the response body and a Location header pointing to the new resource.

202 Accepted

The request has been accepted for processing, but processing is not complete. Often used for asynchronous operations where the request is queued or handed off to another system (e.g., JMS queue processing).

204 No Content

The request succeeded but there is no content to return in the response body.

Response Formats

A. Single Resource Response

When retrieving a single resource, the response body contains the resource directly:

{
  "id": "123",
  "name": "Example Resource",
  "createdAt": 1766554332720,
  // ... other resource fields
}

B. Multiple Resources Response

When retrieving a collection of resources, the response follows a standardized paginated format:

{
  "data": [
    {
      "id": "123",
      "name": "Resource 1"
    },
    {
      "id": "124",
      "name": "Resource 2"
    }
    // ... more resources
  ],
  "meta_data": {
    "total": 45,
    "page": 1,
    "pageSize": 10,
    "totalPages": 5,
    "hasNext": true,
    "hasPrevious": false
  }
}

meta_data object contains:

• total (integer): Total number of resources available
• page (integer): Current page number (1-indexed)
• pageSize (integer): Number of resources per page
• totalPages (integer): Total number of pages
• hasNext (boolean): Whether there is a next page
• has_previous (boolean): Whether there is a previous page

Notes

• All responses are in JSON format unless otherwise specified
• Error responses include a descriptive message in the response body
• Pagination parameters are typically passed as query parameters: ?page=1&page_size=10