Technical information

RMS NetLinx Scheduling Client API
169
RMS Enterprise - NetLinx Programmer’s Guide
RmsBookingsSummaryDailyRequest
RmsBookingActiveRequest
RmsBookingsSummaryDailyRequest
Description:
Query a single daily event summary record by date and location. If location ID is less than 1, the default location will be used.
Compiler
Directive:
#DEFINE INCLUDE_SCHEDULING_BOOKING_SUMMARY_DAILY_RESPONSE_CALLBACK
Function Syntax: RmsBookingsSummaryDailyRequest(CHAR summaryDate[], LONG locationId)
• summaryDate - date in the form of 'mm/dd/yyyy'. Note that no time is needed
• locationid - LONG which is the location ID of the meeting
Example:
RmsBookingsSummaryDailyRequest('10/01/2012',3)
Returns:
FALSE is returned if summaryDate is empty.
If the request is successful, the following callback function will be executed (see Callback Function Syntax below).
Callback Function
Syntax:
RmsEventSchedulingSummaryDailyResponse(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.SUMMARY.DAILY-<summary-date>(,<location-id>)
• summary-date - date in the form of 'mm/dd/yyyy'. Note that no time is needed
• location-id - (optional) LONG location ID
Example - To request information for the 10/1/2012 , location ID '3':
SEND_COMMAND vdvRMS,'?SCHEDULING.BOOKINGS.SUMMARY.DAILY-10/01/2012,3'
RmsBookingActiveRequest
Description:
Query the current active booking for a given location. If location ID is less than 1, the default location will be used.
Compiler
Directive:
#DEFINE INCLUDE_SCHEDULING_ACTIVE_RESPONSE_CALLBACK
Function Syntax: RmsBookingActiveRequest(LONG locationId)
• locationid - LONG which is the location id of the meeting
Example:
RmsBookingActiveRequest(3)
Returns:
If the request is successful, the response will consist of two components:
1) A summary data event of the form:
SCHEDULING.BOOKING.ACTIVE.COUNT-<is-client-default-location>, <booking-record-count>
• is-client-default-location - CHAR constant TRUE or FALSE
• booking-record-count - INTEGER indicating the next active booking record count
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:
RmsEventSchedulingActiveResponse(CHAR isDefaultLocation, INTEGER recordIndex, INTEGER recordCount,
CHAR bookingId[], RmsEventBookingResponse eventBookingResponse)
• isDefaultLocation - boolean, TRUE if th location in the response is the default location
• recordIndex - INTEGER value which indicates the record number for this response
• recordCount - INTEGER which reports the total number of records for this response.
• bookingId - CHAR array which is the booking ID of the booking event this record is for.
• eventBookingResponse - This structure provides additional information about each booking event.
SEND_COMMAND
Syntax:
?SCHEDULING.BOOKING.ACTIVE-(<location-id>)
• location-id - (optional) LONG location ID
Example - To request information regarding the current active booking for location ID '3':
SEND_COMMAND vdvRMS,'?SCHEDULING.BOOKING.ACTIVE-3'