als_get_vessels.cgi

 Top  Previous  Next

 

Description

The als_get_vessels.cgi interface retrieves all vessels available to in your system based on a base the associated AL-Pro code for the base and on a give date.

 

 

 

Example Usage              http://127.0.0.1/als_get_vessels.cgi?base=1&date=20050901

 

 

 

 

Inputs

Parameter

Description

Required

Example

Data Type

Base

Base Code to limit the result set to a specific base

 

See also als_get_bases.cgi for Base Codes.

 

Optional

base=2

Integer

Date

Date of availability

Yes

date=2005-09-01

Date

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

 

Returned Fields

#

Field Name

Description

Data Type

1

Code

AL-Pro Associated Code

Integer

2

VesselName

Name of the Vessel

String

3

ShortName

Short Name of the Vessel

String

4

Capacity

Capacity of the Vessel

Integer

6

BaseCode

AL-Pro Associated Code

Integer

7

BaseName

Base Name

String

 

XML example

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

- <vessels> 

- <data count="9"> 

<row code="12" vesselname="N138PH-44" shortname="44" capacity="7" base="1" basename="Las Vegas" /> 

<row code="2" vesselname="N137PH-40" shortname="40" capacity="7" base="1" basename="Las Vegas" /> 

<row code="11" vesselname="N453NW-26" shortname="26" capacity="6" base="1" basename="Las Vegas" /> 

<row code="4" vesselname="N135PH-39" shortname="39" capacity="7" base="1" basename="Las Vegas" /> 

<row code="36" vesselname="N136PH-46" shortname="46" capacity="7" base="1" basename="Las Vegas" /> 

<row code="3" vesselname="N6093R-25" shortname="25" capacity="6" base="1" basename="Las Vegas" /> 

<row code="5" vesselname="N130PH-38" shortname="38" capacity="6" base="1" basename="Las Vegas" /> 

<row code="1" vesselname="N32PM-31" shortname="31" capacity="6" base="1" basename="Las Vegas" /> 

<row code="7" vesselname="N170PA-36" shortname="36" capacity="6" base="1" basename="Las Vegas" /> 

</data> 

</vessels>