|
CaseSharingRule
An object that represents a sharing rule for Cases when created.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
CaseAccessLevel |
string (100) |
Sets the access level to the Case record. |
List
Description
Returns a list of sharing rules associated with the specified case
URL
https://{company}.bluecamroo.com/api/CaseSharingRule/list?caseid={caseid}
HTTP Method
GET
Parameters
None
Data Return
Returns a list of CaseSharingRule objects specified by caseid in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
401: Not authorized (you need to log in)
Get
Returns details for the specified sharing rule.
URL
https://{company}.bluecamroo.com/api/CaseSharingRule/get/{id}?caseid={caseid}
HTTP Method
GET
Parameters
None
Data Return
Returns the CaseSharingRule object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds an case sharing rule.
URL
https://{company}.bluecamroo.com/api/CaseSharingRule/add
HTTP Method
POST
Parameters
An CaseSharingRule object
Data Return
Returns the CaseSharingRule in the requested format (e.g., JSON or XML)
HTTP Return Status Code
201: Created
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Update
Description
Updates an CaseSharingRule object .
URL
https://{company}.bluecamroo.com/api/CaseSharingRule/update
HTTP Method
PUT
Parameters
An CaseSharingRule object
Data Return
Returns the CaseSharingRule in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Delete
Description
Deletes the sharing rule.
URL
https://{company}.bluecamroo.com/api/CaseSharingRule/delete/{id}?caseid={caseid}
HTTP Method
DELETE
Parameters
None
Data Return
None
HTTP Return Status Code
200: Ok
400: Bad Request (One or more input data items is not valid, for example a mandatory field is blank)
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
|