Page Comparison

...

{
data: [
{
id: 1,
description: "",
name: "admin",
organizationId: "UNC"
},
{
id: 2,
description: "",
name: "pod",
organizationId: "UNC"
}
],
statusFact: {
success: true
}
}

List Facility's Workspaces

Current Implementation

Returns the list of all the Workspaces of a Facility has.

Parameters

Base URL: /organizations/{organizationId}/facilities/{facilityId}/workspaces
Parameters:

API Sample

Happy Path

http://192.168.2.109:8080/PresentationServices/organizations/UNC/facilities/UNC/workspaces?userId=sigal&token=7dcaad57-5552-495b-9aea-d5789bfabdce

{ "data" : [ { "facilityId" : "UNC",
"id" : "unc_adult",
"name" : "Adults"
},
{ "facilityId" : "UNC",
"id" : "unc_nursery",
"name" : "Nursery"
}
],
"statusFact" : { "success" : true }
}

Read Facility's Workspace

Current Implementation

Returns all the information of a particular Workspace within a Facility.

Parameters

Base URL: /organizations/{organizationId}/facilities/{facilityId}/workspaces/{workspaceId}
Parameters:

API Sample

Happy Path

http://192.168.2.109:8080/PresentationServices/organizations/UNC/facilities/UNC/workspaces/unc_nursery?userId=sigal&token=7dcaad57-5552-495b-9aea-d5789bfabdce

{ "data" : { "facilityId" : "UNC",
"id" : "unc_nursery",
"name" : "Nursery"
},
"statusFact" : { "success" : true }
}

List Workspace's Rooms

Current Implementation

Returns the list of all the Rooms of a Facility Workspace has.

Parameters

Base URL: /organizations/{organizationId}/facilities/{facilityId}/workspaces/{workspaceId}/rooms
Parameters:

API Sample

Happy Path

http://192.168.1.126:8080/PresentationServices/organizations/UNC/facilities/UNCfacilities/UNC/workspaces/unc_nursery/rooms?token=c0014590-c367-4117-9f55-94292996e02a&userId=superadmin

{ "data" : [ { "facilityIdworkspaceId" : "UNCunc_nursery",
"id" : "poda",
"name" : "Pod A"
},
{ "facilityIdworkspaceId" : "UNCunc_nursery",
"id" : "podb",
"name" : "Pod B"
},
{ "facilityIdworkspaceId" : "UNCunc_nursery",
"id" : "podc",
"name" : "Pod C"
},
{ "facilityIdworkspaceId" : "UNCunc_nursery",
"id" : "podd",
"name" : "Pod D"
},
{ "facilityIdworkspaceId" : "UNCunc_nursery",
"id" : "pode",
"name" : "Pod E"
},
{ "facilityIdworkspaceId" : "UNCunc_nursery",
"id" : "podf",
"name" : "Pod F"
},
{ "facilityIdworkspaceId" : "UNCunc_nursery",
"id" : "podg",
"name" : "Pod G"
}
],
"statusFact" : { "success" : true }
}

Read

...

Workspace's Room

Current Implementation

Returns all the information of a particular room Room within a FacilityWorkspace.

Parameters

Base URL: /organizations/{organizationId}/facilities/{facilityId}/workspaces/{workspaceId}/rooms/{roomId}
Parameters:

API Sample

Happy Path

http://192.168.1.126:8080/PresentationServices/organizations/UNC/facilities/UNC/workspaces/unc_nursery/rooms/poda?token=c0014590-c367-4117-9f55-94292996e02a&userId=superadmin

{ "data" : { "facilityId" : "UNCunc_nursery",
"id" : "poda",
"name" : "Pod A"
},
"statusFact" : { "success" : true }
}

...

http://192.168.1.126:8080/PresentationServices/organizations/UNC/facilities/UNC/workspaces/unc_nursery/rooms/podX?token=c0014590-c367-4117-9f55-94292996e02a&userId=superadmin

{ "statusFact" : { "failMessage" : "Error reading Room",
"success" : false
} }

User Registration

Current Implementation

This is a POST method. It persists a user in the database with a 'PENDING' status. Users with 'PENDING' status are not allowed to login into the application.

...

Parameters

Base URL: /users
Parameters:

API Sample

Happy Path

curl 'http://192.168.0.14:8080/PresentationServices/users' -H 'Accept: application/json, text/javascript, */*; q=0.01' -H 'Origin: file://' -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' -H 'Content-Type: application/x-www-form-urlencoded; charset=UTF-8' --data 'firstName=Esteban&lastName=Aliverti&username=eaa&email=esteban.aliverti%40cogmed.com&password=1234&passwordConfirm=1234&organization=UNC&facility=Vidant&role=1&tagId=&token=01b1b134-71e9-4fad-9ca2-45b254e134ab&temporalSession=true' --compressed

...

List possible Users Statuses

Current Implementation

