|
Event
The Event object represents a calendar event in BlueCamroo.
Supported API Calls: List | Get | Add | Update | Delete
Object Properties
|
Property |
Type |
Description |
|
Id |
integer |
A unique Id value for the Event object. |
|
ParentId |
integer |
If this event is a child of another object (e.g., an organization or project), the ID of the object. |
|
ParentName |
string (100) |
Name of the parent object. |
|
ParentObject |
string (100) |
What kind of object this event is a child of: person, account (if an organization), project, etc. |
|
Subject |
string (100) |
Subject of the event. |
|
Description |
string (100) |
The description of the event. |
|
Location |
string (100) |
The event's location. |
|
OwnerId |
integer |
The ID of the internal user who owns the event. |
|
ParentEventId |
integer |
If this event object is created as a child of an event set for reoccurring, enter the id. This value can be 0. |
|
ParentObject |
string (100) |
ParentObject identifies what kind of object the event object is a child of. Values are lead, account (if it's an organization), contact, opportunity, project, case. |
|
StartDate |
DateTime |
Event start date. This is optional. |
|
EndDate |
DateTime |
Event end date. This is optional. |
|
UID |
string (100) |
Unique ID email to facilitate email client integration. |
|
IsReminderSet |
boolean |
Flag that indicates the event needs to generate a reminder. |
|
IsAllDayEvent |
boolean |
Flag that indicates the event is an all day event and should block off all working hours. |
|
LastModifiedDate |
DateTime |
Date the last time the object was modified. |
|
ReminderDate |
DateTime |
If reminder is true, set a date for the reminder to be generated. This value is optional. |
|
IsPrivateEvent |
boolean |
Flag that indicates the event is private. |
|
IsRecurrence |
boolean |
Flag that indicates the event is repeating. |
|
RecurrenceType |
string (100) |
Type of repeating event. Possible values are: daily, weekly, monthly, yearly. |
|
RecurrenceStartDate |
DateTime |
Date the recurrence should start. |
|
RecurrenceEndDate |
DateTime |
Date the recurrence should end. |
|
RecurrenceEndOccurrence |
integer |
The event should end after this number of occurrences. For example, it should end after 10 occurances. |
|
OccurrenceNumber |
integer |
A counter for how many actual occurances has taken place. For example, if this is the 5th of 10 maximum occurences, OccurrenceNumber will be 5 while RecurrenceEndOccurrence will be 10. |
|
AttendeeList |
List<EventAttendee> |
A list of attendees. |
|
TotalAttendee |
integer |
Total number of attendees. |
|
ReminderTime |
integer |
Time in minutes until a reminder will be sent out. |
List
Description
Returns a list of events for the passed parent object/id.
URL
https://{company}.bluecamroo.com/api/event/list?parentId={parentId}&ParentObject={ParentObject}
Parameters
None
HTTP Method
GET
Data Return
Returns the events list in the requested format (e.g., JSON or XML)
HTTP Return Status Code
200: Ok
401: Not authorized (you need to log in)
Get
Description
Returns a specific event object.
URL
https://{company}.bluecamroo.com/api/event/get/{id}
HTTP Method
GET
Parameters
None
Data Return
Returns the event 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
Add an event.
URL
https://{company}.bluecamroo.com/api/event/add
HTTP Method
POST
Parameters
Event object
Data Return
Returns the event 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 an event object.
URL
https://{company}.bluecamroo.com/api/event/update
HTTP Method
PUT
Parameters
Event object
Data Return
Returns the event 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 event. The event to delete is specified by Id value.
URL
https://{company}.bluecamroo.com/api/event/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)
|