Nov 1, 1999 Interface Guideline for Online Interface
transfer files
These transfer files are in a plain ASCII format, and
are placed in a directory where the First Resort Online
interface server will read them. They must be named with
the file extension .IN. The First Resort Online
interface server will read the transfer files, rename
the file extension from .IN to .INX, and produce an
output file with the same name, but with a file
extension of .OUT. The First Resort Online interface
server must be operating for this process to occur.
The first Line of each interface .IN file must have
in its first line both the keyword TYPE= and the value
for the type of function the process is to perform.
Currently the valid types of functions
are
TYPE=RSAVAIL
TYPE=RSBOOK
TYPE=RSGUESTLU
TYPE=RSPROPLU
TYPE=RSAVAILOPT
TYPE=RSINQUIRY
RSAVAIL - make an availability request
IN file values
The following fields may be used in the interface
transfer .IN file to make an availability request.
|
Example |
Required |
Description |
| TYPE |
RSAVAIL |
Yes |
|
| ARRMONTH |
|
Yes |
Month of Arrival
(Jan,Feb,Mar...Dec) |
| ARRMO |
|
Yes |
Month of Arrival
(1,2,3...12) |
| ARRDAY |
|
Yes |
Day of Arrival (1,2,3...31) |
| ARRYEAR |
|
Yes |
Year of Arrival
(1997,1998...2020) |
| NIGHTS |
|
Yes |
Number of Nights(1,2,3...20) |
| DEPMONTH |
|
|
Month of Departure |
| DEPMO |
|
|
Month of Departure(1,2,3…12) |
| DEPDAY |
|
|
Day of Departure(1,2,3…31) |
| DEPYEAR |
|
|
Year of Departure(1997,1998) |
| UNITTYPE1...5 |
|
|
Key that matches either letter of
desc of avail spec |
| GREATER1...15 |
|
|
YN if key can search of greater
that selected avail |
| SELECTUNIT |
|
|
Specificy availability for one
unit |
| RATEGROUP |
|
|
Rate group to use when calculating
rate |
| ADULTS |
|
|
Number of adults |
| FREECHILD |
|
|
Number of no-charge children |
| AFTERUNIT |
|
|
Find the first available unit
after this unit |
| PREVUNIT |
|
|
Find the previous available unit
after this unit |
| SEARCHSEQ |
|
|
Sequence to search for available
unit YBSF |
| SEARCHBLOCK |
|
|
Search blocks for availability
(Yes,No,Only,Part) |
| BLOCKID |
|
|
ID of block to search with Only
block is selected |
| ALLOWFREEB |
|
|
Y=Allow availability with zero
rate to be displayed |
| ALLOWARR |
|
|
Only allow arrivals on these dates
(0=Monday,456) |
| SELECTARR |
|
|
Conversion to translate days
(0123456) to chars in avail table |
| PROPLIST |
|
|
send YES to retrive list of all
properties in system |
| PASSWORD |
|
|
Send in SSN of owner, will return
KEYMATCH=YES if correct |
RSAVAIL - make an availability request
OUT file values
The following fields will be returned in the .OUT
file
|
|
|
|
| TYPE |
RSAVAILNO/RSAVAILYES |
|
|
| MESSAGE |
|
First two characters of Message
indicate error code of why unit is not
available |
|
| SELECTUNIT |
|
Available Unit Selected |
|
| UNITADDR1...2 |
|
Unit Address |
|
| DESC1...4 |
|
Unit Description |
|
| RATETOT |
|
Rate Total |
|
| TAXTOT |
|
Tax Total |
|
| RATETAX |
|
Rate + Tax |
|
| EXTRAAMT |
|
Add on Amounts (Travel
Insurance) |
|
| STAYTOT |
|
Total for stay |
|
| DUE1AMT |
|
Deposit 1 amount Due |
|
| ARRMONTH |
|
|
|
| ARRDAY |
|
|
|
| ARRYEAR |
|
|
|
| NIGHTS |
|
|
|
| DEPMONTH |
|
|
|
| DEPDAY |
|
|
|
| DEPYEAR |
|
|
|
| RATEGROUP |
|
Rate Group |
|
| ADULTS |
|
|
|
| CHILDREN |
|
|
|
| UNITTYPE1..15 |
*Only when SELECTUNIT |
Selection criteria for this
unit |
|
| CALH1M1...2 |
*Only when SELECTUNIT |
Calendar Heading Line 1 |
|
| CALH2M1...2 |
*Only when SELECTUNIT |
Calendar Heading Line 2 |
|
| CALH3M1...2 |
*Only when SELECTUNIT |
Calendar Heading Line 3 |
|
| CALSTM1...2 |
*Only when SELECTUNIT |
Calendar Heading Line 4 |
|
RSBOOK - making a reservation booking
IN file values
The following fields may be used in the interface
transfer .IN file to make a booking.
|
|
Required |
Description |
| TYPE |
RSBOOK |
Yes |
|
| ARRMONTH |
|
Yes |
Arrival Month
(Jan,Feb,Mar...Dec) |
| ARRDAY |
|
Yes |
Day of Arival(1,2,3...30) |
| ARRYEAR |
|
Yes |
Year of
Arrival(1997,1998,1999...2020) |
| NIGHTS |
|
Yes |
Number of Nights(1,2,3...30) |
| SELECTUNIT |
|
Yes |
Unit code that is being
booked |
| BEDROOMS |
|
|
Bedrooms (for non specific unit
booking) |
| BATHS |
|
|
Bathrooms (for non specific unit
bookings) |
| LNAME |
|
Yes |
|
| FNAME |
|
|
|
| ADDRESS1...3 |
|
|
|
| CITY |
|
|
|
| STATE |
|
|
|
| ZIP |
|
|
|
| HPHONE |
|
|
Home Phone |
| BPHONE |
|
|
Business Phone |
| FPHONE |
|
|
Fax Phone |
| COMMENT1 |
|
|
Comment Field |
| CCTYPE |
|
|
Two Character credit card type
(VI,MC,DC) |
| DEPOSITMETHOD |
|
|
Use 'CC' to require credit card,
CK for check, OR or NO for other |
| CCNUMBER |
|
|
credit card number |
| CCEXPMONTH |
|
|
credit card expire month |
| CCEXPYEAR |
|
|
credit card expire year |
| CCNAMEOF |
|
|
Name on credit card |
| RATEGROUP |
|
|
Rate group code |
| ADULTS |
|
|
Number of adults |
| CHILDREN |
|
|
Number of children |
| FREECHILD |
|
|
Number of no-charge children |
| AGENT1 |
|
|
Travel Agent #1 IATA number |
| AGENT2 |
|
|
Travel Agent #2 IATA number |
| SOURCE1..2 |
|
|
Source Codes of booking |
| EMAIL |
|
|
E-mail address |
| CRSREF |
|
|
Central Reservations ID
number |
RSBOOK - making a reservation booking
OUT file
values
|
|
|
|
TYPE
| RSBOOKYES/RSBOOKNO |
|
|
| MESSAGE |
|
|
Error Message why booking failed |
| ARRMONTH |
|
|
Arrival Month |
|
|
|
|
| ARRYEAR |
|
|
|
| DEPMONTH |
|
|
Departure Month |
| DEPDAY |
|
|
|
| DEPYEAR |
|
|
|
| FOLIO |
|
|
|
| LNAME |
|
|
|
| FNAME |
|
|
|
| ADDRESS1...3 |
|
|
|
| CITY |
|
|
|
| STATE |
|
|
|
| ZIP |
|
|
|
| HPHONE |
|
|
Home Phone |
| BPHONE |
|
|
Business Phone |
| FPHONE |
|
|
Fax Phone |
| SELECTUNIT |
|
|
Unit Booked |
| UNITADDR1...2 |
|
|
Address of the unit |
| DESC1...4 |
|
|
Description of the unit |
| RATETOT |
|
|
Room rate total less taxs and
add-ons |
| TAXTOT |
|
|
Total of the Tax |
| RATETAX |
|
|
Rate + Tax total |
| EXTRAAMT |
|
|
Total amount for add-ons, booking
fees, cleaning charges |
| EXTRDESC1..2 |
|
|
Description for each add-on |
| EXTRAAMT1..2 |
|
|
Amount charges for each
add-on |
| STAYTOT |
|
|
Total for the stay including
add-ons |
| DUE1AMT |
|
|
1st deposit due amt |
| ADULTS |
|
|
Number of adults booked |
| CHILDREN |
|
|
Number of children booked |
| RATEGROUP |
|
|
Rate Group Code (2 char) |
| UNITTYPE1...15 |
|
|
Unit type descriptions |
| CCTYPE |
|
|
Credit Card Type |
| CCNAMEOF |
|
|
Credit Card Name |
| CRSREF |
|
|
Central Res Reference Number |
| VERSION |
|
|
Version of First Resort running
server |
| ORGNAME |
|
|
Company Name from First Resort
Data |
| ORGPHONE |
|
|
Company Phone from First Resort
Data |
RSGUESTLU - Looking up
guest information
IN file values
|
|
|
|
| TYPE |
yes |
RSGUESTLU |
|
| FOLIO |
|
|
First Resort Folio number |
| ARRMONTH |
|
|
Arrival Month |
| ARRDAY |
|
|
Arrival Day |
| ARRYEAR |
|
|
Arrival Year |
| SELECTUNIT |
|
|
Unit Selected |
| LNAME |
|
|
Last Name |
| FNAME |
|
|
First Name |
| AFTERFOLIO |
|
|
Find the next guest after this folio |
| PASSWORD |
|
|
Social Security number of 1st owner of unit
|
| ORDERBY |
|
|
ARRIVAL, DEPARTURE, NAME, PROPERTY |
| DIRECTION |
|
|
FWRD, BACK, FIRST, LAST
|
RSGUESTLU - Looking up guest
information
OUT file values
|
|
|
|
| TYPE |
|
|
RSGUESTLUYES/RSGUESTLUNO |
| MESSAGE |
|
|
Error Message |
| ARRMONTH |
|
|
Arrival Month |
| ARRDAY |
|
|
Arrival Day |
| ARRYEAR |
|
|
Arrival Year |
| DEPMONTH |
|
|
Departure Month |
| DEPDAY |
|
|
Departure Day |
| DEPYEAR |
|
|
Departure Year |
| FOLIO |
|
|
Folio Number |
| LNAME |
|
|
Last Name |
| FNAME |
|
|
First Name |
| SELECTUNIT |
|
|
Selected Unit |
| ORDERBY |
|
|
Current Order(PROPERTY, NAME, ARRIVAL,
DEPARTURE, FOLIO) |
| STATUS |
|
|
Status(Open, Closed) |
| COMMENT |
|
|
Comment |
| KEYMATCH |
|
|
Yes if password matched SSN |
| ACTIVITY |
|
|
List of activities on this folio
|
RSPROPLU - Looking up property
information
IN file values
RSPROPLU - Looking up
property information
OUT file values
|
|
|
|
| TYPE |
|
|
RSPROPLUYES/RSPROPLUNO |
| MESSAGE |
|
|
Error Message |
RSAVAILOPT -
query the availability options for this business
IN file values
RSAVAILOPT - query the availability options for this
business
OUT file values
|
|
|
|
| TYPE |
|
|
RSAVAILOPT |
| MESSAGE |
|
|
error message |
| AR |
|
|
Years availability is built for |
| AH1..15 |
|
|
Heading for OPTION x |
| AG1..15 |
|
|
Greater than available for option x |
| AO1..15 |
|
|
Text of each availability option
|
RSINQUIRY - making a reservation inquiry
IN file
values
The following fields may be used in the interface
transfer .IN file to make an inquiry.
|
|
|
|
| TYPE |
RSINQUIRY |
|
|
| LNAME |
|
YES |
|
| FNAME |
|
YES |
|
| ADDRESS1...3 |
|
|
|
| CITY |
|
|
|
| STATE |
|
|
|
| ZIP |
|
|
|
| HPHONE |
|
|
|
| BPHONE |
|
|
|
| FPHONE |
|
|
|
| ARRMONTH |
|
|
|
| ARRDAY |
|
|
|
| ARRYEAR |
|
|
|
| BEDROOMS |
|
|
|
| BATHS |
|
|
|
| COMMENT1 |
|
|
|
| REQUEST1...4 |
|
|
|
| EMAIL |
|
|
|
| SOURCE1...2 |
|
|
|
RSINQUIRY - making a reservation inquiry
OUT file
values
The following fields will be returned in the .OUT
file
| TYPE |
RSINQYES/RSINQNO |
|
|
| MESSAGE |
|
|
|
| FOLIO |
|
|
|
| LNAME |
|
|
|
| FNAME |
|
|
|
| COMMENT1 |
|
|
|
