Reference list API - Overview
This API provides controlled lists of information for reference purposes.
How this service is used with schema
This service is often used in combination with codedValue schema items.
Schemas which want to refer to a specific list within the reference API will use a format:
"ref:lr/deed/type"
More details are given in the common schema
List paths
The documents here will attempt to replace slashes with URL escapes when using the examples. You should keep the slashes in place, as they are a path, rather than a parameter
Yes
/ref/lr/application/deed/type
No
/ref/lr%2Fapplication%2Fdeed%2Ftype
Caching
Although the lists do change, they change infrequently. If you want to cache the data, then ETag headers are supplied in the responses. These can be used with If-None-Match in the request to determine if there are changes. A 200 response will be returned if there is more recent data, otherwise a 304 Not Modified response. It is suggested that a daily check be made for any changes.