|
PersonSharingRule
An object that represents a sharing rule for Persons when created.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID for the share. When adding a new share the value must be 0. |
|
GroupId |
integer |
The ID of the group doing the sharing. |
|
UserOrGroupId |
integer |
ID of the user or group the object should be shared with. |
|
UserType |
string (100) |
The value should always be group. |
|
PersonAccessLevel |
string (100) |
Sets the access level to the person record. |
List
Description
Returns a list of sharing rules associated with the specified person
URL
https://{company}.bluecamroo.com/api/PersonSharingRule/list?personid={personid}
HTTP Method
GET
Parameters
None
Data Return
Returns a list of PersonSharingRule objects specified by personid 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/PersonSharingRule/get/{id}?personid={personid}
HTTP Method
GET
Parameters
None
Data Return
Returns the PersonSharingRule 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 person sharing rule.
URL
https://{company}.bluecamroo.com/api/PersonSharingRule/add
HTTP Method
POST
Parameters
An PersonSharingRule object
Data Return
Returns the PersonSharingRule 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 PersonSharingRule object .
URL
https://{company}.bluecamroo.com/api/PersonSharingRule/update
HTTP Method
PUT
Parameters
An PersonSharingRule object
Data Return
Returns the PersonSharingRule 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/PersonSharingRule/delete/{id}?personid={personid}
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)
|