als_get_block_availability.cgi

Top  Previous  Next

Description

The als_get_block_availability.cgi web service is the key API method used to retrieve information about availability of seats on a specific date.

 

A StartDate and EndDate is required for this method

 

Example Usage             http://www.alstracker.dnsalias.com/aldesk/als_get_block_availability.cgi?startdate=2005-11-18&enddate=2005-11-18

 

Inputs

Parameter

Description

Required

Example

Data Type

startdate

StartDate of block is greater than or equal to this date

Required

startdate=2005-11-08

Date

enddate

EndDate of block is less than  than or equal to this date

Required

enddate=2005-11-25

Date

blockno

Unique Block Identifier

Optional

blockno=19

Integer

product

Product Code

Optional

product=321

Integer

vendor

Vendor Code

Optional

vendor=432

Integer

time

Time

Optional

time=10:00

Time

location

Location Code

Optional

location=3

Integer

used

Used on Vouchers

Optional

used=4

Integer

category

Category Code

Optional

category=1

Integer

vouchers

If true will add another namespace that includes voucher information that composes the Used number of seats

 

Optional

vouchers=true

Boolean

available

Filter that allows a query as to available seats. Available is quantity-used on vouchers.

 

Optional

available=3

Integer

futuredays

Attempts to find a block definition by checking FutureDays:Integer days into the future until an available block is found

 

Optional

futuredays=30

Integer

 

 

Returned Fields

#

Field Name

Description

Data Type

1

 



2




 

 

 

 

 

XML Example

 

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

- <root>

<Inputs startdate="2005-11-18" enddate="2005-11-18" vendor="1" vouchers="true" params="true" available="7" />

- <blocks>

<row code="19" vendor="1" product="1" productname="Hana/Haleakala- A Star" category="7" date="11/18/2005" qty="10" ablocksqty="0" time="10:00:00 AM" blocknotes="demo" daysleft="0" adjustment="0" used="3" available="7" timeleft="10:31:00 PM" />

</blocks>

- <vouchers>

<row voucher="20578" blockno="19" product="1" quantity="3" actdate="11/18/2005" clientname="Gater, Duke" productname="Hana/Haleakala- A Star" prodratename="Adult" locationname="Maui" agencyname="Mike Grinberg" prodrate="1" issuedate="11/5/2005" total="609.54" retailrate="189" tax="14.18" vendorrate="189" grossrate="203.18" giftdiscount="0" netrate="203.18" agency="58" />

</vouchers>

</root>