als_create_reservation.cgi

 Top  Previous  Next

als_create_reservation.cgi allows a reservation to be created in one call by using XML rather than http params. The XML format consists of 4 tags:

 

Reminder: XML is case sensitive and all attributes are lower case.

 

Tag

Description

root

Base tag that encompasses all other tags

reservation

Reservation information include a valid event and matching date or date and time and will attempt to find an event based on the product elements.

 

products

Product information including the product, productcategory and qty

seats

Optional Seat information that allows for seat detail to be defined

queue

Optional entry for Queues

 

Since this is an XML call there are no params. All of the params supported by als_insert_reservation.cgi are supported in this XML call and must be included as part of the reservation tag.

 

Event Lookup option:

       Normally an event:Integer is passed into the als_insert_reservation.cgi but als_create_reservation.cgi adds another feature to allow the date+Time+products information to check if the products tour is available at the designated date/time and there is sufficient availability.

 

This means that you can either use, in the reservation tag both the Event and Date. Required items in red.

 

<reservation>

event="YourEventCode" date="2010-06-01" .../>

</reservation>

 

Or pass in the Date and the time where the webportal will then attempt to find an event with sufficient seating using the Date+Time+ the product attribute as passed in as part of the products tag.

<reservation>

<row= date="2010-06-01" time="17:15" ..../>

</reservation>

<products>

<row product="1" productcategory="1" qty="2"/>

</products>

 

A successful call will return the same xml as if using

 

als_get_reservation.cgi?reservation=YourResNumber&complete=true

 

 

This call is required to use HTTP POST rather than GET.

 

XML Detailed Explanation

Errors

 

<?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="2"/>

<row product="1" productcategory="9" 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"/>

</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>