Skip to content

API Versioning

We implement URL based versioning, as this tends to be the easiest scheme for clients to consume (i.e. because the API is directly part of the URL and no special headers are needed).

The API version is included into the URL as follows: (for SOAP) and (for HTTP).

Note: There is no "fallback" behaviour if the version number is excluded from the URL (i.e. 404 "Not Found" response will be returned if no version is given as part of the URL). This decision was made to avoid confusion over which version of the API is being executed.


Version Description Publish date
v1 Initial version 01/08/2017