Normally used to fill the 'Status' drop down for a User. It returns the list of all the statuses a User can has.

Parameters

Base URL: /userStatuses
Parameters:

API Sample

curl 'http://192.168.0.14:8080/PresentationServices/userStatuses?userId=sigal&token=8a4804ef-3301-4f89-a5a9-c3fed479d8c3&_=1400057312395' -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

{ "data" : [ { "value" : "ACTIVE" },
{ "value" : "PENDING" },
{ "value" : "SUSPENDED" },
{ "value" : "INACTIVE" }
],
"statusFact" : { "success" : true }
}

List Users

Current Implementation

Lists all the users in the application according to a series of filter parameters.

Parameters

Base URL: /users
Parameters:

API Sample

curl 'http://192.168.0.14:8080/PresentationServices/users?location=facility&locationId=UNC&status=ACTIVE&userId=sigal&token=8a4804ef-3301-4f89-a5a9-c3fed479d8c3&_=1400057312400' -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

{ "data" : [ { "email" : "e@e.com",
"facilityId" : "UNC",
"facilityName" : "UNC",
"firstName" : "e",
"id" : "354a7aae-ac06-4892-ac61-ce302351eb35",
"lastName" : "e",
"organizationId" : "UNC",
"organizationName" : "UNC",
"roleId" : 2,
"roleName" : "pod",
"status" : "ACTIVE",
"username" : "username-e",
"updateDate" : "2014-01-06 19:07:40.0",
"passwordSet":true, 
"tagIdSet":true, 
"pinSet":true
},
{ "facilityId" : "UNC",
"facilityName" : "UNC",
"id" : "chargenurse",
"organizationId" : "UNC",
"organizationName" : "UNC",
"roleId" : 1,
"roleName" : "admin",
"status" : "ACTIVE",
"username" : "username-charge",
"updateDate" : "2013-03-08 01:20:37.0",
"passwordSet":true, 
"tagIdSet":true, 
"pinSet":true
},
...
],
"statusFact" : { "success" : true }
}

Read User Information

Current Implementation

Returns the information related to a User.

Parameters

Base URL: /users/{requestedUserId}
Parameters:

API Sample

curl 'http://192.168.0.14:8080/PresentationServices/users/354a7aae-ac06-4892-ac61-ce302351eb35?userId=sigal&token=8a4804ef-3301-4f89-a5a9-c3fed479d8c3&_=1400057312409' -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

{
data: {
id: "354a7aae-ac06-4892-ac61-ce302351eb35",
lastName: "e",
facilityName: "UNC",
organizationName: "UNC",
status: "ACTIVE",
username: "eaa",
email: "e@e.com",
roleName: "pod",
organizationId: "UNC",
firstName: "e",
facilityId: "UNC",
updateDate: "2014-01-06 19:07:40.0",
roleId: 2,
passwordSet:true, 
tagIdSet:true, 
pinSet:true
},
statusFact: {
success: true
}
}

Update User Information

Current Implementation

This is a POST method. Modifies user information such as Status, Name, Last Name, Organization, Role, etc.

...

{ "data" : [ { "message" : "First name is mandatory" },
{ "message" : "Facility is mandatory" }
],
"statusFact" : { "failMessage" : "Validation errors found",
"success" : false
}
}

Parameters

Base URL: /users/{requestedUserId}
Parameters:

...

{ "data" : { "email" : "e@e.com",
"facilityId" : "UNC",
"facilityName" : "UNC",
"firstName" : "e",
"id" : "354a7aae-ac06-4892-ac61-ce302351eb35",
"username" : "e",
"lastName" : "e",
"organizationId" : "UNC",
"organizationName" : "UNC",
"roleId" : 2,
"roleName" : "pod",
"status" : "SUSPENDED",
"updateDate" : "Wed May 14 13:24:38 CEST 2014",
"passwordSet":true, 
"tagIdSet":true, 
"pinSet":true
},
"statusFact" : { "success" : true }
}

Delete User

Current Implementation

This is a DELETE method. Modifies user status to INACTIVE.

The final result is the same as using the Update User Information operation using INACTIVE as the new status.

Parameters

Base URL: /users/{requestedUserId}
Parameters:

API Sample

curl -X DELETE 'http://192.168.2.103:8080/PresentationServices/users/354a7aae-ac06-4892-ac61-ce302351eb35' -H 'Accept: application/json, text/javascript, */*; q=0.01' -H 'Origin: file://' -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' -H 'Content-Type: application/x-www-form-urlencoded; charset=UTF-8' --compressed

...

Check User's Attribute Availability

Current Implementation

This operation can be used to check whether a specific value for a specific attribute of a User is already taken by any other user.

...

In the cases where the specified attribute is not available, the result will contain a field called 'takenBy' which will contains the userId of the user having it.

Parameters

Base URL: /userAttributeAvailable/{attribute}
Parameters:

API Sample

Available attribute (email)

...