Versions Compared

Old Version 34

changes.mady.by.user Former user

Saved on

compared with

New Version Current

changes.mady.by.user Former user

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

 

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
tokenStringYesSecurity Token obtained before.
userIdStringYesThe 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
titleResult
{ - data: [1]
- 0:  {
name: "access_forms"
  }
  -statusFact: 
  {
success: true
  }
 }

 

 

Create Role

...

 

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

...

tokenStringYesSecurity Token obtained before.
userIdStringYesThe 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
titleResult
{ - data: [1]
- 0:  {

...

name: "

...

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

Edit Role

...

 

 

Create Role

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

Parameters

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

Request Type: POST

of the role. Role Id of the role to edit
Name
Type
Mandatory
Description
{organizationId} StringYesThe id of the Organization.
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
roleNameStringYesRole Name roleIdStringYeswhich 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_pod11
Expand
titleResult
{ - data: 
  { id: 54
name: "MyRole1"
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

Edit Role

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

Parameters

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

Request Type: POST

which needs to be created
Name
Type
Mandatory
Description
{organizationId} StringYesThe id of the Organization.
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
roleNameStringYesRole Name of the role. 
Note that
roleIdStringYesRole 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_pod11

Expand
titleResult
{ - data: 
  { id: 54
name: "MyRole1"
organizationId: "statusFact":{"success":true}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

  

Delete Role

This operation is used

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

to delete Role into database as per selected organization.

Parameters

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

rolesWithPermissions

deleteRole

Request Type:

GET

POST

Name
Type
Mandatory
Description
{organizationId} StringYesThe id of the Organization.
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
{organizationId}
roleName
 String
String
 YesThe id of the Organization.
YesRole 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://

192.168.1.161

localhost:8080/PresentationServices/organizations/

UNC/rolesWithPermissions

QA_Organization_A/role/deleteRole?token=

d38bad16

a578dbf4-

e48a

1800-

4580

4a82-

b5b6

be24-

993124ce638c

b212ba43b278&userId=

QA

A_

1

pod1

Expand
titleResult
{
- data:[1]
  -0: {
id: "2"
name: "pod"
 -permissions: [1]
0:  
{
name: "read_user"
}
}
  -statusFact: 
  {
success: true
  }
 }
 
"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have '

modify

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

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

Parameters

Base URL: /organizations/{organization}/

rolePermission/editRolesPermissions

rolesWithPermissions

Request Type:

POST

GET

Name
Type
Mandatory
Description
permissionsroleIdStringYesThe role id to update
tokenStringYes
The permission list to update.
Security Token obtained before.
userIdStringYesThe id of the logged in user.
token
{organizationId}
StringorganizationStringYes
 String
YesSecurity Token obtained before. 
 YesThe id of the
organization
Organization.

 

Note
: 1 .
that 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

192.168.1.161:8080/PresentationServices/organizations/UNC/

rolePermission/editRolesPermissions

rolesWithPermissions?token=d38bad16-e48a-4580-b5b6-993124ce638c&userId=QA_1

Expand
titleResult
{
"statusFact":{"success":true}
- data:[1]
  -0: {
id: "2"
name: "pod"
 -permissions: [1]
0:  
{
name: "read_user"
}
}
  -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)


 

Edit Roles With Permissions 

 

 

 

This operation is used

to add Locations

to  update selected Privileges into database.

.

Parameters

Base URL: /organizations

/workspaces

/{

workspace

organization}/

createOrUpdateRoom

rolePermission/editRolesPermissions

Request Type: POST

Name
Type
Mandatory
Description
roomName 
permissionsStringYesThe
room name
permission list to
create
update.
roomId
roleIdStringYesThe
room
role id to
create
update
userIdStringYesThe id of the logged in user.
tokenStringYesSecurity Token obtained before. 
workspace
organizationStringYesThe id of the
workspace
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/

workspacesUNCcreateOrUpdateRooma578dbf418004a82be24b212ba43b278Apod1

1

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

 

Not enough Permissions

In the case userId doesn't have 'modify_role_

room

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

 

 

Edit 


Create Location(Room)

  

 

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

Parameters

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

Request Type: POST

Name
Type
Mandatory
Description
roomName StringYesThe room name to create.
roomIdStringYesThe room id to create
userIdStringYesThe id of the logged in user.
tokenStringYesSecurity Token obtained before. 
workspaceStringYesThe 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
titleResult
{"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_facilitiesroom' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

 

 

Delete 

Edit Location(Room)

 

  

This operation is used to delete locations from the to update room into database for a particular workspacefacility.

Parameters

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

Request Type: POST

Name
Type
Mandatory
Description
workspaceroomName StringYesThe id of the workspaceroom name to create.
roomIdStringYesThe room id to create
userIdStringYesThe id of the logged in user.
tokenStringYesSecurity Token obtained before.  
workspace String YesThe id of the workspace. 

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/deleteRoomcreateOrUpdateRoom?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Expand
titleResult

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

Not enough Permissions

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

 

 

Fetch Locations

Delete Location(Room) 

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

Parameters

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

Request Type: GETPOST

tokenSecurity Token obtained before.{facilityId} 
Name
Type
Mandatory
Description
{organizationId} workspaceStringYesThe id of the Organizationworkspace.
roomIdStringYesThe room id to create
userIdStringYesThe id of the logged in user.
tokenStringYesThe id of the Facility. 
{workspaceId}StringYesThe id of the workspace.

 

API
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/UNC/facilitiesworkspaces/UNC/workspaces/unc_nursery}/roomsdeleteRoom?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Expand
titleResult
{"datastatusFact":[{"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"},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} StringYesThe id of the Organization.
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
{facilityId} StringYesThe id of the Facility. 
{workspaceId}StringYesThe 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

Expand
titleResult
{"data":[{"workspaceId":"unc_nursery","id":"podgpoda","name":"Pod GA"},{"workspaceId":"unc_nursery","id":"test_roompodb","name":"Test RoomPod B"}],{"statusFactworkspaceId":{"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} StringYesThe id of the Organization.
{facilityId} StringYesThe id of the Facility.
userIdStringYesThe id of the logged in user.
tokenStringYesSecurity Token obtained before. 
shiftDurationsStringYesShift 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
titleResult
{"data":{"id":"UNC","nfcEnabled":true,"shifts":["9","12"],"nfcSelfModificationEnabled":false,"name":"UNC","barCodeEnabled":true,"organizationId":"UNC"},"statusFact":{"success":true}}"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 'modifylist_facilitiesrooms' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".

 

 

Edit

Create Shift Durations 

This operation is used to update 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} StringYesThe id of the Organization.
{facilityId} StringYesThe id of the Facility.
userIdStringYesThe id of the logged in user.
tokenStringYesSecurity Token obtained before. 
shiftDurationsStringYesShift Durations of Facility to updatecreate. 

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
titleResult
{"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

Edit Shift Durations 

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

Parameters

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

Request Type: POST

Name
Type
Mandatory
Description
{organizationId} StringYesThe id of the Organization.
{facilityId} StringYesThe id of the Facility.
userIdStringYesThe id of the logged in user.
tokenStringYesSecurity Token obtained before. 
shiftDurationsStringYesShift Durations of Facility to deleteupdate. 

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/deleteShiftDurationscreateOrUpdateShiftDurations?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Expand
titleResult
{"statusFactdata":{"success"id":"UNC","nfcEnabled":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
"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

tokenSecurity Token obtained beforeThe id of the Facility. 
Name
Type
Mandatory
Description
{organizationId} StringYesThe id of the Organization.
{facilityId} StringYesThe id of the Facility.
userIdStringYesThe id of the logged in user.{facilityId} StringNo
tokenStringYesSecurity Token obtained before. 
shiftDurationsStringYesShift 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
titleResult
{"datastatusFact":[{"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":[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} StringYesThe id of the Organization.
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
{facilityId} StringNoThe 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
titleResult
{"data":[{"id":"NorthEastern","nfcEnabled":true,"shifts":["3","6","9"],"nfcSelfModificationEnabled":falsetrue,"name":"VidantNorth Eastern","barCodeEnabled":falsetrue,"organizationId":"UNC"}],{"statusFactid":{"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
titleResult
{"data":{"id"UNC","nfcEnabled":true,"nfcSelfModificationEnabled":false,"name":"UNC","barCodeEnabled":true,"organizationId":"UNC"},{"id":"Vidant","nfcEnabled":false,"shifts":["6","9"],"nfcSelfModificationEnabled":false,"name":"UNCVidant","barCodeEnabled":false,"organizationId":"UNC"}],"statusFact":{"success":true}}

Not enough Permissions

In the case userId doesn't have 'readlist_facilityfacilities' 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
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
{organizationId} String YesThe 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
titleResult
{"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"}]

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

Expand
titleResult
{"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 '

list

read_

progarms

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

 

Fetch Active

Fetch All Programs

 

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

Parameters

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

Request Type: GET

facilityStringYes Facility
Name
Type
Mandatory
Description
{organization} StringYesThe id of the Organization.
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
{organizationId} String YesThe 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/facilities/TestFacility/programs?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1

Expand
titleResult
{"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

Active Programs

 

This operation is used to  fetch

all

active survey

forms

programs from database for a given facility.

Parameters

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

getForms

programs

Request Type: GET

Name
Type
Mandatory
Description
{organization} StringYesThe id of the Organization.
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
{facility}StringYesThe 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

Expand
titleResult
{"data

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
titleResult
{"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} StringYesThe id of the Organization.
tokenStringYesSecurity Token obtained before.
userIdStringYesThe 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
titleResult
{"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} StringYesThe id of the Organization.
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
{facility}StringYesThe 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

Expand
titleResult
{"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_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
tokenStringYesSecurity Token obtained before.
userIdStringYesThe id of the logged in user.
{organizationId} String YesThe 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

Expand
titleResult

{"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":

"Breast Milk Report"

"Patient Open Lines","surveyId":7},{"formName":"

Patient Demographics

Form Open Lines"

}

,

{

"

formName

surveyId":

"Patient Discharge"

8}],

{

"

formName

programName":"

Patient Final

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


 

Fetch Active

Edit Forms

 

 

 

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

Parameters

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

Request Type: GETPOST

tokenSecurity Token obtained before{facility} Facility
Name
Type
Mandatory
Description
{organization} surveyIdsStringYesThe id of the Organizationsurvey id list to update.
facilityIdStringYesThe id of the facility.
userIdStringYesThe id of the logged in user.user.
tokenStringYesSecurity Token obtained before. 
organizationStringYesThe id of the 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/getFormseditForms?token=a578dbf4d38bad16-1800e48a-4a824580-be24b5b6-b212ba43b278993124ce638c&userId=AQA_pod11

Expand
titleResult
{"data":[{"formName":"Breast Milk Report"},{"formName":"Patient Demographics"},{"formName":"Patient Discharge"},{"formName":"Patient Final Discharge"}],"statusFact":{"success":true}}

 

Not enough Permissions

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