You are viewing an old version of this page. View the current version.
Compare with Current
View Page History
« Previous
Version 7
Next »
Table of Contents
Register Device
Current Implementation
A device is registered to a user depending on the type of usage the user decided at login time: Normal usage or Guest usage. In the case of Normal usage, the device-user relation is always registered in the server.
Parameters
Base URL: /registerDevice
Parameters:
| Name | Type | Mandatory | Description |
|---|
| token | String | Yes | Security Token obtained before. |
| userId | String | Yes | The id of the logged in user. |
| deviceId | String | Yes | The id of the device where we want userId to be registered. |
| shiftLength | Int | No | The duration of the user's shift in hours. If this parameter is present, a timer will be set to automatically log out the user. |
API Sample
curl 'http://192.168.2.102:8080/PresentationServices/registerDevice?deviceId=596a1d880a22eb32&userId=poda&token=d2360c39-637b-41da-988d-f031db5affbb&_=1395133673256' -H 'Accept: application/json, text/javascript, */*; q=0.01' -H 'User-Agent: Mozilla/5.0 (Linux; Android 4.4.2; Nexus 5 Build/KOT49H) AppleWebKit/537.36 (KHTML, like Gecko) Version/4.0 Chrome/30.0.0.0 Mobile Safari/537.36' --compressed
{
"statusFact":{
"success":true
}
}
Fetch Devices By Workspace
This operation is used to fetch all available Devices with associated Assignments for a given workspace.
Parameters
Base URL: /organizations/{organization}/workspaces/{workspace}/getDevices
Request Type: GET
| | | |
|---|
| {organizationId} | String | Yes | The id of the Organization. |
| token | String | Yes | Security Token obtained before. |
| userId | String | Yes | The id of the logged in user. |
| {workspaceId} | String | Yes | The id of the Workspace. |
API Sample
Happy Scenario
http://localhost:8080/PresentationServices/organizations/UNC/workspaces/test_nursery/getDevices?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1
{"data":[{"workspaceId":"ne_nursery","assignment":"podg","model":"Nexus 5","status":"ACTIVE","stockNumber":4,"imei":"Cognitive-106","serialNumber":"04a4edd425230a17","macAddress":"cc:fa:00:ab:1e:bd"}],"statusFact":{"success":true}}
Not enough Permissions
In the case userId doesn't have 'list_devices' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".
Fetch Devices By Facility
This operation is used to fetch all available Devices with associated Assignments for a given facility.
Parameters
Base URL: /organizations/{organization}/facility/{facility}/getDevices
Request Type: GET
| | | |
|---|
| {organizationId} | String | Yes | The id of the Organization. |
| token | String | Yes | Security Token obtained before. |
| userId | String | Yes | The id of the logged in user. |
| {facilityId} | String | Yes | The id of the Facility. |
API Sample
Happy Scenario
http://localhost:8080/PresentationServices/organizations/UNC/facility/NorthEastern/getDevices?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1
{"data":[{"workspaceId":"ne_nursery","assignment":"podg","model":"Nexus 5","status":"ACTIVE","stockNumber":4,"imei":"Cognitive-106","serialNumber":"04a4edd425230a17","macAddress":"cc:fa:00:ab:1e:bd"}],"statusFact":{"success":true}}
Not enough Permissions
In the case userId doesn't have 'list_devices' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".
Fetch Devices By Organization
This operation is used to fetch all available Devices with associated Assignments for a given organization.
Parameters
Base URL: /organizations/{organization}/getDevices
Request Type: GET
| | | |
|---|
| {organizationId} | String | Yes | The id of the Organization. |
| token | String | Yes | Security Token obtained before. |
| userId | String | Yes | The id of the logged in user. |
| {workspaceId} | String | Yes | The id of the Workspace. |
API Sample
Happy Scenario
http://localhost:8080/PresentationServices/organizations/UNC/getDevices?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1
{"data":[{"workspaceId":"ne_nursery","assignment":"podg","model":"Nexus 5","status":"ACTIVE","stockNumber":4,"imei":"Cognitive-106","serialNumber":"04a4edd425230a17","macAddress":"cc:fa:00:ab:1e:bd"}],"statusFact":{"success":true}}
Not enough Permissions
In the case userId doesn't have 'list_devices' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".
Delete Device
This operation is used to delete devices and associated assignments from the database for a particular device id.
This Delete supports only soft delete that is just updates status to In-Active in Devices table.
Parameters
Base URL: /organizations/{organization}/deleteDevice
Request Type: POST
| | | |
|---|
| organization | String | Yes | The id of the organization. |
| userId | String | Yes | The id of the logged in user. |
| deviceId | String | Yes | The id of the device. |
| token | String | Yes | Security Token obtained before. |
| | | | |
Note : 1) ALL the parameters of the specified template must be present in the request.
API Sample
Happy Scenario
http://localhost:8080/PresentationServices/organizations/Another1/deleteDevice?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1
{"statusFact":{"success":true}}
Not enough Permissions
In the case userId doesn't have 'delete_devices' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".
Create or Update Device
This operation is used to add or update devices and associated device assignments.
Parameters
Base URL: /organizations/{organization}/workspaces/{workspace}/CreateOrUpdateDevices
Request Type: POST
| | | |
|---|
| organizationId | String | Yes | The id of the Organization. |
| roomId | String | No | The room id to create |
| userId | String | Yes | The id of the logged in user. |
| token | String | Yes | Security Token obtained before. |
| workspace | String | Yes | The id of the workspace. |
| deviceId | String | Yes | The id of the device. |
| macAddress | String | Yes | The mac address of device. |
| model | String | Yes | The model of device. |
| serialNum | String | Yes | The serial number of device. |
| status | String | Yes | The status of device. |
API Sample
Happy Scenario
http://localhost:8080/PresentationServices//organizations/UNC/workspaces/test_nursery/CreateOrUpdateDevices?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1
{"statusFact":{"success":true}}
Not enough Permissions
In the case userId doesn't have 'modify_devices' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".
Fetch Device History
This operation is used to fetch logged in device history from the database for a particular device id.
Parameters
Base URL: /organizations/{organization}/getDeviceHistory
Request Type: GET
| | | |
|---|
| organization | String | Yes | The id of the organization. |
| userId | String | Yes | The id of the logged in user. |
| deviceId | String | Yes | The id of the device. |
| token | String | Yes | Security Token obtained before. |
| | | | |
Note : 1) ALL the parameters of the specified template must be present in the request.
API Sample
Happy Scenario
http://localhost:8080/PresentationServices/organizations/UNC/getDeviceHistory?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1
{"data":[{"loginTime":"2015-01-12 23:18:28.0","userId":"chargenurse","deviceId":"Cognitive-104"},{"loginTime":"2015-01-13 08:01:07.0","userId":"chargenurse","deviceId":"Cognitive-104"}],"statusFact":{"success":true}}
Not enough Permissions
In the case userId doesn't have 'list_device_history' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".
0 Comments