als_get_products.cgi

 Top  Previous  Next

Description

The als_get_products.cgi interface retrieves all products available to in your system based on a base the associated AL-Pro code for the product.

 

 

Example Usage              http://127.0.0.1/als_get_products.cgi

 

 

 

 

Inputs

Parameter

Description

Required

Example

Data Type

Base

Base Code see

 

als_get_bases.cgi

 

 

Optional

base=1

Integer

Group

Group Code see

 

als_get_product_groups.cgi

 

Optional

group=2

Integer

content

Brings over content management data available from CMS

Optional

content=true

Boolean

package

Shows whether a product is part of a package (multi component product)

Optional

package=true

Boolean

productinfo

Brings over description fields that are formatted as RTF

Optional

productinfo=true

Boolean

html

Formats SalesInfo RTF formatted data as html

 

Valid only when used with productinfo param.

 

Optional

html=true

Boolean

 

 

Returned Fields

#

Field Name

Description

Data Type

1

Code

AL-Pro Associated Code

Integer

2

ProductName

Name of the Product

String

3

ProductShortName

Abbreviation Name for the Product

String

4

BaseCode

AL-Pro Associated Code for Base

Integer

5

BaseName

Name of the Base

String

3

GroupName

Name of the Group

String

4

GroupCode

AL-Pro Associated Code for group

Integer

 

Example XML

 

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

- <products> 

- <data count="9"> 

<row code="1" productname="Celebration Tour" productshortname="LC2" basecode="1" basename="Las Vegas" groupname="Champ" groupcode="2" /> 

<row code="2" productname="Grand Celebration" productshortname="LC1" basecode="1" basename="Las Vegas" groupname="Champ" groupcode="2" /> 

<row code="3" productname="Canyon VIP High Roller" productshortname="LC7" basecode="1" basename="Las Vegas" groupname="Champ" groupcode="2" /> 

<row code="5" productname="Sunset Grand Celebration" productshortname="LC1S" basecode="1" basename="Las Vegas" groupname="Champ" groupcode="2" /> 

<row code="9" productname="Grand Canyon Wedding" productshortname="LW-1" basecode="1" basename="Las Vegas" groupname="Champ" groupcode="2" /> 

<row code="37" productname="Grand Celebration With Limo Transfers" productshortname="LC-1X" basecode="1" basename="Las Vegas" groupname="Champ" groupcode="2" /> 

<row code="38" productname="Sunset Grand Celebration With Limo Txfr" productshortname="LC1SX" basecode="1" basename="Las Vegas" groupname="Champ" groupcode="2" /> 

<row code="51" productname="Daybreak Grand Celebration" productshortname="LC-1B" basecode="1" basename="Las Vegas" groupname="Champ" groupcode="2" /> 

<row code="52" productname="Helicopter Canyon Super Saver" productshortname="LC1SS" basecode="1" basename="Las Vegas" groupname="Champ" groupcode="2" /> 

</data> 

</products>