|
OpportunityShare
An object that represents a sharing condition for an opporunity.
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. |
|
ParentId |
integer |
ID of the parent opportunity or project. |
|
ParentObject |
string (100) |
ParentObject identifies what kind of object the share object is a child of. Value is project or opportunity. |
|
UserOrGroupId |
integer |
ID of the user or group the object should be shared with. |
|
UserType |
string (100) |
Indicates whether it's shared with a group or user. |
|
OpportunityAccessLevel |
string (100) |
Sets the user's access to the opportunity. Can be None, View Only, or Full Access. |
|
LineItemAccessLevel |
string (100) |
Sets the user's access to the list of products associated with this opportunity. Can be None, View Only, or Full Access. |
|
ContactRoleAccessLevel |
string (100) |
Sets the user's access to the opportunity's contact role page. Can be None, View Only, or Full Access. |
List
Description
Returns a list of team members associated with the specified opportunity
URL
https://{company}.bluecamroo.com/api/OpportunityShare/list?opportunityid={opportunityid}
HTTP Method
GET
Parameters
None
Data Return
Returns a list of OpportunityShare objects specified by opportunityid 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 team member.
URL
https://{company}.bluecamroo.com/api/OpportunityShare/get/{id}?opportunityId={opportunityId}
HTTP Method
GET
Parameters
None
Data Return
Returns the OpportunityShare 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 opportunity team member.
URL
https://{company}.bluecamroo.com/api/OpportunityShare/add
HTTP Method
POST
Parameters
An OpportunityShare object
Data Return
Returns the OpportunityShare 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 OpportunityShare object .
URL
https://{company}.bluecamroo.com/api/OpportunityShare/update
HTTP Method
PUT
Parameters
An OpportunityShare object
Data Return
Returns the OpportunityShare 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 team member.
URL
https://{company}.bluecamroo.com/api/OpportunityShare/delete/{id}?opportunityId={opportunityId}
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)
|