Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 14 Next »

 


Fetch All Permissions

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

Parameters

Base URL: /getPermissions

Request Type: GET

Parameters:

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

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

 Result
{ - 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
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/rolesWithPermissions?token=d38bad16-e48a-4580-b5b6-993124ce638c&userId=QA_1

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

 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}}

 

 

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

 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}}

 



  • No labels