Listing the settings of the waiting room feature¶
Send a GET request to the /waiting-rooms/feature endpoint.
Description¶
The List-Waiting-Room-Feature request allows the user to request the basic settings for the waiting room feature you have booked for the organisation.
Requirements¶
Values of the request: none
Objects: none
Request¶
To request the information for the waiting room feature, no additional information needs to be added to the path of the request.
The object provides the following information:
| Variable name | Description |
|---|---|
visible |
Shows if the waiting room feature is visible in the Myra App. |
enabled |
Shows if the waiting room feature is active and can be used by the user. |
limit |
The maximum number of possible waiting rooms. |
numberOfRooms |
The number of existing waiting rooms. |
Responses¶
The following responses are available:
| STATUS CODE | DESCRIPTION |
|---|---|
| 200 | The request has succeeded. |
| 400 | The request was unsuccessful. The request was invalid or information is missing. |
| 401 | The request has not succeeded because the user authentication was incorrect. |
| 403 | The request has not succeeded because the user does not have the right permissions. |