Search loading...


Explore and Make use of Nationally Defined Messaging APIs


API Testing

Guidance for testing against the DoS APIs

Use a Case ID of ‘TEST’ when sending test requests into the APIs

When making API requests for non-live purposes (i.e. not for actual delivery of healthcare services) you must use a test ID in your request.

The Case ID must be set to TEST

e.g. in the path for the JSON / POC API:

e.g. in the payload for the SOAP API / Web Service:

  • For SOAP requests, you should not include the CaseRef element unless essential within the context of the testing you are performing.

All content is available under the Open Government Licence v3.0, except where otherwise stated