/
appointment_set ()

appointment_set ()

Owned by Pedro Jose Sanchez Luling, created
Feb 02, 2024
3 min read

Function prototype

appointment_set (session, ref , appointment_info)

API Version

2.7.32 and higher

Supported interfaces

SOAP, REST

Description

Modifies the properties of an appointment.

Required permissions: The active user must be the organizer of the appointment. Otherwise an INSUFFICIENT_PRIVILEGES error will be returned.

Depending on the properties modified, the execution of the function may trigger some additional actions as described in APPOINTMENT WEB SERVICES

Input parameters:

Output parameters:

  • result: Returns the same information that appointment_get () with the information of the appointment after the modifications

  • ErrorMsg: If any error occurs, then this value contains a description of the error translated to the current language

  • ErrorCode: If any error occurs, then this value contains any of the standard ERROR CODES

Request example

appointment_set('LCAAAAAAAAAAAA', 83727, '{ "subject": "Review of patients situation", "date": "2024-01-21 12:30:00" "duration": 30, "timezone": "Europe/Madrid", "type": "online", "location": null, "bypass_lobby": 1, "accept_anonymous": false, "agenda": "Description of the agenda of the meeting", "members": [{"ref": 324}, {"ref": 636}], "subscription": { "ref": 1283 } }' )

Response

The response format is XML when the function has been invoked via the SOAP API, and JSON when it has been invoked via the REST API

Return Error codes

ERROR CODE

 

ERROR CODE

 

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to modify the appointment

APPOINTMENT.NOT_FOUND

The requested appointment doesn’t exist

Appointment information structure

The properties of the appointment are provided in a JSON string with the following format:

  • subject: Text explaining the subject of the appointment

  • date: Schedule of the appointment (in format YYYY-MM-DD h:mm:ss). This is a local date in the timezone of the active user unless a different one is provided in the property timezone

  • timezone: Timezone in which the planned appointment date is expressed. By default is the timezone of the active user

  • duration: Planned duration of the appointment in minutes (the default value is 30).

  • online: true/false. Indicates whether the appointment will be done via an online connection, or physically. The default value is true.

  • location: Free text. Physical location of the appointment

  • bypass_lobby: Value indicating which participants will be able to access an online appointment without having to wait for an authorization by the organizer. The value is a bit mask composed by one of the following values:

    • 1: Organizer: this value is assigned by default and cannot be removed

    • 2: Professionals: Other professionals registered in the platform

    • 4: Invited: Any person invited to the appointment

    • 8: Anonymous: Other person not invited to the appointment that have accessed directly via a link (if the appointment accepts anonymous connections)

  • accept_anonymous: (true/false) indicates whether it is allowed to accept anonymous participants in the meeting (participants that have not been invited but have a link to access the appointment)

  • agenda: Free text with a description of the agenda for the appointment

  • members: Array with a list of member references. The reference of the participants can be obtained with the API function appointment_contact_search ()

  • subscription: It is possible to indicate that the meeting is related to a Subscription. Indicate here the reference of the related Subscription.

Any of the values of the JSON can be omitted, in which case the currently assigned value will not be altered

Example

{ "date": "2024-01-21 12:30:00", "subject": "Review of patients situation", "duration": 30, "timezone": "Europe/Madrid", "type": "online", "location": null, "bypass_lobby": 1, "accept_anonymous": false, "agenda": "Description of the agenda of the meeting", "members": [{"ref": 324}, {"ref": 636}], "subscription": { "ref": 1283 } }

 

Related content