appointment_get (session, ref)

2.7.32 and higher

SOAP, REST

Input parameters:

• session: is the session token obtained in the session_init() call

• ref: Reference of the appointment (obtained from appointment_create() or appointment_list () )

Output parameters:

• result: Information about the appointment

  • ref: Reference of the appointment

  • 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 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).

  • owner: Information about the owner of the appointment

    • ref: reference of the owner

    • name: Name of the owner

    • image: Image of the owner (thumbnail). It can be expressed as an image reference or an URL

      • ref: An image reference that you can download using the API function user_get_image (session, case, image, type)

      • url: An URL that returns the bytes of the image

  • 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

  • private_notes: Free text for the organizer and other professionals participating in the appointment. This notes are not visible to other participants

  • subscription:

    • ref: reference of the SUBSCRIPTION

    • team: Information about the TEAM owner of the SUBSCRIPTION

    • program: Information about the PROGRAM of the SUBSCRIPTION

  • members: List of members invited to the appointment. The information returned about each member contains:

    • ref: Reference of the invited member.

    • name: Name of the invited member.

    • is_active_user: (true/false) Indicates whether this participant is the active SESSION USER

    • invitation_status: Status of the invitation. Possible values are:

      • “NOT_ANSWERED“: Invitation not responded

      • “ACCEPTED”: The invitation was accepted

      • ”DECLINED”: The invitation was declined

      • “MAYBE”: The member accepts temptatively the invitation, but cannot confirm for sure.

    • connection_status: Status of the connection of the member to the appointment video call (only if for online appointments). Possible values:

      • “NONE”: The member has not connected yet

      • “CONNECTED”: The member is currently connected

      • “LOBBY”: The member is waiting in the lobby

      • “DISCONNECTED”: The member has left the video call

      • “KICKED”: The member has been kicked off from the appointment

    • role: Role of the member in the appointment. Possible values are:

      • “OWNER”: The member is the owner of the appointment

      • “PROFESSIONAL”: The member is a a PROFESSIONAL

      • “PARTICIPANT”: The member is a a CASE (patient) or an ASSOCIATE of the CASE

      • “ANONYMOUS”: The member is someone who has joined the meeting without an invitation (if the appointment permits anonymous users)

    • image: Image of the member (thumbnail). It can be expressed as an image reference or an URL

      • ref: An image reference that you can download using the API function user_get_image (session, case, image, type)

      • url: An URL that returns the bytes of the image

  • permissions: permissions granted to the active USER:

    • edit: (true/false) Can edit (modify) the properties of the appointment

    • delete: (true/false) Can delete the appointment

    • join: (true/false) Can join the appointment via video call

• 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

INVALID_TOKEN

The session token provided is not valid

INSUFFICIENT_PRIVILEGES

The session user does not have the necessary privileges to request the information of the appointment

APPOINTMENT.NOT_FOUND

The requested appointment doesn’t exist