als_get_reservation.cgi

Top  Previous  Next

Description

The als_get_reservation interface will retrieve reservation information.

 

You must either send a reservation, event or date param to use this method. By default the maximum number of rows returned is set to 250

 

 

Example Usage    http://192.168.0.19/als_get_reservation.cgi?reservation=8600        

 

 

 

Inputs

Parameter

Description

Required

Example

Data Type

Reservation

Reservation code to limit the result to a specific reservation

 

date,event or reservation required

reservation=8600

Integer

Complete

Brings over additional Product, Seat and Payment information tied to the reservation providing a complete picture of parts of a reservation.

 

Optional

complete=true

Boolean

tour

Tour Code

Optional

tour=103

Integer

event

Event code

date,event or reservation required

event=4521

Integer

date

Date of the Reservation

date,event or reservation required

date=2009-03-23

date

active

Active. By default only active reservations are returned.

 

Optional

active=0

Boolean

agency

Agency

Optional

agency=32

Integer

clientname

Portion of the client name can be submitted and any sub-string of the fullname will be compared

Optional

clientname=Jones

String

compact

Returns a subset of available fields

Optional

compact=true

Boolean

hotel

Hotel Code

Optional

hotel-32

Integer

time

Time of the Tour

Optional

time=11:00

Time

agent

Agent

Optional

agent=32

Integer

rows

Max rows to return. Default is max 250.

Optional

rows=500

Integer

 

 

 

 

Returned Fields

#

Field Name

Description

Data Type

1




2




3.




4.




5




6




 

xml format

<?xml version="1.0" encoding="utf-8" ?> 

- <reservations> 

- <data count="1"> 

<row code="67633" clientname="Garland, Brenda" agencyname="Intair Vacances" hotelname="Airport- G C N" defatour="" tourname="" quantity="" gross="" totaltax="" total="" net="" collectoncheckin="" billamount="" base="1" agent="868" agency="46" hotel="169" pickup="False" pickuptime="" dropoff="False" dropofftime="" dropoffhotel="" hotelphone="" manifestnotes="" email="" fax="" guarantee="" cancellationno="" giftcert="True" noshow="False" waitlist="False" otherphone="" room="" tourdate="" waitlistthroughdate="9/30/2006" reservationnotes="" /> 

</data> 

</reservations>