|
StatusUpdate
An object representing a record's Status Update.
Supported API Calls: Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
ID |
integer |
Unique Identity of an StatusUpdate. When adding a new StatusUpdate the value must be 0. |
|
ParentId |
integer |
ID of the object this status update is associated with. |
|
ParentObject |
string (100) |
Type of parent object (account, person, case). |
|
RelatedTo |
string (100) |
Name of the record this update is associated with. |
|
CurrentUpdate |
string (100) |
Text of the actual update. |
|
NextAction |
string (100) |
Text of the next step. |
|
OwnerId |
integer |
ID of the user who owns this update. |
|
DueDate |
DateTime |
Sets the next step's due date. |
|
ShareWithCompany |
boolean |
Flag indicating the update should be shared with others in the company. |
|
ShareWithCustomer |
boolean |
Flag indicating this update is shared with a customer. |
|
ShareWithSupplier |
boolean |
Flag indicating this update is shared with a supplier. |
|
IsNextActionCompleted |
boolean |
Flag indicating the next step has been marked as completed. |
|
CreationDate |
DateTime |
Indicates when this object was created. |
|
LastActivityDate |
DateTime |
Date the last time the object was accessed in any way. |
|
AttachmentList |
List<Attachment> |
A list of attachment objects. |
|
TaskList |
List<Task> |
A list of task objects. |
|
EventList |
List<Event> |
A list of event objects. |
|
TimeSheetList |
List<TimeSheet> |
A list of timesheet objects. |
|
TodoList |
List<Todo> |
A list of Todos. |
|
CommentList |
List<StatusUpdateComment> |
A list of StatusUpdateComment objects. |
|
NotifyList |
List<StatusUpdateNotify> |
A list of who is notified. |
|
ChangeList |
List<StatusUpdateChange> |
If a case, a list of status updates. |
|
ProfileImage |
string (100) |
URL to the profile image of the update poster. |
|
Owner |
string (100) |
Name of the update's owner. |
Get
Description
Returns the specified StatusUpdate.
URL
https://{company}.bluecamroo.com/api/StatusUpdate/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the StatusUpdate object in the requested format (e.g., JSON or XML)
HTTP Return Status Code
401: Not authorized (you need to log in)
403: Forbidden (you don't have permission to this resource)
Add
Description
Adds an StatusUpdate. Adds an StatusUpdate by passing an StatusUpdate object.
URL
https://{company}.bluecamroo.com/api/StatusUpdate/add
HTTP Method
POST
Parameters
An StatusUpdate object
Data Return
Returns the StatusUpdate 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 an StatusUpdate object to replace one or more StatusUpdate details with the matching value.
URL
https://{company}.bluecamroo.com/api/StatusUpdate/update
HTTP Method
PUT
Parameters
An StatusUpdate object
Data Return
Returns the StatusUpdate 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 StatusUpdate based on the passed ID number.
URL
https://{company}.bluecamroo.com/api/StatusUpdate/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)
|