ODS recommends that consumers of ORD data baseline local Organisation Reference Data by downloading and parsing the monthly XML files available from TRUD and then connecting to the ORD interface of the ODS API Suite to retrieve updates using the sync endpoint. The demonstrator provides an example for developers to use as a starting point or reference (currently available as Python and .NET Core code).
The scope of demonstrators will be widened over time to include all current endpoints and any which are introduced in the future.
This software allows those customers who have interfaced with ODS XML to retrieve records from the ODS API Suite and an XML file which conforms to the ORD schema.
The demonstrator calls the sync endpoint of the ORD Interface of the ODS API Suite and passes in <LastChangeDate> and “_format=xml” in order to retrieve individual XML records. See an example. It then generates a schema compliant XML file which can be passed to the XSLT tools provided by ODS for further processing (such as XML to CSV or Primary Role Transform).
The header, manifest and CodeSystems content is held in a static file called HeaderCodeSystems.txt. The text from the file is written to the output file and the manifest is updated with Date/DateTime values based on sysdate; the RecordCount is populated to match the volumes returned.