We have detected that you are using Internet Explorer to visit this website. Internet Explorer is now being phased out by Microsoft. As a result, NHS Digital no longer supports any version of Internet Explorer for our web-based products, as it involves considerable extra effort and expense, which cannot be justified from public funds. Some features on this site will not work. You should use a modern browser such as Edge, Chrome, Firefox, or Safari. If you have difficulty installing or accessing a different browser, contact your IT support team.
Find out about HTTP headers and REST client headers.
HTTP response headers
Details of the API codes used in the responses.
API response codes
400 Bad request
A required query parameter is missing from the request
Valid authentication credentials have not been provided
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:
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.