Get measurement system
Only HDL410 systems support this feature.
This tutorial shows how to get the measurement system of the room where Nureva® audio devices are located.
What information is available?
- uiMeasurementSystem: The measurement system used for the units of all displayed lengths in the coverage map. This does not affect the units used in the API. Possible values are:
IMPERIAL
METRIC
Minimum role required: general
general
The Get Room Layout endpoint can be accessed with the general
role or any role of a higher level.
Overview
- Use the Get Room Layout endpoint to get the current measurement system.
- Check that the request was successful and parse the response.
Instructions
Step 1 - Send a request to get the current measurement system
Use the Get Room Layout Information endpoint to a make a request to get the room layout information for the room where the Nureva® audio conferencing system is connected:
- Set the path with the IP address of the Nureva® device followed by
/api/v1/room/layout
. - Update the headers to include
Authorization
as key and the value beingNureva
followed by theauthParameters
received from the login endpoint. - Update the headers to include
Nureva-Client-Id
as key andintegration_app_name
as the value. - Update the headers to include
Nureva-Client-Version
as key and0.0.1
as the value. - Send the GET request. The code sample below is a request to retrieve the measurement system information for the room of the device with the IP address of
10.0.0.1
.
curl --request GET \
--url https://10.0.0.1/api/v1/room/layout \
--header 'Authorization: Nureva Z2VuZXJhbDo=' \
--header 'Nureva-Client-Id: integration_app_name' \
--header 'Nureva-Client-Version: 0.0.1'
- If the call is successful, an HTTP status code of 200 OK will be returned.
Step 2 - Parse the response
The example response below indicates that the lengths in the coverage map are displayed in imperial units.
{
"uiMeasurementSystem": "IMPERIAL"
}
Tutorial complete!
You now know how to get the room layout information.
Updated 4 days ago