|
Time
An object that represents a user time record.
Supported API Calls: Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique ID for the Time object. When adding a new Time the value must be 0. |
|
UserId |
integer |
ID of the object's parent internal user. |
|
ParentId |
integer |
If the object is a child of an object like an organizationor project, enter the ID of that object. Optional. This value can be null. |
|
ParentObject |
string (100) |
ParentObject identifies what kind of object the Time object is a child of. Values are lead, account (if it's an organization), contact, opportunity, project, case, task, event |
|
Duration |
double |
Time in seconds spent on the task. BlueCamroo will display it as hours/minutes. |
|
ActivityDate |
DateTime |
Date value for the Date of Time Spent field. Optional. This value can be null. |
|
Description |
string (100) |
Text for the Description for Time Spent. |
|
IsBillable |
boolean |
Flag to indicate the time is billable. |
|
IsWaived |
boolean |
Flag that indicates the Time item has been discarded (not included in billing, and no longer to be offered for billing), if true. |
|
TimeID |
integer |
ID of the timer object that recorded time spent on this item. |
|
ProjectTime |
integer |
Time spent if this item is associated with a project. |
|
Name |
string(100) |
Name of the item. |
Get
Description
Returns the details of the specified Time item.
URL
https://{company}.bluecamroo.com/api/time/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the Time 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 Time item.
URL
https://{company}.bluecamroo.com/api/time/add
HTTP Method
POST
Parameters
A Time object
Data Return
Returns the Time 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
Updates a Time object.
URL
https://{company}.bluecamroo.com/api/time/update
HTTP Method
PUT
Parameters
A Time object
Data Return
Returns the Time 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 Time object.
URL
https://{company}.bluecamroo.com/api/time/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)
|