Pagination

API endpoints that return large amounts of data will make use of pagination to restrict the size of a single response. When using an API that uses pagination the following applies:

1. Additional query parameters

The following additional query parameters may be passed to make use of pagination:

• pageLimit - an integer value that indicates the maximum number of data elements to include in the response
• nextPageToken - for every page subsequent to the first one, the next page token should be provided to indicate the starting position for the results.

For example:

GET {{regionalhost}}/organisation/users?pageLimit=10&nextPageToken=606ea7753a071700083f4993

2. Query Results

The query results will include the following fields:

• itemsCount - the number of items returned in this page
• nextPageToken - the next page token if there are remaining pages of data that match the query
• pageLimit - the pageLimit (as passed in through the query parameters, or as defaulted / constrained by the API)

For example:

{
  "result": 0,
  "message": "Success",
  "status": "success",
  "data": [...
          ],
  "itemsCount": 10,
  "nextPageToken": "607542ffdb7711000870ff0f",
  "pageLimit": 10
}

Failure Response

Normal HTTP failure responses may be received, and the application will also return the following status codes:

• 401 - If not authorised access to the API or resource
• 404 - If the specified resource does not exist.
• 400 or 409 - If some of the data provided to the API is not valid or missing.
• 422 - in the event of a business pre-condition or rule not being complied with.
• 500 - If Agyle time failed to process the request.

The body of the response will normally include the following:

In the event of missing or invalid API parameters, the API response will be a 400 / 409 response with a response body similar to:

{
    "status": "error",
    "message": "identifier (MISSING): Field is required, type (MISSING): Field is required",
    "code": "BadRequest",
    "result": "BadRequest"
}