| XML Search Parameters | ||
| http://web.aspasia.net/pls/howards/aspasia_search.xml? | ||
| de | - | department, RS for residential sales or RL for residential lettings. defaults to RS |
| be | - | minimun number of bedrooms, must be a number with no formatting eg 3, defaults to 0 |
| pf | - | price from, must be a number with no formatting eg 100000, defaults to 0 |
| pt | - | price to, must be a number with no formatting eg 300000, defaults to 999999999 |
| rf | - | rent frequency, WEEK, MONTH, QUARTER, SIXMONTH, YEAR |
| pc | - | postcode prefix |
| lo | - | locations, must be from a select or multi select list or multi checkbox |
| tn | - | towns, must be from a select or multi select list or multi checkbox |
| re | - | minimum number of receptions, must be a number with no formatting eg 3, defaults to 0 |
| ba | - | minimum number of bathrooms, must be a number with no formatting eg 3, defaults to 0 |
| ty | - | property type codes, must be from a select or multi select list or multi checkbox, defaults to null (ie all records) |
| st | - | property style codes, must be from a select or multi select list or multi checkbox, defaults to null (ie all records) |
| se | - | property setting codes, must be from a select or multi select list or multi checkbox, defaults to null (ie all records) |
| ag | - | property age codes, must be from a select or multi select list or multi checkbox, defaults to null (ie all records) |
| fa | - | holiday lets available from date, must be format dd/mm/yyyy, defaults to null (ie all records) |
| ta | - | holiday lets available to date, must be format dd/mm/yyyy, defaults to null (ie all records) |
| pp | - | properties per page, must be a number with no formatting eg 10, defaults to 10 |
| pg | - | page number, must be a number with no formatting eg 1, defaults to 1 |
| od | - | order by. Options are AP (Ascending price) DP (Descending price) or T (Town), defaults to AP |
| upw | - | password to access the procedure, this is stored in the parameter PUB_SEARCH_XML_P |
DTD : http://web.aspasia.net/pls/howards/aspasia_search.dtd (please note that IE will often not show the text of the DTD, to view it please just "view source" of the page) | ||
Example XML : aspasia_search.xml This is a static example page, you can obviously call the live page on your system to give examples of the data. | ||
Details sheet. There is a url in the XML results that is for the public details sheet as set up on the agents system, should you wish to construct your own details sheet this XML file will generate all of the property elements http://web.aspasia.net/pls/howards/xml_export.xml?prn=N&pid= where pid is the property ID. | ||
| lists of look up values | ||
| It is very important that you understand the data you are looking at and use the wh parameter accordingly. Several of the lookup tables have data that is for Lettings and Sales so you would only want the relevant data. Also some look at all types of contract and only the data for the available properties is relevant for example. |
| XML | ||
| locations | locations | |
| towns | towns | |
| property type | property type | |
| property style | property style | |
| property setting | property setting | |
| property age | property age | |
| tenure types | tenure types | |
| contract status codes | contract status codes | |
| branches | branches | |
| HTML | ||
| locations | locations | |
| towns | towns | |
| property type | property type | |
| property style | property style | |
| property setting | property setting | |
| property age | property age | |
| tenure types | tenure types | |
| contract status codes | contract status codes | |
| branches | branches | |
| lookup parameters | ||
| http://web.aspasia.net/pls/howards/aspasia_lookup.data? | ||
| tb | - | table name |
| fn | - | name you want the field to be called in the HTML form |
| xm | - | show XML data, or html combo box, Y or N (defaults to N) |
| cl | - | style sheet class name, eg sellist (defaults to null) |
| ss | - | style sheet data, eg select {font-size: 12; color: red} (defaults to null) |
| ty | - | type, eg SELECT, CHECKBOX, RADIO (defaults to SELECT) |
| mu | - | is the combo box a multiple, MULTIPLE or N (defaults to MULTIPLE) |
| no | - | number of checkboxes per row OR size of the combo box (defaults to 8) |
| al | - | have an all checkbox (defaults to N) |
| de | - | show deleted records (defaults to N) |
| se | - | default selected value (defaults to null) If passed in will show this record selected even if it is deleted |
| wh | - | where clause. If you are passing this from a URL you need to use standard hex character replacements, eg %20 is a space. use URLENCODE on your string to get what you want to pass in. If you are calling from a procedure then you can just pass in the where string as plain text. If you are calling from a URL you can use urlencode() to get your where clause, eg urlencode('department = 'RL' and instr('¬'||ctyp_codes||'¬', '¬FML¬') > 0') To add additional where clause onto the select. The "where " will be put in automatically, you just need to add your clause. eg select * from t_close_reasons where department = 'RS' and instr('¬'||ctyp_codes||'¬', '¬PRS¬') > 0 so you need to pass in : department = 'RS' and instr('¬'||ctyp_codes||'¬', '¬PRS¬') > 0 |