Site Configuration API

Fetch All Permissions

This operation is used to fetch list of permissions available in the database except special permissions.

Parameters

Base URL: /getPermissions

Request Type: GET

Name	Type	Mandatory	Description
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.

Note that ALL the parameters of the specified template must be present in the request.

API Sample

Happy Scenario

http://192.168.1.161:8080/PresentationServices/getPermissions?userId=QA_1&token=d38bad16-e48a-4580-b5b6-993124ce638c

Result

{ - data: [1]

- 0: {

}

-statusFact:

{

success: true

}

Create Role

This operation is used to add Roles into database as per selected organization.

Parameters

Base URL: /organizations/{organization}/role/createRole

Request Type: POST

Name	Type	Mandatory	Description
{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.
roleName	String	Yes	Role Name which needs to be created.

Note that ALL the parameters of the specified template must be present in the request.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/QA_Organization_A/role/deleteRole ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{ - data:

{ id: 54

organizationId: "QA_Organization_A"

}

-statusFact:

{

success: true

}

Not enough Permissions

In the case userId doesn't have 'modify_role' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Edit Role

This operation is used to edit Role into database as per selected organization.

Parameters

Base URL: /organizations/{organization}/role/editRole

Request Type: POST

Name	Type	Mandatory	Description
{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.
roleName	String	Yes	Role Name of the role.
roleId	String	Yes	Role Id of the role to edit.

Note that ALL the parameters of the specified template must be present in the request.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/QA_Organization_A/role/deleteRole ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1 1

Result

{ - data:

{ id: 54

organizationId: "QA_Organization_A"

}

-statusFact:

{

success: true

}

Not enough Permissions

In the case userId doesn't have 'modify_role' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Delete Role

This operation is used to delete Role into database as per selected organization.

Parameters

Base URL: /organizations/{organization}/role/deleteRole

Request Type: POST

Name	Type	Mandatory	Description
{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.
roleName	String	Yes	Role Name which needs to be created.

Note that ALL the parameters of the specified template must be present in the request.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/QA_Organization_A/role/deleteRole ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'delete_role' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Roles With Permissions

This operation is used to fetch all roles associated with a particular organization along with their associated privileges.

Parameters

Base URL: /organizations/{organization}/rolesWithPermissions

Request Type: GET

Name	Type	Mandatory	Description
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.
{organizationId}	String	Yes	The id of the Organization.

Note that ALL the parameters of the specified template must be present in the request.

Happy Scenario

http://192.168.1.161:8080/PresentationServices/organizations/UNC/rolesWithPermissions?token=d38bad16-e48a-4580-b5b6-993124ce638c&userId=QA_1

Result

{

- data:[1]

-0: {

id: "2"

-permissions: [1]

0:

{

}

-statusFact:

{

success: true

}

Not enough Permissions

In the case userId doesn't have 'modify_role' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Edit Roles With Permissions

This operation is used to update selected Privileges into database.

Parameters

Base URL: /organizations/{organization}/rolePermission/editRolesPermissions

Request Type: POST

Name	Type	Mandatory	Description
permissions	String	Yes	The permission list to update.
roleId	String	Yes	The role id to update
userId	String	Yes	The id of the logged in user.
token	String	Yes	Security Token obtained before.
organization	String	Yes	The id of the organization.

Note: 1 .ALL the parameters of the specified template must be present in the request.

2. Exception throws if tries to update with 'special' permission.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/UNC/rolePermission/editRolesPermissions?token=d38bad16-e48a-4580-b5b6-993124ce638c&userId=QA_1

Result

{"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'modify_role_permission' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Create Location(Room)

This operation is used to add Locations into database..

Parameters

Base URL: /organizations/workspaces/{workspace}/createOrUpdateRoom

Request Type: POST

Name	Type	Mandatory	Description
roomName	String	Yes	The room name to create.
roomId	String	Yes	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.

Note : 1) ALL the parameters of the specified template must be present in the request.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/workspaces/UNC/createOrUpdateRoom ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"data":{"workspaceId":"unc_nursery","id":"test_room","name":"Test New Room"},"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'modify_room' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Edit Location(Room)

This operation is used to update room into database for a particular facility.

Parameters

Base URL: /organizations/workspaces/{workspace}/createOrUpdateRoom

Request Type: POST

Name	Type	Mandatory	Description
roomName	String	Yes	The room name to create.
roomId	String	Yes	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.

Note : 1) ALL the parameters of the specified template must be present in the request.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/workspaces/UNC/createOrUpdateRoom ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"data":{"workspaceId":"unc_nursery","id":"test_room","name":"Test New Room"},"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'modify_facilities' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Delete Location(Room)

This operation is used to delete locations from the database for a particular workspace.

Parameters

Base URL: /organizations/workspaces/{workspace}/deleteRoom

Request Type: POST

Name	Type	Mandatory	Description
workspace	String	Yes	The id of the workspace.
roomId	String	Yes	The room id to create
userId	String	Yes	The id of the logged in user.
token	String	Yes	Security Token obtained before.

Note : 1) ALL the parameters of the specified template must be present in the request.

2) Delete will not be allowed If the requested room is associated with any Patients.

3) Delete will not be allowed If the requested room is associated with any Devices.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/workspaces/UNC/deleteRoom ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'delete_room' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Fetch Locations(Room)

This operation is used to fetch Locations from database.

Parameters

Base URL: /organizations/{organization}/facilities/{facility}/workspaces/{workspace}/rooms

Request Type: GET

Name	Type	Mandatory	Description
{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.
{workspaceId}	String	Yes	The id of the workspace.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices//organizations/UNC/facilities/UNC/workspaces/unc_nursery}/rooms ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

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

Not enough Permissions

In the case userId doesn't have 'list_rooms' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Create Shift Durations

This operation is used to add Shift Durations into database for a particular facility.

Parameters

Base URL: /organizations/{organization}/facilities/{facility}/createOrUpdateShiftDurations

Request Type: POST

Name	Type	Mandatory	Description
{organizationId}	String	Yes	The id of the Organization.
{facilityId}	String	Yes	The id of the Facility.
userId	String	Yes	The id of the logged in user.
token	String	Yes	Security Token obtained before.
shiftDurations	String	Yes	Shift Durations of Facility to create.

Note : 1) ALL the parameters of the specified template must be present in the request.

2) Shift Durations should contain only whole numbers. e.g. 6,12.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/UNC/facilities/UNC/createOrUpdateShiftDurations ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"data":{"id":"UNC","nfcEnabled":true,"shifts":["9","12"],"nfcSelfModificationEnabled":false,"name":"UNC","barCodeEnabled":true,"organizationId":"UNC"},"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'modify_facilities' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Edit Shift Durations

This operation is used to update Shift Durations into database for a particular facility.

Parameters

Base URL: /organizations/{organization}/facilities/{facility}/createOrUpdateShiftDurations

Request Type: POST

Name	Type	Mandatory	Description
{organizationId}	String	Yes	The id of the Organization.
{facilityId}	String	Yes	The id of the Facility.
userId	String	Yes	The id of the logged in user.
token	String	Yes	Security Token obtained before.
shiftDurations	String	Yes	Shift Durations of Facility to update.

Note : 1) ALL the parameters of the specified template must be present in the request.

2) Shift Durations should contain only whole numbers. e.g. 6,12.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/UNC/facilities/UNC/createOrUpdateShiftDurations ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"data":{"id":"UNC","nfcEnabled":true,"shifts":["9","12"],"nfcSelfModificationEnabled":false,"name":"UNC","barCodeEnabled":true,"organizationId":"UNC"},"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'modify_facilities' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Delete Shift Durations

This operation is used to delete Shift Durations into database for a particular facility.

Parameters

Base URL: /organizations/{organization}/facilities/{facility}/deleteShiftDurations

Request Type: POST

Name	Type	Mandatory	Description
{organizationId}	String	Yes	The id of the Organization.
{facilityId}	String	Yes	The id of the Facility.
userId	String	Yes	The id of the logged in user.
token	String	Yes	Security Token obtained before.
shiftDurations	String	Yes	Shift Durations of Facility to delete.

Note : 1) ALL the parameters of the specified template must be present in the request.

