Technical information

RMS NetLinx Scheduling Client API
171
RMS Enterprise - NetLinx Programmer’s Guide
RmsBookingCreate
RmsBookingExtend
RmsBookingCreate
Description:
Create an ad hoc booking event. If location ID is less than 1, the default location will be used.
Note: "RmsBookingCreate" is only valid for the current day.
Compiler
Directive:
#DEFINE INCLUDE_SCHEDULING_CREATE_RESPONSE_CALLBACK
Function Syntax: RmsBookingCreate(CHAR startDate[], CHAR startTime[], INTEGER durationMinutes, CHAR subject[],
CHAR messageBody[], LONG locationId)
• startDate - NetLinx LDATE format CHAR array
• startTime - NetLinx TIME format CHAR array
• durationMinutes - INTEGER for the duration of the meeting in minutes
• subject - Subject of the meeting
• messageBody - Additional information about the meeting
• locationid - LONG which is the location id of the meeting
Example:
RmsBookingCreate('08/24/2012','07:00:00',15,'Status Meeting','Discuss current project status',3)
Returns:
If the request is successful, the response will consist of a single callback:
Callback Function
Syntax:
RmsEventSchedulingCreateResponse (CHAR isDefaultLocation, CHAR responseText[], RmsEventBookingResponse
eventBookingResponse)
• isDefaultLocation - boolean, TRUE if the location in the response is the default location
• responseText - If successful this will contain the event booking ID. On an error, this will contain information about the error .
• eventBookingResponse - This structure provides additional information about the booking event
SEND_COMMAND
Syntax:
SCHEDULING.BOOKING.CREATE-<start-date>,<start-time>, <duration-minutes>,<subject>,<message-body>,
(<location-id>)
• start-date - NetLinx LDATE format CHAR array
• start-time - NetLinx TIME format CHAR array
• duration-minutes - INTEGER for the duration of the meeting in minutes
• subject - Subject of the meeting
• message-body - Additional information about the meeting
• location-id - (optional) LONG location ID
Example - Create a 15 minute meeting on 8/24/2012 at 7 AM for location ID '3':
SEND_COMMAND 41001:1:0,'SCHEDULING.BOOKING.CREATE-08/24/2012,07:00:00,15,Status Meeting,Discuss current
project status,3'
RmsBookingExtend
Description:
Extend a booking event. If location ID is less than 1, the default location will be used.
Note: "RmsBookingExtend "is only valid for the active meeting.
Compiler
Directive:
#DEFINE INCLUDE_SCHEDULING_EXTEND_RESPONSE_CALLBACK]
Function Syntax: RmsBookingExtend(CHAR bookingId[], LONG extendDurationMinutes, LONG locationId)
• bookingId - CHAR array which is the booking ID of the booking event this record is for
• extendDurationMinutes - LONG which is the number of minutes to extend the booking event
• locationid - LONG which is the location id of the meeting
Returns:
If the request is successful, the response will consist of a single callback:
Example:
RmsBookingExtend('29--1999997952',30)
Callback Function
Syntax:
SCHEDULING.BOOKING.EXTEND-<booking-id>,<extend-duration-minutes>,(<location-id>)
• bookingId - CHAR array which is the booking ID of the booking event this record is for
• extendDurationMinutes - LONG which is the number of minutes to extend the booking event
• location-id - (optional) LONG location ID
Example - Extend booking ID '29-1999997952' for 30 minutes:
SEND_COMMAND 41001:1:0,'SCHEDULING.BOOKING.EXTEND-29--1999997952,30'
SEND_COMMAND
Syntax:
RmsEventSchedulingExtendResponse (CHAR isDefaultLocation, CHAR responseText[], RmsEventBookingResponse
eventBookingResponse)
• isDefaultLocation - boolean, TRUE if the location in the response is the default location
• responseText - If the request is successful this will contain the event booking ID. On an error, this will contain information about the error
• eventBookingResponse - This structure provides additional information about the booking event