|
StatusUpdateComment
An object representing a comment to a status update.
Supported API Calls: Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
ID |
integer |
Unique Identity of an StatusUpdateComment. When adding a new StatusUpdateComment the value must be 0. |
|
ParentId |
integer |
ID of the statusupdate this comment is associated with. |
|
ParentObject |
string (100) |
Type of parent object (account, person, case). |
|
CommentBy |
integer |
ID of the user who commented. |
|
CommentBody |
string (100) |
Text of the actual comment. |
|
CommentDate |
DateTime |
Date of the comment. |
|
IsNextActionCompleted |
boolean |
Flag indicating the next step has been marked as completed. |
|
ProfileImage |
string (100) |
URL to the profile image of the coment's poster. |
|
Owner |
string (100) |
Name of the coment's owner. |
Get
Description
Returns the specified StatusUpdateComment.
URL
https://{company}.bluecamroo.com/api/StatusUpdateComment/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the StatusUpdateComment 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 StatusUpdateComment. Adds an Status Update Comment by passing an StatusUpdateComment object.
URL
https://{company}.bluecamroo.com/api/StatusUpdateComment/add
HTTP Method
POST
Parameters
An StatusUpdateComment object
Data Return
Returns the StatusUpdateComment 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 StatusUpdateComment object to replace one or more StatusUpdateComment details with the matching value.
URL
https://{company}.bluecamroo.com/api/StatusUpdateComment/update
HTTP Method
PUT
Parameters
An StatusUpdateComment object
Data Return
Returns the StatusUpdateComment 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 StatusUpdateComment based on the passed ID number.
URL
https://{company}.bluecamroo.com/api/StatusUpdateComment/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)
|