Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Table of Contents |
|---|
Fetch All Permissions
...
| Expand | ||
|---|---|---|
| ||
{ - data: [1] - 0: { name: "access_forms" } -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| Expand | ||
|---|---|---|
| ||
{ - 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.".
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_pod11
| Expand | ||
|---|---|---|
| ||
{ - 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 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
| Expand | ||
|---|---|---|
| ||
{"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
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
| 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, 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 that ALL the parameters of the specified template must be present in the request.
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.".
Update 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 that ALL the parameters of the specified template must be present in the request.
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.".
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 that ALL the parameters of the specified template must be present in the request.
API Sample
Happy Scenario
http://localhost:8080/PresentationServices/organizations/UNC/facilities/UNC/deleteShiftDurations?token=a578dbf4-1800-4a82-be24-b212ba43b278&userId=A_pod1
| 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}/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. |
| {organizationId} | 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 | ||
|---|---|---|
| ||
{"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 | ||
|---|---|---|
| ||
{"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. |
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 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
| 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.".