Update Appointment

User Guide > Resources > Update Appointment

This request changes appointments attributes.

Resource

PATCH /appointments/<OID>

Where OID is the oid of the appointment

Parameters

None

Payload

Patch Document

Fields

Name Patch Operations Notes

subject

replace

internal

replace

participants/<Appointment Participant>

add, remove relation

userStatus

replace

starttime

replace

endtime

replace

allStartDay

replace

when true, make sure the start time contains the actual date and not the UTC date

allEndDay

replace

when true, make sure the start time contains the actual date and not the UTC date

calendars/<OID XCCCalendar>

add, remove

comment

replace

firstRecurrenceDate

replace

lastRecurrenceDate

replace

recurrenceType

replace

recurrenceInterval

replace

recurrenceTerminationType

replace

recurrenceTerminationDate

replace

recurrenceCount

replace

monthRecurrenceType

replace

monday

replace

tuesday

replace

wednesday

replace

thursday

replace

friday

replace

saturday

replace

sunday

replace

Response

None

Context

Authorization

User

Errors

Common Errors

HTTP code Xelion code Description

404

10100

No addressable or calendar with the specified ID exists.

Example

Request
PATCH https://xelion.nl/api/v1/master/appointments/1627410
Payload

add calendar, replace simple member, remove participant

{
        "operations": [
        {
           "op": "add",
           "path": "/calendars",
           "value": "1658218"
        },
        {
            "op": "replace",
            "path": "/userStatus",
             "value": "long_out_of_office"
        },
        {
            "op": "replace",
            "path": "/comment",
            "value": "Test Comment"
        },
        {
            "op": "remove",
            "path": "/participants/167843"
        }
    ]
}

Set all start day, make sure the start time is set on the actual start date and not on the UTC date.
For example when you want the appointment to start on 2018-12-27 and the current time zone is UTC+2 do not send a start time of 2018-12-26 22:00:00 (utc time) but send 2018-12-27 00:00:00.
When all end day is set, the same rule is applied.

For example when you want the appointment to end on 2018-12-27 and the current time zone is UTC-2 do not send a end time of 2018-12-28 02:00:00 (utc time) but send 2018-12-27 23:59:59.

The precise time HH:MM:SS is not really important because it is ignored when the allStartDay/allEndDay boolean is true.

{
        "operations": [
          {
            "op": "replace",
            "path": "/allStartDay",
            "value": true
          },
          {
            "op": "replace",
            "path": "/starttime",
            "value": "2018-12-27 00:00:00"
          },
          {
            "op": "replace",
            "path": "/allEndDay",
            "value": true
          },
          {
            "op": "replace",
            "path": "/endtime",
            "value": "2018-12-27 23:59:59"
          }
      ]
}