Wiki
Clone wikiNumera.LibrisAPI / dashboard.open
Home > API Reference Documentation > dashboard.open
dashboard.open
The dashboard.open action is used to listen to incoming calls (a fall was detected, or a user initiated call). If you are not using the Javascript SDK, you will have to initiate your own HTTP long-polling mechanism against the API using the subscription you receive from this call with the channel.poll action.
Input Parameters
| Property | Required | Description |
|---|---|---|
realm | yes | The realm that the devices belong to |
Output
A token and subscription id is returned. Both values are used to start an internal long polling request with channel.poll. For the dashboard, the token and id you receive back are the same value.
| Property | Description |
|---|---|
token | token id |
subscription id | the channel id you will need later |
Once you receive this information, you will then need to make your call to dashboard.refresh to get the current list of calls to use as a starting point for your dashboard, and then you will implement your channel.poll logic.
Possible Status Codes
| Status Code | Reason | Description |
|---|---|---|
1000 | NO_REALM_ACCESS | User has no access to this realm. Note that user needs a minimum Role of Agent_Supervisor |
1001 | NO_DASHBOARD_ACCESS | The user has no access to the dashboard service |
1002 | SUBSCRIPTION_FAILED | Unable to create a subscription |
Updated