|
ContactLink
An object that represents a ContactLink. ContactLinks are child objects of Contact objects. A ContactLink defines additional contact information on a BlueCamroo contact details page.
Supported API Calls: Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
ID of the ContactLink object. |
|
ContactId |
integer |
ID of the contact object this link is associated with. |
|
ParentId |
integer |
ID of the object it's representing (address, customer contact, supplier contact) |
|
ParentObject |
string (100) |
Name of the actual object it's representing. Values are Address (if it represents the Location field on a contact's details page, which is represented in BlueCamroo by an Address object), AccountCustomerRole (if it represents the Customer Contact field on a contact's details page), or AccountSupplierRole (if it represents the Supplier Contact field on a contact's details page). |
|
IsPrimary |
boolean |
Flag to indicate if the contact is the primary contact (Organization Default Contact) in the customer or supplier role. |
|
ReceiveInvoiceEmail |
boolean |
Flag to indicate if the contact is receive the invoice in the customer role. |
Get
Description
Returns the specified ContactLink object.
URL
https://{company}.bluecamroo.com/api/ContactLink/get/{id}?ContactLinkId={ContactLinkId}
HTTP Method
GET
Data Return
Returns the ContactLink 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 the ContactLink object to the list of ContactLinks
URL
https://{company}.bluecamroo.com/api/ContactLink/add
HTTP Method
POST
Parameters
A ContactLink object
Data Return
Returns the ContactLink 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 ContactLink object to replace the specified ContactLink.
URL
https://{company}.bluecamroo.com/api/ContactLink/update
HTTP Method
PUT
Parameters
A ContactLink object
Data Return
Returns the ContactLink 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 ContactLink
URL
https://{company}.bluecamroo.com/api/ContactLink/delete/{id}?ContactLinkId={ContactLinkId}
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)
|