The SOAP API
The SOAP API is the primary API used by NHS 111 services. It provides consumers with a curated search function, and access to technical endpoint information for services to aid with transfer of care for patients.
API Use Case
The SOAP API supports the following high-level use cases:
Find an appropriate list of services for a specific clinical need
Get technical endpoint information for a given service
Obtain capacity information for specified hospitals or wards
To allow for the release of new features there may be more than one supported version of the API available. Following the release of a new API, consumers are given time to make any required changes before moving to the new version. It is possible to use different versions by passing in the required version number in the request. Where no version number is passed in, the default version is used.
Current Supported Versions
You can view some WSDL-generated documentation for the SOAP API here: Web Service v1.3 WSDL Documentation
The SOAP API provides the following methods:
|CheckCapacitySummary||Perform a fully-ranked (curated) clinical search to find services appropriate for a clinical need|
|ServiceDetailsById||Retrieve technical endpoint details for a specific Service ID or ODS code|
|GetHospitalScores||Retrieve capacity data for a specific set of hospitals|
The path to the SOAP API is: https://webservice.directoryofservices.nhs.uk/app/api/webservices where webservice is replaced with a subdomain specific to the environment you are targeting.
You can grab the latest version (v1.3) of the WSDL from here: https://www.directoryofservices.nhs.uk/app/api/webservices?wsdl=1.3
|Request||A non-identifiable representation of a ‘clinical case’|
|Response||A curated, ordered set of service results (valid requests will always return some results - see “Catch All Results”)|
|Request||A service identifier - either ServiceId or OdsCode|
|Response||A list of technical endpoint details (0 or more)|
|Request||Username and password - no search parameters required|
|Response||ODS code and Overall Pressure Score (only services profiled with a Beds or ED capacity grid)|