Versions Compared
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 |
---|---|---|---|
token | String | Yes | Security Token obtained before. |
userId | String | Yes | The id of the logged in user. |
API Sample
Happy Scenario
Expand | ||
---|---|---|
| ||
{ - 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 |
---|
...
...
token | String | Yes | Security Token obtained before. |
userId | String | Yes | The id of the logged in user. |
...
...
...
API Sample
Happy Scenario
...
192.168.1.161:8080/PresentationServices/
...
getPermissions?userId=QA_1&token=d38bad16-e48a-4580-b5b6-993124ce638c
Expand | ||
---|---|---|
| ||
{ - 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 edit Role to add Roles into database as per selected organization.
Parameters
Base URL: /organizations/{organization}/role/editRolecreateRole
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. |
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_pod11Expand | ||
---|---|---|
| ||
{ - 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
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 createdof 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_pod11
Expand | ||
---|---|---|
| ||
{ - data: { id: 54 name: "statusFact":{"success":true}MyRole1" 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
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}/
rolesWithPermissionsrole/deleteRole
Request Type:
GETPOST
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
192.168.1.161localhost:8080/PresentationServices/organizations
/UNC/rolesWithPermissions/QA_Organization_A/role/deleteRole?token=
d38bad16e48a4580b5b6993124ce638cQA1Expand | ||
---|---|---|
| ||
{ |
"statusFact":{"success":true}} |
Not enough Permissions
In the case userId doesn't have '
modifydelete_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/editRolesPermissionsrolesWithPermissions
Request Type:
POSTGET
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. |
API Sample
Happy Scenario
localhost192.168.1.161:8080/PresentationServices/organizations/UNC/
rolePermission/editRolesPermissionsrolesWithPermissions?token=d38bad16-e48a-4580-b5b6-993124ce638c&userId=QA_1
Expand | ||
---|---|---|
| ||
{ |
- 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 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. |
API Sample
Happy Scenario
Expand | ||
---|---|---|
| ||
{" |
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.".
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 | 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 | ||
---|---|---|
| ||
{"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 | String | Yes | The id of the workspaceroom 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.
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 | ||
---|---|---|
| ||
{" statusFactdata":{" success":true}} |
Not enough Permissions
In the case userId doesn't have 'delete_room' permission, the operationworkspaceId":"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.".
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
Name | Type | Mandatory | Description |
---|---|---|---|
{organizationId} workspace | String | Yes | The id of the Organizationworkspace. |
roomId | String | Yes | Security Token obtained before.The room id to create |
userId | String | Yes | The id of the logged in user. |
token | String | Yes | The id of the FacilitySecurity Token obtained before. |
{workspaceId} | String | Yes | The id of the workspace. |
API Sample
Happy Scenario
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/UNCworkspaces/facilities/UNC/workspaces/unc_nursery}/roomsdeleteRoom?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1
Expand | ||
---|---|---|
| ||
{"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"},{"workspaceId":"unc_nursery","id":"podg","name":"Pod G"},{"workspaceId":"unc_nursery","id":"test_room","name":"Test Room"}]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
Expand | ||
---|---|---|
| ||
{"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
Expand | ||
---|---|---|
| ||
{"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 'listmodify_roomsfacilities' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".
Create
Edit Shift Durations
This operation is used to add 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 createupdate. |
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 | ||
---|---|---|
| ||
{"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
Delete Shift Durations
This operation is used to update to delete Shift Durations into database for a particular facility.
Parameters
Base URL: /organizations/{organization}/facilities/{facility}/createOrUpdateShiftDurationsdeleteShiftDurations
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 updatedelete. |
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/createOrUpdateShiftDurationsdeleteShiftDurations?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1
Expand | ||
---|---|---|
| ||
{"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 'modifydelete_facilities' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".
Delete
Fetch Shift Durations
This operation is used to delete to fetch all Shift Durations into database from database or fetch shift durations for a particular given facility.
Parameters
Base URL: /organizations/{organization}/facilities/{facility}/deleteShiftDurations
Request Type: POSTGET
Name | Type | Mandatory | Description |
---|---|---|---|
{organizationId} | String | Yes | The id of the Organization.{facilityId} |
token | String | Yes | The id of the FacilitySecurity Token obtained before. |
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.{facilityId} | String | No | The id of the Facility. |
API Sample
Happy Scenario
http://localhost:8080/PresentationServices/organizations/UNC/facilities/UNC/deleteShiftDurations?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1
Expand | ||
---|---|---|
Expand | ||
| ||
| ||
{"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
| ||
{"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":truefalse,"name":"North EasternVidant","barCodeEnabled":truefalse,"organizationId":"UNC"}],{"idstatusFact":{"UNC",success"nfcEnabled":true}} |
Not enough Permissions
In the case userId doesn't have 'list_facilities' permission,
"nfcSelfModificationEnabled":false,"name":"UNC","barCodeEnabled":true,"organizationId":"UNC"},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 | ||
---|---|---|
| ||
{"data":{"id":"VidantUNC","nfcEnabled":false,"shifts":["6","9"],"nfcSelfModificationEnabled":false,"name":"VidantUNC","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.".,"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. |
API Sample
Happy Scenario
programs?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1
Expand | ||
---|---|---|
| ||
{"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
AllActive Programs
This operation is used to fetch all available 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. | ||
{ | organizationIdfacility} | StringString | YesYes | The id of the | OrganizationFacility. |
Note that ALL the parameters of the specified template must be present in the request.
API Sample
Happy Scenario
Expand | ||
---|---|---|
| ||
{"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}/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
Expand | ||
---|---|---|
| ||
{"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 '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
Expand | ||
---|---|---|
| ||
{"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 'list_programs' permission, the operation returns a 403 (Forbidden) error with the body "Not enough permissions.".