Skip to main content

Sync endpoint

This page includes the sync endpoint description, parameters and examples.

Page contents

Endpoint

https://directory.spineservices.nhs.uk/ORD/2-0-0/sync?{search parameters}

Description

Returns a list of organisation records that have been modified since a specified date.

Parameters

Parameter Description
LastChangeDate Date
Date in the format YYYY-MM-DD. Note that the API will only return records that have been updated in the last 6 months. Please also refer to guidance for consumers who have built a dependency on LastChangeDate.
_format String
Can take xml, json, text/json, text/xml, application/json and application/xml as arguments. If this parameter is not supplied, the format will default to JSON.

Example

The following query returns summary information for one or more organisations where the LastChangeDate specified (15 March 2019) is greater than or equal to the LastChangeDate within the organisation records.

https://directory.spineservices.nhs.uk/ORD/2-0-0/sync?LastChangeDate=2020-08-15&_format=xml

Example extract of results:

<?xml version=’1.0′ encoding=’UTF-8′?>
<Organisations>
  <Organisation>
    <OrgLink>https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations/8HD87?_format=xml</OrgLink>
  </Organisation>
  <Organisation>
    <OrgLink>https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations/8HA83?_format=xml</OrgLink>
  </Organisation>
  <Organisation>
    <OrgLink>https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations/8HD96?_format=xml</OrgLink>
  </Organisation>
  <Organisation>
    <OrgLink>https://directory.spineservices.nhs.uk/ORD/2-0-0/organisations/8GY44?_format=xml</OrgLink>
  </Organisation>
</Organisations>

Last edited: 10 January 2022 3:12 pm