Set measurement system

📘

This feature is supported by HDL300, Dual HDL300, HDL310, HDL410 and HDX systems.

This tutorial shows how to set the measurement system for the room where Nureva® audio devices are located.

What can be controlled with the API?

• 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

admin role required

The Set room layout endpoint is restricted to the admin role. To access this endpoint, follow the Authorization tutorial to authenticate with an admin role and obtain YOUR_ADMIN_AUTHPARAMETERS which is required for the requests below.

Overview

1. Use the Get room layout endpoint to get the current measurement system.
2. Use the Set room layout endpoint to make a request to change the measurement system.
3. Use the Get room layout endpoint to check that the change has been applied successfully.

Instructions

Step 1 - Make a request to get the current measurement system

Use the Get room layout endpoint:

1. Set the path with the IP address of the Nureva® device followed by /api/v1/room/layout.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. 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 <YOUR_ADMIN_AUTHPARAMETERS>' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1'

6. If the call is successful, an HTTP status code of 200 OK will be returned.
7. Check the value of the uiMeasurementSystem attribute. A value of "IMPERIAL" means that units such as feet will be used as the display units. A value of "METRIC" means that units such as meters will be used as the display units.

The example response below indicates that the current measurement system is imperial.

{
  "uiMeasurementSystem": "IMPERIAL"
}

Step 2 - Make a request to update the measurement system

Use the Set room layout endpoint:

1. Set the path with the IP address of the Nureva® device followed by /api/v1/room/layout.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. Update the headers to include Content-type as key and application/json as value.
6. Update the request body to send a JSON object with "uiMeasurementSystem":"METRIC" to change the measurement system to metric.

curl --request PATCH \
     --url https://10.0.0.1/api/v1/room/layout \
     --header 'Authorization: Nureva <YOUR_ADMIN_AUTHPARAMETERS>' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1' \
     --header 'Content-type: application/json' \
     --data '{"uiMeasurementSystem":"METRIC"}'

7. Send the PATCH request.
8. If the call is successful, an HTTP status code of 200 OK will be returned.

Step 3 - Check that the change has been applied successfully

Use the Get room layout endpoint:

1. Set the path with the IP address of the Nureva® device followed by /api/v1/room/layout.
2. Update the headers to include Authorization as key and the value being Nureva followed by the authParameters received from the login endpoint.
3. Update the headers to include Nureva-Client-Id as key and integration_app_name as the value.
4. Update the headers to include Nureva-Client-Version as key and 0.0.1 as the value.
5. 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 <YOUR_ADMIN_AUTHPARAMETERS>' \
     --header 'Nureva-Client-Id: integration_app_name' \
     --header 'Nureva-Client-Version: 0.0.1'

6. If the call is successful, an HTTP status code of 200 OK will be returned.
7. Check the value of the uiMeasurementSystem attribute.

The example response below indicates that the change of the measurement system to "METRIC" was successfully applied.

{
  "uiMeasurementSystem": "METRIC"
}

✅

Tutorial complete!

You now know how to get the room layout information.