GET /protocols/ips-luminaire
FROM API REVISION 5.0
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.
To address the raw value of a primitive property, clients append a path segment containing the string $value to the property URL.
To use this query option you need to use the classic resource and add the element name you want to print followed by the query string name.
<span class="warning"><span class="glyphicon glyphicon-warning-sign" aria-hidden="true"> Be careful, the parameter query string is used in the URL and is not like other parameters.
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.
Object Name: IPSLuminaire
| Property Name | Type | Description | Method |
|---|---|---|---|
| GroupidConfirmed | Integer | Total count of confirmed luminaires by groupid. | GET |
| VlcIdConfirmed | Integer | Total count of confirmed luminaires by vlcID | GET |
| ProximityIdConfirmed | Integer | Total count of confirmed luminaires by proximityId | GET |
| TotalNumberOfLuminaire | Integer | Total count of luminaires | GET |
| FirmwareUpgradeStatus | String | Informs if a firmware upgrade is in progress Values:
|
GET |
| BleDongleStatus | String | This property will display multiple information about the BLE dongle:
|
GET |
| IsDonglePresent | Boolean | FROM API REVISION 6.0 True if the dongle is present on the controller ; false otherwise. |
GET |
| IsLatestDongleVersion | Boolean | FROM API REVISION 6.0 True if the dongle version is the last one ; false otherwise. |
GET |
| LatestDongleVersion | String | FROM API REVISION 6.0 This is the latest dongle version available. |
GET |
| Luminaires | Array<Luminaire> | This is an array of Luminaires | GET |
| UncommissionedLuminaires | Array<UncommissionedLuminaire> | This is an array of UncommissionedLuminaire object. |
GET |
| Firmware | Array<FirmwareType> | GET | |
| CommandHistory | Array<Command> | GET |
URL Example: https://0.0.0.0/api/rest/v1/protocols/ips-luminaire
{
"firmware": {
"href": "/api/rest/v1/protocols/ips-luminaire/firmware",
"name": "firmware"
},
"isDonglePresent": true,
"isLatestDongleVersion": true,
"luminaires": {
"href": "/api/rest/v1/protocols/ips-luminaire/luminaires",
"name": "luminaires"
},
"groupidConfirmed": 59,
"vlcIdConfirmed": 59,
"firmwareUpgradeStatus": "not in progress",
"latestDongleVersion": "1.6.1-141",
"proximityIdConfirmed": 59,
"commandHistory": {
"href": "/api/rest/v1/protocols/ips-luminaire/command-history",
"name": "commandHistory"
},
"uncommissionedLuminaires": {
"href": "/api/rest/v1/protocols/ips-luminaire/uncommissioned-luminaires",
"name": "uncommissionedLuminaires"
},
"bleDongleStatus": "1.6.1-141, link layer version: 3, BGAPI protocol version: 1, hardware: 3, bootloader crc: 61522 (0xf052)",
"totalNumberOfLuminaire": 64
}
URL Example: https://0.0.0.0/api/rest/v1/protocols/ips-luminaire
<?xml version="1.0" encoding="utf-8"?>
<IPSLuminaire>
<GroupidConfirmed>59</GroupidConfirmed>
<VlcIdConfirmed>59</VlcIdConfirmed>
<ProximityIdConfirmed>59</ProximityIdConfirmed>
<TotalNumberOfLuminaire>64</TotalNumberOfLuminaire>
<FirmwareUpgradeStatus>not in progress</FirmwareUpgradeStatus>
<BleDongleStatus>1.6.1-141, link layer version: 3, BGAPI protocol version: 1, hardware: 3, bootloader crc: 61522 (0xf052)</BleDongleStatus>
<IsDonglePresent>true</IsDonglePresent>
<IsLatestDongleVersion>true</IsLatestDongleVersion>
<LatestDongleVersion>1.6.1-141</LatestDongleVersion>
<Luminaires>
<Href>/api/rest/v1/protocols/ips-luminaire/luminaires</Href>
<Name>luminaires</Name>
</Luminaires>
<UncommissionedLuminaires>
<Href>/api/rest/v1/protocols/ips-luminaire/uncommissioned-luminaires</Href>
<Name>uncommissionedLuminaires</Name>
</UncommissionedLuminaires>
<Firmware>
<Href>/api/rest/v1/protocols/ips-luminaire/firmware</Href>
<Name>firmware</Name>
</Firmware>
<CommandHistory>
<Href>/api/rest/v1/protocols/ips-luminaire/command-history</Href>
<Name>commandHistory</Name>
</CommandHistory>
</IPSLuminaire>