|
Department
Department is a property of the Contact object and the Lead object. It represents a Department lookup value.
Supported API Calls: List | Add | Update | Delete
Object Properties
It shares all properties with its base LookupValue object.
List
Description
Returns a list of Department lookup values.
URL
https://{company}.bluecamroo.com/api/department/list
HTTP Method
GET
Data Return
Returns a list of existing department 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 Department object to the list of Department lookup values.
URL
https://{company}.bluecamroo.com/api/department/add
HTTP Method
POST
Parameters
Department object
Data Return
Returns the department 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 department object to replace the specified Department lookup value.
URL
https://{company}.bluecamroo.com/api/department/update
HTTP Method
PUT
Parameters
Department object
Data Return
Returns the department 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 Department lookup value. Department lookup value to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/department/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)
|