GET illumination

A lookup call to get all available illumination types, including their ID and description. The call will allow a single ID to be supplied in order to return the description. If no ID supplied, all illumination types are returned.

When accessed via a GET request this API method will return a list of all illumination types. By specifying a id parameter you can retrieve details about a specific illumination.

INPUT

As this method is accessed via a GET request there is no HTTP body so options can be specified via the URL.

id (optional) - string - a illumination code to restrict results to.

OUTPUT - JSON sample

If accessing GET /api/illumination?id=2 the following JSON would be returned:

{
    "data": [{
        "id": "2",
        "description": "Illuminated (front)"
    }]
}
        

A "data" element that contains an array of illuminations defined as follows:

id - string - the unique identifier used within SPACE to reference the illumination

description - string - a description of the illumination suitable for display to a user