Technical information

RMS NetLinx Scheduling Client API
168
RMS Enterprise - NetLinx Programmer’s Guide
RmsBookingRequest
RmsBookingsSummariesDailyRequest
RmsBookingRequest
Description:
Request information about a specific booking by booking ID. If location ID is less than 1, the default location will be used.
Compiler
Directive:
#DEFINE INCLUDE_SCHEDULING_BOOKING_RESPONSE_CALLBACK
Function Syntax: RmsBookingRequest(CHAR bookingId[], LONG locationId)
• bookingId - unique ID of the requested booking event
• locationid - LONG location ID
Returns:
FALSE is returned if booking ID is empty.
Example:
RmsBookingRequest('31--1999997729',4)
Callback Function
Syntax:
If the request is successful, the following callback function will be executed:
RmsEventSchedulingBookingResponse (CHAR isDefaultLocation, CHAR bookingId[], RmsEventBookingResponse
eventBookingResponse)
• isDefaultLocation - boolean, TRUE if th location in the response is the default location
• bookingId - CHAR array which is the booking ID of the booking event that was requested
• eventBookingResponse - This structure provides additional information about the booking event
SEND_COMMAND
Syntax:
?SCHEDULING.BOOKING-<booking-id>(,<location-id>)
• booking-id - unique ID of the requested booking event
• location-id - (optional) LONG location ID
Example - To request information about booking event ID '31-1999997729' at location ID '4':
SEND_COMMAND vdvRMS,'?SCHEDULING.BOOKING-31--1999997729,4'
RmsBookingsSummariesDailyRequest
Description:
Query Monthly Booking Summary For Specified Day of the Month and Location. If location ID is less than 1, the default location will be used.
Compiler
Directive:
#DEFINE INCLUDE_SCHEDULING_BOOKING_SUMMARIES_DAILY_RESPONSE_CALLBACK
Function Syntax: RmsBookingsSummariesDailyRequest(SINTEGER dayOfTheMonth, LONG locationId)
• dayOfTheMonth - SINTEGER which is the day of the current month for the requested summary.
• locationId - LONG which is the location ID of the meeting
Example:
RmsBookingsSummariesDailyRequest(10,6)
Returns:
FALSE is returned if dayOfTheMonth is less than 1 or greater than 31.
If the request is successful, the response will consist of two components:
1) A summary data event of the form:
SCHEDULING.BOOKINGS.SUMMARIES.DAILY.COUNT-<location-id>, <is-client-default-location>, <booking-summary-count>
• location-id - LONG which is the location ID of the meeting
• is-client-default-location - boolean, TRUE if the location in the response is the default location
• booking-summary-count - INTEGER reflecting the total number of summary records
2) If the record count is greater than zero, a callback function will be executed for each record. Each record will include the total number of
records in the response as well as the record number or index of the specific response in that response group (see "Callback Function Syntax"
below).
Callback Function
Syntax:
RmsEventSchedulingSummariesDailyResponse(CHAR isDefaultLocation, RmsEventBookingDailyCount dailyCount
• isDefaultLocation - boolean, TRUE if th location in the response is the default location
• dailyCount - A structure with information about a specific date
SEND_COMMAND
Syntax:
?SCHEDULING.BOOKINGS.SUMMARIES.DAILY-<month-date>(,<location-id>)
where:
• month-date - INTEGER which is the day of the current month for the requested summary.
• location-id - (optional) LONG location ID
Example - To request information for the 10th and location ID '6':
SEND_COMMAND vdvRMS,'?SCHEDULING.BOOKINGS.SUMMARIES.DAILY-10,6