| Home | Sales | Training | Contact Us |
|
| RDP Support | ||||
| RDPWin KB | RDP-DOS KB | IRM and IRM.Net KB | Crystal KB | |
Article ID: KINet0004
Added: 6/09/08 SW
Updated: 6/10/08 SS
Return to IRM.Net Knowledge Base Index
| The IRM.net is configurable and customizable to a great degree. The documentation contained below is designed to be used by web programmers to configure the IRM.net. The documentation will be self explanatory to a web programmer. Programmer support is not provided for integrating the IRM.net. If you are not a web programmer, or you have not hired a web programmer and you would like to customize the IRM.net, please contact GuestStream, our preferred provider for IRM.net configuration. |
|
IRM.net allows search criteria values as well as arrival and departure dates to be passed in from the market website, in which case the Room List only includes rooms meeting the criteria. The search criteria supported corresponds to the Guest Preferences configured in RDPWin on the Reservations | Configuration | Preferences tab. Arrival and departure dates as well as people counts can optionally be passed to IRM.net.
This is accomplished by constructing a URL to the IRM.net with the selection values passed in as query string parameters. The resulting IRM.net page can either be displayed in a new browser tab/window or in an iframe within the marketing webpage. The IRM.net page address to be used in this scenario is http://irmserver.domain.com/irmnet/res/resmain.aspx. The following query string parameters are supported by IRM.net and can be appended to this URL:
| Parameter | Description | Example |
|---|---|---|
| Arrival | Search for availability with this Arrival Date. The Departure Date must also be passed. | Arrival=06/28/2008 |
| Departure | Search for availability with this Departure Date. The Arrival Date must also be passed. | Departure=06/30/2008 |
| LocationCode | Search for rooms with this location code (the location code passed in should be the subrecord value from the R3 table. Requires that the IRM.net configuration "Display Locations" checkbox be checked. | LocationCode=02 |
| People 1 | Search availability based on People1 count. | People1=2 |
| People 2 | Search availability based on People2 count. | People2=2 |
| People 3 | Search availability based on People3 count. | People3=1 |
| People 4 | Search availability based on People4 count. | People4=1 |
| PromoCode | Pass in a promotion code that has been configured and enabled. The rateplan associated with the promotion code will be quoted. | PromoCode=12345 |
| PropertyCode | Search for rooms with this property code (the property code passed in should be the subrecord value from the R2 table, for example 02 for Tower 2). Requires that the IRM.net configuration "Display Property Code" checkbox be checked. | PropertyCode=01 |
| RoomType | Search for rooms of this room type (the room type passed in should be the subrecord value from the C2 table (i.e., 2B for two-bedroom). Requires the IRM.net configuration Hide Room Type Choices checkbox to be unchecked. | RoomType=DD |
| RoomNum | Search for specific rooms.
Requires the IRM.net configuration
Hide Room
Number Choices checkbox to be unchecked and preassign reservations
are required. (See below for information on linking to a room when
the Hide Room Number Choices checkbox is checked.) |
RoomNum=102 |
| Request1 | Corresponds to the first guest preference configured in RDPWin Reservations | Configuration | Preferences tab. Pass in the short value. Any combination of guest requests can be passed in. | Request1=1BR |
| Request2 | Corresponds to the second guest preference configured in RDPWin Reservations | Configuration | Preferences tab. Pass in the short value. Any combination of guest requests can be passed in. | Request2=VV |
| & Request3 - Request9 | Corresponds to the third through ninth guest preferences configured in RDPWin Reservations | Configuration | Preferences tab. Pass in the short value. Any combination of guest requests can be passed in. | |
| Resort | In the case of a data server with multiple resort directories, specify which resort directory to search for availability. The default is RDP01. Pass in only the resort number (excluding the text "RDP"). | Resort=02 |
The syntax for specifying query string parameters on a URL is to add them as name=value pairs, separated by an ampersand characters (&). Follow the page address with a question mark (?) then add the query string parameters. For example: http:// irmserver.domain.com/irmnet/res/resmain.aspx?Arrival=06/28/2008&Departure=06/30/2008&Request2=VV.
Sample page including IRM.net in an iframe:
An 'inline frame' places an HTML document (in this case an IRM.net page) in a
frame inside a non-framed HTML document. There are numerous sources online for
more information about iframes and the appropriate syntax. Setting up the marketing website to pass search criteria to the IRM.net can be
accomplished with a combination of HTML and
JavaScript and does require web
programming expertise. The following is provided as a sample.
Note: This sample is for illustration purposes only and is not
supported by RDP.
View Functioning Sample
Download the sample files. SearchCriteriaSample.zip includes the
following files:
| Sample File | Description |
|---|---|
| index.html | Sample page including HTML drop-down boxes to implement the guest preference selections, JavaScript calendars to implement the arrival and departure date selections, an HTML anchor tag to implement the search button, and an iframe within which the IRM.net is displayed. |
| jsIRM/callIRM.js | JavaScript to construct the URL to the IRM.net including query string parameters based on the selections made. Displays the IRM.net in the iframe in index.html. |
| jscalendar/* | Open source JavaScript calendar implementing the arrival and departure calendars. |
| jsIRM/setupCalendars.js | JavaScript to initialize the arrival and departure date calendars./td> |
| Images/* | Search button image |
| IRM.net and RDP Overview Links | |
|---|---|
| RDPWin | RDP-DOS | IRM/IRM.Net | Open A Web Support Ticket |
|---|---|---|---|
| Version 2 | Upgrade to RDPWin | Link to Marketing Site | Contact Us |
| Training | 3rd Party Interfaces | Troubleshooting | RDP Sales |
