Field Name |
Value |
Default Value |
Description |
| site |
websearch.ramaui.com |
none |
The url of the XML server |
| location |
/ramxml.php |
none |
The script to talk to |
| method |
short |
none |
The remote method to invoke |
| DBID |
DBID assigned by RAM |
none |
DBID assigned by RAM |
|
| WhatPage |
|
1 |
Page of data to return |
| WhatNumber |
|
200 |
Number of listings to return
Max number is 200 |
| WhatMLS |
|
None |
Comma delimited list of mls numbers. |
| WhatPropType |
|
If no value is passed, the default is all property types. If WhatCondo is passed, the default is Condominium. If WhatOhana is passed, the default is Residential. |
Array
- Residential
- Vacant Land
- Condominium
- Commercial
- Business
- Time Interval
- Multi-Dwelling Res
|
| WhatWater |
|
All |
Array
- OceanFront
- BeachFront
- Across Street from Ocean
|
| WhatOhana |
|
All |
Array
- Single Family
- Single Family w/Att Ohana
- SF w/Det Ohana or Cottage
|
| WhatCondo |
|
All |
Array
See Condo List |
| WhatStartPrice |
|
No Lower Limit |
Price (Integer) |
| WhatEndPrice |
|
No Upper Limit |
Price (Integer) |
| WhatView |
|
All |
Array
- Ocean
- Mountain
- Mountain/Ocean
- Golf Course
- Garden View
|
| WhatDistrict |
|
All |
Array
See District List |
| WhatLandTenure |
|
All |
Array
- Fee Simple
- Leasehold
- Leasehold-FA
|
| WhatAgent |
|
All |
Array
See Agent List (Use agent ID number) |
| WhatOffice |
|
All |
Array
See Office List (Use Office ID Number) |
| WhatStartBed |
|
No Lower Limit |
Integer |
| WhatEndBed |
|
No Upper Limit |
Integer |
| WhatStartBath |
|
No Lower Limit |
Integer |
| WhatEndBath |
|
No Upper Limit |
Integer |
| WhatStartIntArea |
|
No Lower Limit |
Integer (Square Feet) |
| WhatEndIntArea |
|
No Upper Limit |
Integer (Square Feet) |
| WhatStartExtArea |
|
No Lower Limit |
Integer (Square Feet) |
| WhatEndExtArea |
|
No Upper Limit |
Integer (Square Feet) |
| WhatDiv |
|
Any |
|
| WhatZone |
|
Any |
Array |
| WhatSec |
|
Any |
Array |
| WhatPlat |
|
Any |
Array |
| WhatPar |
|
Any |
Array |
| WhatStartDate |
|
Any |
List Date in the format:
Year-Month-Day
(xxxx-xx-xx)
|
| WhatEndDate |
|
Any |
List Date in the format:
Year-Month-Day
(xxxx-xx-xx) |
| WhatSortType1 |
|
MLS Number |
You may sort by any field returned.
|
| WhatSortDirection1 |
|
Ascending |
Direction to sort by, ASC or DESC |
| WhatSortType2 |
|
None |
You may include a secondary sort using any field returned.
|
| WhatSortDirection2 |
|
None |
Direction for secondary sort, ASC or DESC |
The XML response will be in the format:
[0] => Number of listings
[1] => Page number
[2] => Number of pages
[3] => Search time
[4] => Listings array
[0] => Array
[MLS] => xxxxxx
[Class] =>
[ListPrice] =>
[ListDate] =>
[District] =>
[BuildingName] =>
[Beds] =>
[Baths] =>
[Image] =>
[1] => Array
[MLS] => xxxxxx
etc.
[5] => Disclaimer