Update or Modify Cash Flow Permission

PUT /ws/rest/service/v1/cashflow/permission/{project_number}

Purpose:

Update permission (in user mode) of a specific cash flow in a shell based on shell number or from Company level if project/shell number is not provided.

The input JSON shall provide various options to be considered for fetching the data

Input:

All parameters should be URL encoded.

Path Parameter

project_number: Specify the Project number in which the cash flow exists, if not provided then cash flows are considered to be fetched from Company Level.

POST body is a JSON

Note: POST call has input & output both as JSON in the body

Input JSON

{

"data" :

{

"names": ["cash flow 1", "cash flow 2", "cash flow 3"] ,

"permissions": [

{

"login_name": "coadmin",

"type": "U",

"full_name": "Company Administrator",

"permission": {

"edit_data": "1",

"modify_permission": "0",

"view": "1"

}

},

{

"full_name": "Project Manager 1",

"group_name": "Project Manager 1",

"permission": {

"edit_data": "1",

"view": "1",

"modify_permission": "0"

},

"type": "PG"

}

]

}

In request, "names" is mandatory .

In the request body names can be provided in below two formats

1. "names": ["cash flow 1", "cash flow 2", "cash flow 3"] For one or more cash flows.

2. "names": "cash flow 1" For only one cash flow.

If names not provided, then error response will be provided to user to provide cash flows.

Output:

JSON object containing 'status', 'data', 'message'

message will be present if status is not 200 otherwise it will be "success".

Update or Modify Cash flow Permission Sample Response

1) Response for success case:

{

"data": {

"cash flow 1": {

"permissions": [

{

"login_name": "donna",

"full_name": "Donna Pinciotti",

"permission": {

"edit_data": "1",

"view": "1",

"modify_permission": "1"

},

"type": "U"

},

{

"login_name": "coadmin",

"full_name": "Company Administrator",

"permission": {

"edit_data": "1",

"view": "1",

"modify_permission": "0"

},

"type": "U"

},

{

"full_name": "Project Managers",

"group_name": "Project Managers",

"permission": {

"edit_data": "1",

"view": "1",

"modify_permission": "0"

},

"type": "PG"

}

],

"updated_users": [

"coadmin"

],

"updated_groups": [

"Project Managers"

]

},

"cash flow 2": {

"permissions": [

{

"login_name": "coadmin",

"full_name": "Company Administrator",

"permission": {

"edit_data": "1",

"view": "1",

"modify_permission": "1"

},

"type": "U"

}

],

"updated_users": [],

"updated_groups": []

},

"cash flow 3": {

"permissions": [

{

"login_name": "coadmin",

"full_name": "Company Administrator",

"permission": {

"edit_data": "1",

"view": "1",

"modify_permission": "0"

},

"type": "U"

},

{

"login_name": "donna",

"full_name": "Donna Pinciotti",

"permission": {

"edit_data": "1",

"view": "1",

"modify_permission": "1"

},

"type": "U"

},

{

"full_name": "Project Managers",

"group_name": "Project Managers",

"permission": {

"edit_data": "1",

"view": "1",

"modify_permission": "0"

},

"type": "PG"

}

],

"updated_users": [

"coadmin"

],

"updated_groups": [

"Project Managers"

]

}

},

"message": [

"success"

],

"status": 200

}

2: Response for partial success case:

{

"data": {

"cash flow 1": {

"permissions": [

{

"login_name": "donna",

"full_name": "Donna Pinciotti",

"permission": {

"edit_data": "1",

"view": "1",

"modify_permission": "1"

},

"type": "U"

},

{

"login_name": "coadmin",

"full_name": "Company Administrator",

"permission": {

"edit_data": "1",

"view": "1",

"modify_permission": "0"

},

"type": "U"

},

{

"full_name": "Project Managers",

"group_name": "Project Managers",

"permission": {

"edit_data": "1",

"view": "1",

"modify_permission": "0"

},

"type": "PG"

}

],

"updated_users": [

"coadmin"

],

"updated_groups": [

"Project Managers"

]

}

},

"message": [

{

"name": "cash flow 2",

"status": "update permission error message"

},

{

"name": "cash flow 3",

"status": "update permission error message"

}

],

"status": 3000

}

Related Topics