Technical information

RMS NetLinx Scheduling Client API
172
RMS Enterprise - NetLinx Programmer’s Guide
RmsBookingEnd
Server Initiated Events
RMS provides information regarding the status of booking events. As with other callbacks, any programmer interested in receiving
the events must provide a '#DEFINE' for the specific include directive, as well as a function which implements any necessary code
to process the event.
As an example, to receive events when an event starts, a programmer must provide the following line of code:
#DEFINE INCLUDE_SCHEDULING_EVENT_STARTED_CALLBACK
With the '#DEFINE' compiler directive in place, there must be a function definition which implements any logic to process the
event:
DEFINE_FUNCTION RmsEventSchedulingEventStarted(CHAR bookingId[], RmsEventBookingResponse
eventBookingResponse){// Do something to process the event}
RmsEventSchedulingActiveUpdated
RmsEventSchedulingNextActiveUpdated
RmsBookingEnd
Description:
End a booking event. If location ID is less than 1, the default location will be used.
Note: "RmsBookingEnd" is only valid for the active meeting.
Compiler
Directive:
#DEFINE INCLUDE_SCHEDULING_END_RESPONSE_CALLBACK
Function Syntax: RmsBookingEnd(CHAR bookingId[], LONG locationId)
• bookingId - CHAR array which is the booking ID of the booking event this record is for
• locationid - LONG which is the location id of the meeting
Example:
RmsBookingEnd('29-1999997939', 30)
Returns:
If the request is successful, the response will consist of a single callback:
Callback Function
Syntax:
RmsEventSchedulingEndResponse (CHAR isDefaultLocation, CHAR responseText[], RmsEventBookingResponse
eventBookingResponse)
• isDefaultLocation - boolean, TRUE if the location in the response is the default location
• responseText - If the request is successful this will contain the event booking ID. On an error, this will contain information about the error
• eventBookingResponse - This structure provides additional information about the booking event
SEND_COMMAND
Syntax:
SCHEDULING.BOOKING.END-<booking-id>,(<location-id>)
• booking-id - CHAR array which is the booking ID of the booking event this record is for
• location-id - (optional) LONG location ID
Example - End booking ID '29-1999997939' :
SEND_COMMAND 41001:1:0,'SCHEDULING.BOOKING.END-29-1999997939'
RmsEventSchedulingActiveUpdated
Description:
This callback is executed when RMS wants to indicate the current active booking event has updated/changed.
Note: Active may be more than 1.
Compiler
Directive:
#DEFINE INCLUDE_SCHEDULING_ACTIVE_UPDATED_CALLBACK
Syntax: RmsEventSchedulingActiveUpdated(CHAR bookingId[], RmsEventBookingResponse eventBookingResponse)
• booking-id - CHAR array which is the booking ID of the booking event this record is for
• eventBookingResponse - This structure provides additional information about the booking event
RmsEventSchedulingNextActiveUpdated
Description:
This callback is executed when RMS wants to indicate the next active booking event has updated/changed.
Note: Active may be more than 1.
Compiler
Directive:
#DEFINE INCLUDE_SCHEDULING_NEXT_ACTIVE_UPDATED_CALLBACK
Syntax: RmsEventSchedulingNextActiveUpdated(CHAR bookingId[], RmsEventBookingResponse eventBookingResponse)
• booking-id - CHAR array which is the booking ID of the booking event this record is for
• eventBookingResponse - This structure provides additional information about the booking event