HTTP headers

Find out about HTTP headers and REST client headers.

Page contents

HTTP response headers

Details of the API codes used in the responses.

API response codes
Code	Meaning
`200 OK`	Successful operation
`400 Bad request`	A required query parameter is missing from the request
`401 Unauthorised`	Valid authentication credentials have not been provided
`403 Forbidden`	Data has been requested from an unknown instance or where the application is not authorised
`404 Not Found`	A resource has been requested that does not exist
`406 Not Acceptable`	A media type other than JSON has been requested. A `LastChangeDate` exceeding 185 less than the current date will cause this error, or where the supplied Offset is not greater than 1

REST client headers

The HTTP Client (such as Postman) Headers provide the required url/queries to allow users to page through results, given the 1,000 record limit per display. For example, the below shows a query to return all GP Practices (Non Primary Role ID of RO76). This query returns 8,377 records, with the maximum 1,000 record limit on the display. The Postman Header details the 'total count' and 'returned records' but then also provides the 'next page' url/query:

Image of headers example Once the 'next page' url is queried and the next page of results returned, the Header will display the url for the 'previous page' as well as the 'next page', allowing users to tab through all 8,377 results.

Image of tab with all previous results

Last edited: 21 January 2021 12:42 pm