Technical information

RMS NetLinx Scheduling Client API
167
RMS Enterprise - NetLinx Programmer’s Guide
RmsEventSchedulingDailyCount (see page 173)
RmsEventSchedulingMonthlySummaryUpdated (see page 173)
The tables in this section provide detailed descriptions of each scheduling query function. Each row in the tables describes various
aspects of each scheduling query function. Each row is defined below:
Description: This section provides a description of the basic functionality provided by each query function.
Compiler Directive: This section provides the compiler directive required in order to implement each query function.
If a function compiler directive is included, then the user code must implement the required callback method so the
RMS Event Listener can invoke the callback.
The following code snippet illustrates the required method that must be included in the user code.
// include callback method for RmsBookingsRequest to call
#DEFINE INCLUDE_SCHEDULING_BOOKINGS_RECORD_RESPONSE_CALLBACK
Function Syntax: This section provides the required syntax for each query function, as well as definitions for all
variables.
Returns: This section provides the expected return data for each query function.
Callback Function Syntax: This section provides the syntax of the callback function associated with each query
function, including definitions of all included parameters.
SEND_COMMAND Syntax: This section provides the required syntax for the NetLinx SEND_COMMAND
associated with each query function, including any required variables. NetLinx SEND_COMMANDS represent an
alternative method of performing the same thing as the Function (described in the Function Syntax row).
RmsBookingsRequest
RmsBookingsRequest
Description:
Queries the event booking records for a location and specific date.
Compiler
Directive:
#DEFINE INCLUDE_SCHEDULING_BOOKINGS_RECORD_RESPONSE_CALLBACK
Function Syntax: RmsBookingsRequest(CHAR startDate[], LONG locationId)
where:
• startDate - A date in the form of 'mm/dd/yyyy'. Note, no time is needed.
• locationid - LONG location ID
Example:
RmsBookingsRequest('9/10/2012',3)
Returns:
FALSE is returned if startDate is empty.
If the request is successful, the response will consist of two components:
1) A summary data event of the form:
SCHEDULING.BOOKINGS.COUNT-<location-id>, <is-client-default-location>, <booking-record-count>
• location-id - LONG which is the location ID
• is-client-default-location - CHAR constant TRUE or FALSE
• booking-record-count - INTEGER
2) 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. In the case where there are no records, recordCount and
recordIndex will both be 0 (zero) and most of the other structure information will be meaningless.
Callback Function
Syntax:
RmsEventSchedulingBookingsRecordResponse CHAR isDefaultLocation, INTEGER recordIndex, INTEGER recordCount,
CHAR bookingId[], RmsEventBookingResponse eventBookingResponse)
where:
• 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.BOOKINGS-<start-date>(,<location-id>)
• start-date - NetLinx LDATE format string
• location-id - (optional) LONG location ID
Example - To request the bookings for location number 3 on September 9th:
SEND_COMMAND vdvRMS,'?SCHEDULING.BOOKINGS-9/10/2012,3'