Technical information

RMS NetLinx Scheduling Client API

170

RMS Enterprise - NetLinx Programmer’s Guide

RmsBookingNextActiveRequest

Description:

Query the next active booking for a given location. If location ID is less than 1, the default location will be used.

Compiler

Directive:

#DEFINE INCLUDE_SCHEDULING_NEXT_ACTIVE_RESPONSE_CALLBACK

Function Syntax: RmsBookingNextActiveRequest(LONG locationId)

• locationid - LONG which is the location id of the meeting

Example:

RmsBookingNextActiveRequest(3)

Returns:

If the request is successful, the response will consist of two components:

1) A summary data event of the form:

SCHEDULING.BOOKING.NEXT.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:

RmsEventSchedulingNextActiveResponse(CHAR isDefaultLocation, INTEGER recordIndex, INTEGER recordCount,

CHAR bookingId[], RmsEventBookingResponse eventBookingResponse)

• isDefaultLocation - boolean, TRUE if the 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.NEXT.ACTIVE-(<location-id>)

• location-id - (optional) LONG location ID

Example - To request information regarding the next active booking for location ID '3':

SEND_COMMAND vdvRMS,'?SCHEDULING.BOOKING.NEXT.ACTIVE-3'