Versions Compared
Key
- This line was added.
- This line was removed.
- Formatting was changed.
| Table of Contents |
|---|
...
| 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
Parameters:
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://192.168.1.161:8080/PresentationServices/organizations/QA_Organization_A/role/createRole
| 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.".
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
Parameters:
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 } } |
Fetch All Programs
This operation is used to fetch all available survey programs from database.
Base URL: /organizations/{organization}/programs
Request Type: GET
Parameters:
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}} |
Fetch Active Programs
This operation is used to fetch active survey programs from database for a given facility.
Base URL: /organizations/{organization}/facilities/{facility}+programs
Request Type: GET
Parameters:
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}} |