XML Format

Top  Previous  Next

The AL-Desk Web Portal Server uses XML to return data from the AL-Desk Database. All Web portal calls support the concept of pagesize in order to support the concept of additional result sites displayed on other pages.

 

 

XML can be formatted using Attributes or Elements. The Server can be configured to return the format that you want to use or each call can be customized using the xmlformat http param option where the value of xmlformat is iether attributes or elements

 

http://www.alstracker.dnsalias.com/aldesk/als_get_locations.cgi?xmlformat=attributes

 

http://www.alstracker.dnsalias.com/aldesk/als_get_locations.cgi?xmlformat=elements

 

If omitted the format will be that as defined on the server.

 

xmlformat

 

The XML will contain an Element that describes the data and then a data count , followed by a row element with the fields returned for the server method.

 

There are some optional Parameters valid for all XML requests that can bring back debug information.

 

Since some calls can return more than one result set, the structure of the XML is as follows

 

<root>

 <description>

   <row> Data here</>

 </description>

 <description2>

   <row> Data Here </>

 <description2>

   <row> Data Here </>

 </description2>

</root>

 

http://www.alstracker.dnsalias.com/aldesk/als_get_locations.cgi?xmlformat=attributes

 

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

- <root> 

- <locations> 

<row locationname="Big Island" code="1" /> 

<row locationname="Kauai" code="7" /> 

<row locationname="Maui" code="3" /> 

<row locationname="Oahu" code="6" /> 

</locations> 

</root>

[****]

http://www.alstracker.dnsalias.com/aldesk/als_get_locations.cgi?xmlformat=elements

 

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

- <root> 

- <locations> 

- <row> 

<locationname>Big Island</locationname> 

<code>1</code> 

</row> 

- <row> 

<locationname>Kauai</locationname> 

<code>7</code> 

</row> 

- <row> 

<locationname>Maui</locationname> 

<code>3</code> 

</row> 

- <row> 

<locationname>Oahu</locationname> 

<code>6</code> 

</row> 

</locations> 

</root>

 

 

For Development and debugging purposes an html format is also provided

 

 

http://www.alstracker.dnsalias.com/aldesk/als_get_locations.cgi?xmlformat=html

 

 

Locations

LocationName

code

Big Island

1

Kauai

7

Maui

3

Oahu

6