Aaxsys Notes
  More articles

Using the Ajax API - Appendix

Previous page

Query parameters for availres and availxml


Both availres and availxml may be used for creating xml output for availability listings. However, availres is primarily intended for interactive, direct html listings that do no need further formatting, and all features of availxml may not be supported in the future.

In the following, we will list the supported query parameters. Some of the parameters are query string parameters (GET) while several others are input field parameters (POST). Many can be used in both ways.

Query string parameters (GET)

  • V - Indicates the "member" (availability vendor) of the properties.
    Example: 
    http://www.aaxsys.com/availxml/
  cgi-bin/?V=AMSI-SF
  • CITY
    Example: 
    http://www.aaxsys.com/availxml/
  cgi-bin/?V=AMSI-SF&CITY=San%20Francisco
  • STATE (must correspond to the 2-character code used in the property record)
  • COUNTRY (must correspond to the value used in the property record. Aaxsys recommends using international 3-character codes, but this may not be followed by the users.)
  • REGION
  • Furnished (there are two possible values: "FURNISHED", "UNFURNISHED")
  • TYPE (use TYPE=XML to force XML output in availres)
  • F (use F=< template file name > to indicate that the output is to be formatted by using a template)
  • Results (How many results to show? Possible values: a numeric value or "ALL")
  • BeginDate (the start date of the availbility query period - must be given in the format mm/dd/yyyy)
  • EndDate (the end date of the availability query period - must be given in the format mm/dd/yyyy)
  • Entity (a 2-character numeric code (00..99) for the department of the queried properties)
  • AVL - bundled member code for availability. This must be obtained from system administrators (not internal to a member)
  • OrderBy - used to indicate the property field for ordering the output. Here is a partial list of available field names: Bedrooms, Bathrooms, City, Region, State, Country, MRate, WRate, DRate)

Input field parameters (POST)

See the previous section for explanations.

  • VENDOR - The same as "V" above.
  • CITY
  • STATE
  • COUNTRY
  • REGION
  • ZIP (zip code)
  • MSA (metropolitan statistical area)
  • FURNISHED
  • TYPE
  • FILE (the same as "F" above)
  • RESULTS
  • BEGINDATE
    Posting the following three is an alternative to a single BEGINDATE:
  • BEGINDAY (1..31)
  • BEGINMONTH(1..12)
  • BEGINYEAR(YYYY)
  • ENDDATE
    Posting the following three is an alternative to a single ENDDATE:
  • ENDDAY (1..31)
  • ENDMONTH(1..12)
  • ENDYEAR(YYYY)
  • BEDROOMS (minimum number of bedrooms)
  • NEIGHBORHOOD
  • MAXMONTHLY (maximum rent per month)
  • MAXWEEKLY (maximum rent per week)
  • ACCOMMODATES (must accommodate at least this many guests)
  • ENTITY
  • AVLVENDORS (the same as "AVL" above)
  • ORDERBY - used