Search loading...

API Hub

Explore and Make use of Nationally Defined Messaging APIs

 

A003: Delete Professional Session

Status: Live

Description

Closes the Professional Session. Used to delete a Professional Session after it has been created using A001 & A002. Once deleted the associate Session ID will become invalid.

NOTE: The connected system MUST NOT close any of its sessions until it has finished using them, i.e. it must not close a session until all previous calls authorised by that session have returned.

Resource URL

Method URL Authentication
DELETE {Base URL}/v1/ProfessionalSession/{sessionKey} Session Token (Details)
  • {Base URL} (Dev1) = https://api.dev1.ers.ncrs.nhs.uk/ers-api

INPUT

Request Operation: Header

Field Name Value
XAPI_ASID The “Accredited System ID” issued to the third party
HTTP_X_SESSION_KEY The session key generated by the Create Session endpoint (A001)

Example Request Header

XAPI_ASID:200000000220
HTTP_X_SESSION_KEY:pro-xapi-session_5a399946-23c5-4543-8c4f-7eca38732a58

OUTPUT

Response: Success

If successful the response code 204 (No Content) is returned. This response has no body.

Note:

Consuming applications must have a valid session in order to access this endpoint. A session is initially created using the A001 – Create Professional Session and A002 – Professional Session Select Role endpoints.


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