The API can be called using a REST client such as Postman or by building a custom REST client.
Please note that the IP address for the API is dynamic and it is advised that firewalls are configured using the FQDN (Fully Qualified Domain Name) of the service – directory.spineservices.nhs.uk.
This Implementation Guide details the ODS ORD API, which is designed to be compatible with the Organisation Reference Data information standard (DCB0090). This API contains the full record from ODS.
Glossary and links
A glossary specific to the Health & Social Care Organisation Reference Data (HSCOrgRefData) XML schema can be found within Appendix 1 of the data item catalogue.
All supporting products relating to XML Organisation Data (including the XML Schema, Interactive Object Model and Technical Specification) can be found within these ODS pages.
Note that the ORD API returns data in JSON format by default. Users requiring XML need to append the HTTP parameter “_format=xml” to retrieve data formatted as XML.
For technical queries regarding the ODS API Suite, or general queries regarding ODS data, please contact firstname.lastname@example.org.
Last edited: 3 July 2019 2:14 pm