|
|
|
|
|
Request Type: GET
Example URL: http://hostname/<context>/restapi/v1/events/< integer cal_item_id> || itemguid=eventguid
Return
Http Result Code:
200 - the JSON Encoded representation of the Connect Daily Event
403 - Access Denied. The account doesn't have permission to view the event.
404 - The event is not found.
Request Type: PUT
Example URL: http://hostname/<context>/restapi/v1/events/< integer cal_item_id> || itemguid=eventguid
Content: JSON Encoded Event Representation
For details on the JSON encoded event, grab one and take a look at it. Additionally, Refer to the connectDaily database schema.
Return: Return Content: JSON Object – See Examples Below
Event Updated Successfullly:
Http Result Code: 200
Return Content: JSON Representation of updated event object. IOW, what you would get by immediately calling GET for the event.
Event Update Error
HttpResult Code: 200
{ "error" : 1, "message" : "Some Diagnostic message" }
Error Values:
Error
Warning
Conflict (either resource or event)
If the event was updated by another instance, then the result code will be 409 Conflict.
starting_date, ending_date, and exceptions can be supplied in the format "yyyy-mm-dd" if desired. Otherwise it’s assumed they’re julian day numbers as documented in the Source Code Guide.
Request Type: POST
Example URL: http://hostname/<context>/restapi/v1/events
Request Content:
The JSON Representation of a Connect Daily event.
Return Content:
Event Created Successfully:
Http Result Code: 201 – Created
Content: JSON Representation of Newly Created Object.
Error Creating Event:
User lacks permssion to create event on specified calendar: Http Result Code 403
Http Result Code: 500 - Error
{ "error" : 1, "message" : "Some Diagnostic Text" }
This call forks an instance of a recurring event. Say you have a series, and you want to edit the content of a specific date of the series. You can use this call to fork the occurrence. When an occurrence is forked, the following actions happen:
The series has an exception date value as specified by the starting_date parameter added.
The event is cloned as a one-time event with the starting date value as specified by the starting_date parameter.
The value for rec_type indicates the recurrence type. See the Connect Daily Source Code Documentation guides for specific recurrence patterns. In General, a one time event has a rec_type of 3, and any other value, including 0 is a recurring event.
Request Type: POST
Example URL: http://hostname/<context>/restapi/v1/events/< integer cal_item_id> || itemguid=eventguid
Parameters:
Parameter Name Value
fork 1
starting_date "yyyy-mm-dd"
The series MUST occur on the specified date or an error value will be returned.
Return Content:
Successful Request:
{ "error" : 0, "message" : null, "cal_item_id" : <id of new occurrence> }
Http Result Code: 201 - Created
Failed Request:
HttpResult Code: 400 - Error
{ "error" : 1, "message" : "Some Diagnostic Message" }
Request Type: DELETE
Example URL: http://hostname/<context>/restapi/v1/events/< integer cal_item_id> || itemguid=eventguid
Return Content:
Successful Request:
Http Result Code: 204 – No Content
Failed Request:
User Lacks Permission:
Http Result Code 403
Event Not Found:
Http Result Code 404
Otherwise
Http Result Code: 200
Return Content: { "error" : 1,"message" : "some diagnostic"}