Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

SOAP API Version 1.5 - Overview

An overview of the DoS SOAP API version 1.5

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

API Versions

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

v1.3

v1.4

Default Version

v1.3

Future Version

V1.5 is currently under development. The WSDL and the API will be accessible through our UAT site from early 2019 for development purposes. Whilst the WSDL does reflect the intended changes, it is not finalised and may be subject to further changes. The API is available but all functionality may not be available and/or tested.

Attempting to access the WSDL on any site other than UAT may return an incorrect version.

WSDL Documentation

You can view the WSDL for the SOAP API v1.5 here: Web Service v1.5 WSDL Documentation

Web Methods

The SOAP API provides the following methods:

Method Description
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://???.pathwaysdos.nhs.uk/app/api/webservices where ??? is replaced with the subdomain relating to the environment you are targeting.

CheckCapacitySummary

Type Description
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”)

ServiceDetailsById

Type Description
Request A service identifier - either ServiceId or OdsCode
Response A list of technical endpoint details (0 or more)

GetHospitalScores

Type Description
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)

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