Technical information

RMS NetLinx Scheduling Client API
166
RMS Enterprise - NetLinx Programmer’s Guide
Notice in the above sample that the #DEFINE compiler directive is specified before the #IF_DEFINED and #END_IF compiler
directives. When #IF_DEFINED and #IF_NOT_DEFINED compiler directives are specified in include files, the include file
statements (defined by the #INCLUDE compiler directive) need to be declared after the #DEFINE compiler directive statements.
For more information on Compiler Directives, refer to the NetLinx Programming Language Reference Guide.
Scheduling Structures
In many cases additional information about a scheduling booking event is provided in the form of a NetLinx data structure. The
three main structure types are "RmsEventBookingResponse", "RmsEventBookingMonthlySummary" and
"RmsEventBookingDailyCount".
In the case of "RmsEventBookingResponse", many of the fields provide general booking event information common to any
response. Included in the same structure are fields which are only meaningful in specific situations.
Fields such as "isSuccessful" or "failureDescription" only relate to callbacks which are the response to a command.
These specific fields are not meaningful in callbacks reporting changes such as the start of an event.
Fields like "elapseMinutes" only related to active booking events, while "minutesUntilStart" only relate to the next
active booking event.
In the specific case where an "RmsEventBookingResponse" structure is the response to a failed command, most of the
fields except "failureDescription" may not be meaningful. When possible, the relevant fields will be filled in with data
to help better understand the circumstances that lead to the error. As an example, some fields will have "N/A" to help in
this determination.
Additional information can be found within the "RmsSchedulingApi.axi" Include File.
Function Status and Logging
As a general rule, most commands return the CHAR constant for TRUE if successful or the CHAR constant for FALSE if an error
is detected. A common error example might be incorrect or missing arguments. Errors are logged using the normal NetLinx and
RMS SDK logging API's.
Query Functions
There are several scheduling query functions defined in the RmsSchedulingApi.axi Include File:
RmsBookingsRequest (see page 167)
RmsBookingRequest (see page 168)
RmsBookingsSummariesDailyRequest (see page 168)
RmsBookingsSummaryDailyRequest (see page 169)
RmsBookingActiveRequest (see page 169)
RmsBookingNextActiveRequest (see page 170)
Create/Extend/End Functions
The following create, extend and end functions defined in the RmsSchedulingApi.axi Include File that alter booking events:
RmsBookingCreate (see page 171)
RmsBookingExtend (see page 171)
RmsBookingEnd (see page 172)
Server Initiated Events
There are several Server Initiated Events defined in the RmsSchedulingApi.axi Include File that report when there are changes in
booking events:
RmsEventSchedulingActiveUpdated (see page 172)
RmsEventSchedulingNextActiveUpdated (see page 172)
RmsEventSchedulingEventEnded (see page 173)
RmsEventSchedulingEventStarted (see page 173)
RmsEventSchedulingEventUpdated (see page 173)
The RmsBookingCreate function is only valid for the current day; the RmsBookingExtend and
RmsBookingEnd functions are only valid for the active meeting.