Page Comparison

Table of Contents

Fetch All Permissions

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

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

Expand

title	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.

...

API Sample

Happy Scenario

...

title	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

...

Table of Contents

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

Expand

title	Result

{ - data: [1]

- 0: {

...

...

access_forms"

}

-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.".

...

Create Role

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

Parameters

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

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

Expand

title	Result

{ "statusFact":{"success":true}- data:

{ id: 54

organizationId: "QA_Organization_A"

}

-statusFact:

{

success: true

}

Not enough Permissions

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

Roles With Permissions

Edit Role

This operation is used to

fetch all roles associated with a particular organization along with their associated privileges

edit Role into database as per selected organization.

Parameters

Base URL: /organizations/{organization}/

rolesWithPermissions

role/editRole

Request Type: POST

Name	Type	Mandatory	Description

token

{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.

{organizationId}

roleId

String

Yes

The id

Role Id of the

Organization

role to edit.

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

API Sample

Happy Scenario

http://

192.168.1.161

localhost:8080/PresentationServices/organizations

/UNC/rolesWithPermissions

/QA_Organization_A/role/deleteRole ?token=

d38bad16

e48a

4580

b5b6

993124ce638c

QA

Expand

title	Result

{

- data:

[1]

-0:

{

id:

"2"

54

pod0:

{

name

MyRole1"

-permissions: [1]

organizationId: "

read

QA_Organization_

user

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.".

Create Location(Room)

Delete Role

This operation is used

to add Shift Durations

to delete Role into database

for a particular facility

as per selected organization.

Parameters

Base URL: /organizations/{organization}/

facilities/{facility}/createOrUpdateShiftDurations

role/deleteRole

Request Type: POST

Name	Type	Mandatory	Description
{organizationId}	String	Yes	The id of the Organization.

{facilityId}

token

String

Yes

The id of the Facility

Security Token obtained before.
userId	String	Yes	The id of the logged in user.

token

roleName

String

Yes

Security Token obtained before. shiftDurationsStringYesShift Durations of Facility to create

Role Name which needs to be created.

Note

: 1)

that 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

QA_Organization_A/role/deleteRole ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Expand

title	Result

{"

"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

delete_

facilities

role' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Edit Location(Room)

This operation is used to update Shift Durations into database for a particular facility.to fetch all roles associated with a particular organization along with their associated privileges.

Parameters

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

Request Type: POSTGET

Name	Type	Mandatory	Description
{organizationId} token	String	YesThe	id of the OrganizationSecurity Token obtained before.
{facilityId} userId	String	Yes	The id of the Facilitylogged in user.
userId{organizationId}	String String	Yes 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)

Organization.

Note that 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

API Sample

Happy Scenario

http://localhost192.168.1.161:8080/PresentationServices/organizations/UNC/facilities/UNC/createOrUpdateShiftDurationsrolesWithPermissions?token=a578dbf4d38bad16-1800e48a-4a824580-be24b5b6-b212ba43b278993124ce638c&userId=AQA_pod11

Expand

title	Result

{

"data"

- data:[1]

-0: {

"

id

"

: "

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

2"

-permissions: [1]

0:

{

}

-statusFact:

{

success: true

}

Not enough Permissions

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

Edit Roles With Permissions

Delete Location(Room)

This operation is used

to delete Shift Durations

to update selected Privileges into database

for a particular facility.

.

Parameters

Base URL: /organizations/{organization}/

facilities/{facility}/deleteShiftDurations

rolePermission/editRolesPermissions

Request Type: POST

Name	Type	Mandatory	Description

{organizationId}

permissions

String

Yes

The

id of the Organization

permission list to update.

{facilityId}

roleId

String

Yes

The

id of the Facility.

role id to update
userIdStringYesThe id of the logged in user.
tokenStringYesSecurity Token obtained before. 

shiftDurations

organization

String

Yes

Shift Durations of Facility to delete

The id of the organization. 

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.

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

API Sample

Happy Scenario

http://localhost:8080/PresentationServices/organizations/UNC/

facilities

rolePermission/

UNC/deleteShiftDurations

editRolesPermissions?token=

a578dbf4

1800

4a82

be24

b212ba43b278

A

pod1

Expand

title	Result

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

Not enough Permissions

In the case userId doesn't have '

delete

modify_role_

facilities

permission' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Fetch

Create Location(Room)

This operation is used to fetch all Shift Durations from database or fetch shift durations for a given facilityto add Locations into database..

Parameters

Base URL: /organizations/workspaces/{organizationworkspace}/role/createRolecreateOrUpdateRoom

Request Type: POST

tokenSecurity Token obtained before.{organizationId} Facility

Name	Type	Mandatory	Description
{organizationId} roomName	String	Yes	The id of the Organizationroom name to create.
roomId	String	Yes	The room id to create
userId	String	Yes	The id of the logged in user.
token	String	No	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/facilitiescreateOrUpdateRoom ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Expand

title	Result

{"data":[{"idworkspaceId":"NorthEasternunc_nursery","nfcEnabledid":true,"shifts":["3"test_room","6","9"],"nfcSelfModificationEnabled":true,"name":"North EasternTest New Room"},"barCodeEnabledstatusFact":true,{"organizationIdsuccess":"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"}]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

Expand

title	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 'listmodify_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

Expand

title	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.".

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 :

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) Shift Durations should contain only whole numbers. e.g. 6,12.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/UNCworkspaces/facilities/UNC/createOrUpdateShiftDurationsdeleteRoom ?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Expand

title	Result

{"datastatusFact":{"id":"UNC","nfcEnabledsuccess":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

}}

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.".

Edit Shift Durations

Fetch Locations(Room)

This operation is used to update Shift Durations into database for a particular facilityto fetch Locations from database.

Parameters

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

Request Type: POSTGET

The id of the FacilitySecurity Token obtained beforeshiftDurations

Name	Type	Mandatory	Description
{organizationId}	String	Yes	The id of the Organization.{facilityId}
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.token
{facilityId}	String	Yes	The id of the Facility.
{workspaceId}	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/

The id of the workspace.

API Sample

Happy Scenario

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

Expand

title	Result

{"data":[{"idworkspaceId":"UNCunc_nursery","nfcEnabledid":true"poda","shiftsname":["9Pod A"},"12"]{"workspaceId":"unc_nursery","nfcSelfModificationEnabledid":false"podb","name":"UNCPod B"},{"barCodeEnabledworkspaceId":true"unc_nursery","organizationIdid":"UNCpodc"},"statusFactname":"Pod C"},{"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

Expand

title	Result

{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

Expand

title	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

Expand

title	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

Expand

title	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

Expand

title	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

Expand

title	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

Expand

title	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

Expand

title	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

Expand

title	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 '

delete

list_

facilities

programs' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Fetch

Shift Durations

Active Forms

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

Parameters

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

Request Type: POSTGET

Name	Type	Mandatory	Description
{organizationIdorganization}	String	Yes	The id of the Organization.
token	String	Yes	Security Token obtained before.
userId	String	Yes	The id of the logged in user.
{organizationIdfacility}	String	NoYes	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/UNCfacilities/TestFacility/facilitiesgetForms?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

http://localhost

Expand

title	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.".

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_forms' 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/facilities/UNC programWithForms?token=a578dbf4d38bad16-1800e48a-4a824580-be24b5b6-b212ba43b278&userId=A_pod1

Expand

title	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

Expand

title	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

993124ce638c&userId=QA_1

Expand

title	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_

progarms

programs_forms' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

Fetch Active Programs

Edit Forms

This operation is used to

fetch active survey programs from

update selected forms into database for a given facility.

Parameters

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

+programs

/editForms

Request Type:

GET

POST

Name	Type	Mandatory	Description

{organization}

surveyIds

String

Yes

The

id of the Organization

survey id list to update.

token

facilityId

String

Yes

Security Token obtained before

The id of the facility.
userId	String	Yes	The id of the logged in user.

{facility}


token	String	Yes	Security Token obtained before.
organization	String	Yes	The id of the

Facility

organization.

Note

that

: 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

+programs

a578dbf4

1800

4a82

be24

b212ba43b278

A

pod1

Expand

title	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

modify_

progarms

forms' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions

.

".

role id to update
userId	String	Yes	The id of the logged in user.
token	String	Yes	Security Token obtained before.

Page Comparison

Versions Compared

Old Version 29

New Version Current

Key

Fetch All Permissions

Parameters

API Sample

Happy Scenario

Create Role

Parameters

API Sample

Happy Scenario

Not enough Permissions

Edit Role

Parameters

Fetch All Permissions

Parameters

API Sample

Happy Scenario

Not enough Permissions

Create Role

Parameters

API Sample

Happy Scenario

Not enough Permissions

Roles With Permissions

Edit Role

Parameters

API Sample

Happy Scenario

Not enough Permissions

Delete Role

Parameters

API Sample

Happy Scenario

Not enough Permissions

Not enough Permissions

Roles With Permissions

Edit Location(Room)

Parameters

API Sample

API Sample

Happy Scenario

Not enough Permissions

Edit Roles With Permissions

Parameters

API Sample

Happy Scenario

Not enough Permissions

Create Location(Room)

Parameters

API Sample

Happy Scenario

Not enough Permissions

Edit Location(Room)

Parameters

API Sample

Happy Scenario

Not enough Permissions

Not enough Permissions

Create Shift Durations

Parameters

Delete Location(Room)

Parameters

API Sample

Happy Scenario

Not enough Permissions

Not enough Permissions

Fetch Locations(Room)

Parameters

API Sample

Happy Scenario

API Sample

Happy Scenario

Not enough Permissions

Delete Shift Durations

Parameters

API Sample

Happy Scenario