als_get_categories.cgi

 Top  Previous  Next

Description

The als_get_categories.cgi interface all retrieve all categories available to in your system based on products that are active and web enabled. i.e (Helicopter, Scuba Diving, Luau ), and the associated AL-Desk code for the category. Optionally you can limit the results to a specific Location by using a location input parameter.

 

 

Example Usage              http://127.0.0.1/als_get_categories.cgi

 

 

 

Inputs

Parameter

Description

Required

Example

Data Type

Location

Location Code to limit the result set to a specific location

 

See also als_get_locations.cgi for Location Codes.

 

Optional

location=5

Integer

IncludeDesc

Brings over text description and image path if included

 

Optional

includedesc=true

Boolean

CategoryGroup

 

CategoryGroup Code to limit the result to a specific CategoryGroup

 

See also als_get_category_groups.cgi for Category Group Codes

 

Optional

categorygroup=2

integer

imageurl

Brings of imagpath field

Optional

imageurl=true

True

 

 

Returned Fields

#

Field Name

Description

Data Type

1

Name

Name of the Category

String

2

Code

AL-Desk Associated Code

Integer

3

CategoryGroup

CategoryGroup Code

Integer

4

CategoryGroup Name

Name of the Category Group

String

 

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

- <root>

- <categories>

<row code="27" name="Attractions" categorygroup="2" categorygroupname="Land" />

<row code="43" name="ATV(All-Terrain Vehicle) Tours" categorygroup="2" categorygroupname="Land" />

<row code="1" name="Biking Tours" categorygroup="2" categorygroupname="Land" />

<row code="2" name="Boat (Not for Products)" categorygroup="3" categorygroupname="Sea" />

</categories>

</root>