als_get_vendors.cgi

 Top  Previous  Next

Description

The als_get_vendors.cgi web service will retrieve all vendors available to in your system based on products that are active and web enabled., and the associated AL-Desk code for the Vendors.

 

Example Usage             http://127.0.0.1/als_get_vendors.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

Category

Category Code to limit the result set to a specific category

 

See also als_get_categories.cgi for Category Codes

Optional

category=2

Integer

extendedinfo

Brings over additional fields that are available from the ALDesk Vendor Menu

 

Optional

extendedInfo=true

Boolean

vendor

Returns a single vendor

Optional

vendor=1

Integer

inactive

Used only if you are writing a vendor management system and need to handle vendors tagged as inactive

Optional

inactive=true

Boolean

 

 

 

 

 

 

 

Returned Fields

#

Field Name

Description

Data Type

1

Name

Name of the Vendor

String

2

Code

AL-Desk Associated Code

Integer

 

 

 

 

 

XML Example

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

- <root>

- <vendors>

<row code="470" name="Massage Therapy Network" />

<row code="395" name="A Na Pali Eco Adventures" />

<row code="403" name="AAA Diving" />

<row code="375" name="Aaron's Dive Shops of Hawaii" />

<row code="261" name="Absolute Sportfishing" />

<row code="507" name="Action Adventure Tours" />

<row code="437" name="Adventures In Paradise" />

<row code="53" name="Adventures On Horseback" />

</vendors>

</root