Appointments API

List appointments

GET /calendar
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • id
  • event_start
  • event_end

The following scopes are needed:

  • calendar_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 1003
Content-Type: application/json
[
  {
    "id": 1,
    "user_id": 1,
    "event_start": "2013-01-17 08:00:00",
    "event_end": "2013-01-17 18:00:00",
    "subject": "Besuch Europapark",
    "place": "Rust",
    "info": null,
    "contact_id": null,
    "sub_contact_id": null,
    "project_id": null,
    "entry_id": null,
    "module_id": null,
    "has_reminder": "false",
    "remember_type_id": null,
    "remember_time_id": null,
    "is_private": "false"
  },
  {
    "id": 2,
    "user_id": 1,
    "event_start": "2013-01-18 14:00:00",
    "event_end": "2013-01-18 15:00:00",
    "subject": "Sitzung",
    "place": "Office Z├╝rich",
    "info": null,
    "contact_id": null,
    "sub_contact_id": null,
    "project_id": null,
    "entry_id": null,
    "module_id": null,
    "has_reminder": "false",
    "remember_type_id": null,
    "remember_time_id": null,
    "is_private": "false"
  },
  {
    "id": 5,
    "user_id": 1,
    "event_start": "2013-01-19 10:00:00",
    "event_end": "2013-01-19 11:30:00",
    "subject": "Phone conference",
    "place": "Office 1.222",
    "info": "",
    "contact_id": null,
    "sub_contact_id": null,
    "project_id": null,
    "entry_id": null,
    "module_id": null,
    "has_reminder": "false",
    "remember_type_id": null,
    "remember_time_id": null,
    "is_private": "false"
  }
]

Search appointments

POST /calendar/search
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
[
  {
    "field": "place",
    "value": "Rust"
  }
]
Name Required Type Description
order_by optional string Sorting
limit optional integer Limit
offset optional integer Offset
callback optional string Javascript callback

The following sort parameters may be applied:

  • event_end
  • event_start
  • id
Name Required Type Description
event_start optional string
event_end optional string
contact_id optional string
user_id optional string
subject optional string
place optional string
module_id optional string
entry_id optional string

The following scopes are needed:

  • calendar_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 332
Content-Type: application/json
[
  {
    "id": 1,
    "user_id": 1,
    "event_start": "2013-01-17 08:00:00",
    "event_end": "2013-01-17 18:00:00",
    "subject": "Besuch Europapark",
    "place": "Rust",
    "info": null,
    "contact_id": null,
    "sub_contact_id": null,
    "project_id": null,
    "entry_id": null,
    "module_id": null,
    "has_reminder": "false",
    "remember_type_id": null,
    "remember_time_id": null,
    "is_private": "false"
  }
]

Show appointment

GET /calendar/5
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • calendar_show
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 335
Content-Type: application/json
{
  "id": 5,
  "user_id": 1,
  "event_start": "2013-01-19 10:00:00",
  "event_end": "2013-01-19 11:30:00",
  "subject": "Phone conference",
  "place": "Office 1.222",
  "info": "",
  "contact_id": null,
  "sub_contact_id": null,
  "project_id": null,
  "entry_id": null,
  "module_id": null,
  "has_reminder": "false",
  "remember_type_id": null,
  "remember_time_id": null,
  "is_private": "false"
}

Create appointment

POST /calendar
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "event_start": "2013-01-19 10:00:00",
  "event_end": "2013-01-19 11:30:00",
  "subject": "Phone conference",
  "place": "Office 1.222"
}
Name Required Type Description
callback optional string Javascript callback
Name Required Type Description
event_end required datetime (Format yyyy-mm-dd hh:ii:ss)
event_start required datetime (Format yyyy-mm-dd hh:ii:ss)
remember_time_id required Resource remember_time Is required if have_remember is set to true.
remember_type_id required Resource remember_type Is required if have_remember is set to true.
subject required string (150)
user_id required Resource user
communication_kind_id optional Resource communication_kind
contact_id optional Resource contact
entry_id optional integer
have_remember optional boolean
info optional string (10000)
is_private optional boolean
module_id optional Resource module
place optional string (150)
pr_project_id optional Resource pr_project
sub_contact_id optional Resource contact
todo_priority_id optional Resource todo_priority
todo_status_id optional Resource todo_status

The following scopes are needed:

  • calendar_edit
Status: 201 Created
X-Authenticated-User: apiextract_1
Content-Length: 335
Content-Type: application/json
{
  "id": 5,
  "user_id": 1,
  "event_start": "2013-01-19 10:00:00",
  "event_end": "2013-01-19 11:30:00",
  "subject": "Phone conference",
  "place": "Office 1.222",
  "info": "",
  "contact_id": null,
  "sub_contact_id": null,
  "project_id": null,
  "entry_id": null,
  "module_id": null,
  "has_reminder": "false",
  "remember_type_id": null,
  "remember_time_id": null,
  "is_private": "false"
}

Overwrite appointment

PUT /calendar/5
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
{
  "user_id": 1,
  "event_start": "2013-01-19 10:00:00",
  "event_end": "2013-01-19 11:30:00",
  "subject": "Phone conference",
  "place": "Office 1.222"
}
Name Required Type Description
callback optional string
Name Required Type Description
event_end required datetime (Format yyyy-mm-dd hh:ii:ss)
event_start required datetime (Format yyyy-mm-dd hh:ii:ss)
remember_time_id required Resource remember_time Is required if have_remember is set to true.
remember_type_id required Resource remember_type Is required if have_remember is set to true.
subject required string (150)
user_id required Resource user
communication_kind_id optional Resource communication_kind
contact_id optional Resource contact
entry_id optional integer
have_remember optional boolean
info optional string (10000)
is_private optional boolean
module_id optional Resource module
place optional string (150)
pr_project_id optional Resource pr_project
sub_contact_id optional Resource contact
todo_priority_id optional Resource todo_priority
todo_status_id optional Resource todo_status

The following scopes are needed:

  • calendar_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 335
Content-Type: application/json
{
  "id": 5,
  "user_id": 1,
  "event_start": "2013-01-19 10:00:00",
  "event_end": "2013-01-19 11:30:00",
  "subject": "Phone conference",
  "place": "Office 1.222",
  "info": "",
  "contact_id": null,
  "sub_contact_id": null,
  "project_id": null,
  "entry_id": null,
  "module_id": null,
  "has_reminder": "false",
  "remember_type_id": null,
  "remember_time_id": null,
  "is_private": "false"
}

Delete appointment

DELETE /calendar/5
Accept: application/json
Authorization: Bearer 677a1598d208d6c303fa5ca1c774709250e21749
Name Required Type Description
callback optional string Javascript callback

The following scopes are needed:

  • calendar_edit
Status: 200 OK
X-Authenticated-User: apiextract_1
Content-Length: 16
Content-Type: application/json
{
  "success": true
}