2) Shift Durations should contain only whole numbers. e.g. 6,12.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/UNC/facilities/UNC/deleteShiftDurations ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'delete_facilities' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Fetch Shift Durations

This operation is used to fetch all Shift Durations from database or fetch shift durations for a given facility.

Parameters

Base URL:/organizations/{organization}/facilities/{facility}

Request Type: GET

Name	Type	Mandatory	Description
{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	No	The id of the Facility.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/UNC/facilities ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"data":[{"id":"NorthEastern","nfcEnabled":true,"shifts":["3","6","9"],"nfcSelfModificationEnabled":true,"name":"North Eastern","barCodeEnabled":true,"organizationId":"UNC"},{"id":"UNC","nfcEnabled":true,"nfcSelfModificationEnabled":false,"name":"UNC","barCodeEnabled":true,"organizationId":"UNC"},{"id":"Vidant","nfcEnabled":false,"shifts":["6","9"],"nfcSelfModificationEnabled":false,"name":"Vidant","barCodeEnabled":false,"organizationId":"UNC"}],"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'list_facilities' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

http://localhost:8080/PresentationServices/organizations/UNC/facilities/UNC ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"data":{"id":"UNC","nfcEnabled":false,"shifts":["6","9"],"nfcSelfModificationEnabled":false,"name":"UNC","barCodeEnabled":false,"organizationId":"UNC"},"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'read_facility' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Fetch All Programs

This operation is used to fetch all available survey programs from database.

Parameters

Base URL: /organizations/{organization}/programs

Request Type: GET

Name	Type	Mandatory	Description
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.
{organizationId}	String	Yes	The id of the Organization.

Note that ALL the parameters of the specified template must be present in the request.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/Another1/programs?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"data":[{"programId":1,"programLabel":"Catheter Associated Bloodstream Infections","programName":"Catheter Associated Bloodstream Infections"},{"programId":2,"programLabel":"Human Breast Milk in NICU","programName":"Human Breast Milk in NICU"}],"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'list_progarms' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Fetch Active Programs

This operation is used to fetch active survey programs from database for a given facility.

Parameters

Base URL: /organizations/{organization}/facilities/{facility}/programs

Request Type: GET

Name	Type	Mandatory	Description
{organization}	String	Yes	The id of the Organization.
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.
{facility}	String	Yes	The id of the Facility.

Note that ALL the parameters of the specified template must be present in the request.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/Another1/facilities/TestFacility/programs?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"data":[{"programId":1,"programLabel":"Catheter Associated Bloodstream Infections","programName":"Catheter Associated Bloodstream Infections"},{"programId":2,"programLabel":"Human Breast Milk in NICU","programName":"Human Breast Milk in NICU"}],"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'list_progarms' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Fetch All Forms

This operation is used to fetch all survey forms from database.

Parameters

Base URL: /organizations/{organization}/getForms

Request Type: GET

Name	Type	Mandatory	Description
{organization}	String	Yes	The id of the Organization.
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.

Note that ALL the parameters of the specified template must be present in the request.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/Another1/getForms?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"data":[{"formName":"New Line Report","surveyId":1},{"formName":"Maintenance Report","surveyId":2},{"formName":"Infection Report","surveyId":3},{"formName":"Breast Milk Report","surveyId":4},{"formName":"Patient Demographics","surveyId":5},{"formName":"Patient Discharge","surveyId":6},{"formName":"Patient Open Lines","surveyId":7},{"formName":"Form Open Lines","surveyId":8},{"formName":"Admission Questions","surveyId":9},{"formName":"Patient Final Discharge","surveyId":10},{"formName":"AUDIT","surveyId":11},{"formName":"MDQ","surveyId":12}],"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'list_programs' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Fetch Active Forms

This operation is used to fetch active survey forms from database for a given facility.

Parameters

Base URL: /organizations/{organization}/facilities/{facility}/getForms

Request Type: GET

Name	Type	Mandatory	Description
{organization}	String	Yes	The id of the Organization.
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.
{facility}	String	Yes	The id of the Facility.

Note that ALL the parameters of the specified template must be present in the request.

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/Another1/facilities/TestFacility/getForms?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Result

{"data":[{"formName":"Breast Milk Report","surveyId":4},{"formName":"Patient Demographics","surveyId":5},{"formName":"Patient Discharge","surveyId":6},{"formName":"Patient Final Discharge","surveyId":10}],"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'list_programs' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Programs With Forms

This operation is used to fetch all Programs with their associated forms.

Parameters

Base URL: /organizations/{organization}/programWithForms

Request Type: GET

Name	Type	Mandatory	Description
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.
{organizationId}	String	Yes	The id of the Organization.

Note that ALL the parameters of the specified template must be present in the request.

API Sample

Happy Scenario

http://192.168.1.161:8080/PresentationServices/organizations/UNC/programWithForms?token=d38bad16-e48a-4580-b5b6-993124ce638c&userId=QA_1

Result

{"data":[{"programId":"3","forms":[{"formName":"Patient Demographics","surveyId":5},{"formName":"AUDIT","surveyId":11}],"programName":"Patient Information"},{"programId":"2","forms":[{"formName":"Maintenance Report","surveyId":2},{"formName":"Patient Discharge","surveyId":6},{"formName":"MDQ","surveyId":12}],"programName":"Human Breast Milk in NICU"},{"programId":"1","forms":[{"formName":"New Line Report","surveyId":1},{"formName":"Infection Report","surveyId":3},{"formName":"Admission Questions","surveyId":9},{"formName":"Patient Final Discharge","surveyId":10}],"programName":"Catheter Associated Bloodstream Infections"},{"programId":"5","forms":[{"formName":"Breast Milk Report","surveyId":4}],"programName":"Open Lines"},{"programId":"4","forms":[{"formName":"Patient Open Lines","surveyId":7},{"formName":"Form Open Lines","surveyId":8}],"programName":"Discharge"}],"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'list_programs_forms' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Edit Forms

This operation is used to update selected forms into database for a given facility.

Parameters

Base URL: /organizations/{organization}/facilities/{facility}/editForms

Request Type: POST

Name	Type	Mandatory	Description
surveyIds	String	Yes	The survey id list to update.
facilityId	String	Yes	The id of the facility.
userId	String	Yes	The id of the logged in user.
token	String	Yes	Security Token obtained before.
organization	String	Yes	The id of the organization.

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/facilities/TestFacility/editForms?token=d38bad16-e48a-4580-b5b6-993124ce638c&userId=QA_1

Result

{"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'modify_forms' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions".