/
appointment_invitation_set ()

appointment_invitation_set ()

Function prototype

appointment_invitation_set (session, ref, status)

API Version

2.7.32 and higher

Supported interfaces

SOAP, REST

Description

Modifies the status of the invitation to an appointment for the active USER

Required permissions: The active user must be member invited to the appointment. Otherwise an INSUFFICIENT_PRIVILEGES error will be returned.

When a member changes the status of his invitation, the organizer will be notified as described in APPOINTMENT WEB SERVICES

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 () )

  • status: Response to the invitation. The options are:

    • “ACCEPTED”: The invitation was accepted

    • ”DECLINED”: The invitation was declined

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

Output parameters:

  • result: empty

  • 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_invitation_set ( “LCAAAAAAAAAAAA”, 62733, "ACCEPTED")

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

APPOINTMENT.NOT_FOUND

The requested appointment doesn’t exist or the active USER is not member.

Related content