|
Below are a list of attributes available for each tag when using als_create_reservation.cgi
All attributes require double quotes : Name="example"
<?xml version="1.0" encoding="utf-16"?>
<root>
<reservation>
<row hotel="24" date="2010-05-12" lastname="Garland" firstName="Steve" notes="This is a note"
email="steve@activitylinksystems.com" fax="faxphone" homephone="homephone" time="17:00"
phonecell="cellphone" otherphone="otherphone" />
</reservation>
<products>
<row product="1" productcategory="1" qty="2"/>
<row product="1" productcategory="5" qty="1"/>
</products>
<seats>
<row productcategory="1" itemno="1" lastName="Jones" firstName="Roger" weight="201" weighttype="1" age="41"/>
<row productcategory="1" itemno="2" lastName="Jones" firstName="Sarah" weight="125" weighttype="1" age="36"/>
<row productcategory="5" itemno="1" lastName="Jones" firstName="Jimmy" weight="70" weighttype="1" age="8"/>
</seats>
<queue>
<row queuetype="56" note="this is a sample note for webreview" />
<row queuetype="57" note="this is a sample note for require pickup" />
</queue>
</root>
reservation
Attribute
|
Optional
|
Description
|
Example
|
lastname
|
Required
|
Last name used on the reservation
|
lastname="Smith"
|
firstname
|
Required
|
First Name used on the reservation
|
firstname="John"
|
date
|
Required
|
Date of the event. Must match the required event date or is used along with the time to lookup an event with sufficient seating as defined in the products.
|
date="2010-07-04"
|
event
|
Required
|
Value returned from the eventcode when getting availabilty via als_get_events.cgi . If the date does not match the event choosen an error will be returned.
|
event="7832"
|
time
|
Required if not using an event
|
Used only if an event is not passed in.
|
time="17:00"
|
notes
|
Optional
|
Internal notes for the reservation
|
Notes="Jack is elderly and needs help"
|
email
|
Optional
|
Email address
|
email="steve@activitylinksystems.com"
|
fax
|
Optional
|
Fax number
|
fax="faxphone"
|
homephone
|
Optional
|
Home Phone Number
|
homephone="homephone"
|
phonecell
|
Optional
|
Cell Phone Number
|
phonecell="cellphone"
|
otherphone
|
Optional
|
Other Phone Number
|
otherphone="otherphone"
|
span
|
Optional
|
Allows for events to be booked that span multiple events. If 10 Seats are required and only 7 are available on a singe event then if another event with 3 is available the reservation will be created using 2 events for that leg.
|
span=true
|
noalt
|
Optional
|
If a package event includes an alternate time then alternate times maybe used. Using noalt supresses this option
|
noalt=true
|
products
Attribute
|
Optional
|
Description
|
Example
|
product
|
Required
|
product choosen for the reservation. see als_get_products.cgi
|
product="1"
|
productcategory
|
Required
|
als_get_rates.cgi returns categorycode values. This is used for the productcategory param.
|
productcategory="9"
|
qty
|
Required
|
Quantity of the productcategory requested. If the item is a seated item, then an seat entry is created for Qty number of the product category.
|
qty="2"
|
targetprice
|
optional
|
allows a targetprice to be defined and the discount will be calculated in order to back into the targetprice. The targetprice should include all taxes and fees.
|
targetprice=189.00
|
discount
|
optional
|
applies a discount to the set price.
Note: targetprice and discount cannot be used concurrently. If they both have values an error will be returned.
|
discount=20.00
|
seats
Seating information is optional. When a reservation is created seating entries are created one each for each product Qty that is defined as a seat. Thus in the example below there are 3 entries for the total qty of seats requested as 2+1.
Items that are not defined as seats do not use a seat entry.
<products>
<row product="1" productcategory="1" qty="2"/>
<row product="1" productcategory="5" qty="1"/>
</products>
<seats>
<row productcategory="1" itemno="1" lastName="Jones" firstName="Roger" weight="201" weighttype="1" age="41"/>
<row productcategory="1" itemno="2" lastName="Jones" firstName="Sarah" weight="125" weighttype="1" age="36"/>
<row productcategory="5" itemno="1" lastName="Jones" firstName="Jimmy" weight="70" weighttype="1" age="8"/>
</seats>
Attribute
|
Optional
|
Description
|
Example
|
productcategory
|
Required
|
Must match the productcategory contained in the products tag
|
product="1"
|
itemno
|
Required
|
Ordinal from 1 to Qty times for each product category. Thus if you have qty=2 in a products entry there would be 2 entr
|
itemno="1"
|
lastname
|
Optional
|
Last Name of the Passenger. Defaulted to the last name of the person as defined in the reservation tag
|
lastname="Smith"
|
firstname
|
Optional
|
First Name of the Passenger
|
firstname="Jerry"
|
weight
|
Optional
|
Weight of the Passenger. Only used if your AL-Pro system supports weights
|
weight="170"
|
weighttype
|
Optional
|
Weight Types as defined in als_get_weight_types.cgi
|
weighttype="1"
|
age
|
Optional
|
Only supported if your AL-Pro system is supports AGE on seating
|
age="36"
|
queue entries are optional and implements the als_insert_queue.cgi interface which inserts a queue entry. The call requires a reservation:integer and a queuetype:Integer. Entries made with this call can be retrieved with als_get_queues.cgi
Parameter
|
Description
|
Required
|
Example
|
Data Type
|
Reservation
|
Code of the Reservation
|
Required
|
reservation=54232
|
Integer
|
QueueType
|
QueueType using one of the codes returned from als_get_queue_types.cgi
|
Required
|
queuetype=56
|
Integer
|
usercode
|
The code of the user making the entry. The default webportal settings will be used to fetch the usercode.
|
Optional
|
usercode=23
|
Integer
|
note
|
An optional text field that can be populated
|
Optional
|
notes=Sample text
|
String
|
|