GET /protocols/ips-luminaire/luminaires
FROM API REVISION 5.0
Here is a few example on how to use this resource :
/protocols/ips-luminaire/luminaires?$expand=*\u0026confirmed=true
→Returns the expanded list of all confirmed luminaires
/protocols/ips-luminaire/luminaires?$expand=*\u0026confirmed=false
→*Returns the expanded list of all unconfirmed luminaires *
/protocols/ips-luminaire/luminaires?$expand=*\u0026exclude=false\u0026application=2.02\u0026bootloader=8\u0026softDevice=1F
→Returns all luminaires having application version 2.02 and bootloaded equal to 8 and softDevice equal to 1F.
If exclude was true, the response would have been everything exception the one having those properties.
This list is possible to download in CSV format too.
You have to specify one of this two:
Used when you are operating a browser without access to the header parameter. This allows you to choose which encoding you want to use for the response:
All these resources can be used according what the resource allows.
The $select system query option allows clients to request a limited set of properties for each entity.
The value pass in the parameter can be:
If there is no value after the select query option, the parameter will be ignored. All the values that are not specified will not be printed in the response.
The $expand system query option specifies the related resources to be included in line with retrieved resources.
The value passed in the parameter can be:
The $expand system query option can be used with the $levels query option, to expand recursively.
If this parameter is not in the request, the Application/Json will be chosen by default.
There are multiple possible values (according the resource):
The first two are the most often used.
Cyclic navigation properties can be recursively expanded using the special $levels option. This query option is used in addition to the $expand query options.
The value of the $levels option is a positive integer to specify the number of levels to expand.
This query parameter is of type Boolean.
If true, only the confirmed luminaires will be returned.
If false only the unconfirmed luminaires.
If not specified, all luminaires will be returned.
Type: Float
This represents the application version of the luminaire.
Type: Integer
This represent the Bootloader version of the luminaire.
Type: String
This represents the softDevice version.
Type:Boolean
This query parameter will work only in combination with application, bootloader, and softDevice query parameter to reverse the search of criteria.
Example :
/protocols/ips-luminaire/luminaires?$expand=*\u0026application=2.02\u0026exclude=true
This will return all the Luminaires except those having the property application equal to 2.02.
Object Name: Luminaires
| Property Name | Type | Description | Method |
|---|---|---|---|
| Luminaires | Array<Luminaire> | This is an array of Luminaires | GET |
URL Example: https://0.0.0.0/api/rest/v1/protocols/ips-luminaire/luminaires
[
{
"href": "/api/rest/v1/protocols/ips-luminaire/luminaires/1",
"name": "1"
},
{
"href": "/api/rest/v1/protocols/ips-luminaire/luminaires/2",
"name": "2"
},
{
"href": "/api/rest/v1/protocols/ips-luminaire/luminaires/3",
"name": "3"
},
{
"href": "/api/rest/v1/protocols/ips-luminaire/luminaires/4",
"name": "4"
},
{
"href": "/api/rest/v1/protocols/ips-luminaire/luminaires/5",
"name": "5"
},
{
"href": "/api/rest/v1/protocols/ips-luminaire/luminaires/6",
"name": "6"
},
{
"href": "/api/rest/v1/protocols/ips-luminaire/luminaires/7",
"name": "7"
},
{
"href": "/api/rest/v1/protocols/ips-luminaire/luminaires/8",
"name": "8"
}
]
URL Example: https://0.0.0.0/api/rest/v1/protocols/ips-luminaire/luminaires
<?xml version="1.0" encoding="utf-8"?>
<Luminaires>
<Luminaire>
<Href>/api/rest/v1/protocols/ips-luminaire/luminaires/1</Href>
<Name>1</Name>
</Luminaire>
<Luminaire>
<Href>/api/rest/v1/protocols/ips-luminaire/luminaires/2</Href>
<Name>2</Name>
</Luminaire>
<Luminaire>
<Href>/api/rest/v1/protocols/ips-luminaire/luminaires/3</Href>
<Name>3</Name>
</Luminaire>
<Luminaire>
<Href>/api/rest/v1/protocols/ips-luminaire/luminaires/4</Href>
<Name>4</Name>
</Luminaire>
<Luminaire>
<Href>/api/rest/v1/protocols/ips-luminaire/luminaires/5</Href>
<Name>5</Name>
</Luminaire>
<Luminaire>
<Href>/api/rest/v1/protocols/ips-luminaire/luminaires/6</Href>
<Name>6</Name>
</Luminaire>
<Luminaire>
<Href>/api/rest/v1/protocols/ips-luminaire/luminaires/7</Href>
<Name>7</Name>
</Luminaire>
<Luminaire>
<Href>/api/rest/v1/protocols/ips-luminaire/luminaires/8</Href>
<Name>8</Name>
</Luminaire>
</Luminaires>