|
ContactRole
ContactRole is a property of the Contact object. It represents an Contact Role lookup value. It shares all properties with its base LookupValue object. Plus the following unique flags:
Supported API Calls: List | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
IsCustomerRole |
boolean |
Flag indicates this lookup value is available if the contact is a customer contact. |
|
IsSupplierRole |
boolean |
Flag indicates this lookup value is available if the contact is a supplier contact. |
List
Description
Returns a list of Contact Roll lookup values.
URL
https://{company}.bluecamroo.com/api/contactrole/list
HTTP Method
GET
Data Return
Returns a list of existing contactrole objects 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 the contactrole object to the list of contact roles.
URL
https://{company}.bluecamroo.com/api/contactrole/add
HTTP Method
POST
Parameters
Dashboard object
Data Return
Returns the Dashboard object 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
Pass a contact role object to replace the specified contact role.
URL
https://{company}.bluecamroo.com/api/contactrole/update
HTTP Method
PUT
Parameters
Dashboard object
Data Return
Returns the Dashboard 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)
Delete
Description
Deletes the specified contact role. The contact role to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/contactrole/delete/{id}
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)
See BlueCamroo User Help
|