list calendar

interface address:

  • /api/calendar/collection/list

HTTP request method:

  • GET

request params:

  • limit (query, optional): maximum number of items

  • offset (query, optional): offset

response code:

  • common response

example:

curl -X GET "$BASE_URL/api/calendar/collection/list"

response example：

  • JSON:

    {
}

create calendar

interface address:

  • /api/calendar/collection/create

HTTP request method:

  • POST

request params:

  • name (form, required): calendar name

response code:

  • common response

example:

curl -X GET "$BASE_URL/api/calendar/collection/create"

response example：

  • JSON:

    {
}

update calendar

interface address:

  • /api/calendar/collection/update

HTTP request method:

  • POST

request params:

  • id (form, required): calendar collection ID

  • name (form, optional): name, etc., see the implementation

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/calendar/collection/update"

response example：

  • JSON:

    {
}

list calendar event

interface address:

  • /api/calendar/event/list

HTTP request method:

  • GET

request params:

  • collection_id (query, optional): calendar collection ID

  • start_ts / end_ts (query, optional): time range

response code:

  • common response

example:

curl -X GET "$BASE_URL/api/calendar/event/list"

response example：

  • JSON:

    {
}

get calendar event detail

interface address:

  • /api/calendar/event/detail/:id

HTTP request method:

  • GET

request params:

  • id (path): event ID

response code:

  • common response

example:

curl -X GET "$BASE_URL/api/calendar/event/detail/:id"

response example：

  • JSON:

    {
}

create calendar event

interface address:

  • /api/calendar/event/create

HTTP request method:

  • POST

request params:

  • title (form, required): title

  • dtstart (form, required): start timestamp

  • dtend (form, required): end timestamp

  • type (form, optional): type

  • collection_id (form, optional): calendar collection ID

  • allday (form, optional): whether it is an all-day event

  • interval / freq / byweek / bymonth / until / count (form, optional): recurrence rule

  • meet_id (form, optional): meeting ID

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/calendar/event/create" -d "title=会议&dtstart=1234567890&dtend=1234567900"

response example：

  • JSON:

    {
  "code": 0,
  "message": "OK",
  "data": {}
}

update calendar event

interface address:

  • /api/calendar/event/update

HTTP request method:

  • POST

request params:

  • id (form, required): event ID

  • title / dtstart / dtend / collection_id, etc. (see the implementation)

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/calendar/event/update"

response example：

  • JSON:

    {
}

delete calendar event

interface address:

  • /api/calendar/event/delete

HTTP request method:

  • POST

request params:

  • id (form, required): event ID

response code:

  • common response

example:

curl -X POST "$BASE_URL/api/calendar/event/delete"

response example：

  • JSON:

    {
}