Property Types
Not all listing data is suitable for display.
The Property Types service returns a list of possible listing property types for the current user’s MLS.
When using the Listings Service, you must consult the corresponding meta data services (e.g. Property Types and Standard Fields) for the PropertyType standard field and any other field where the HasList is true in the meta data.
See an example here.
See an example here.
Supported Roles
| Role | Reads? | Writes? |
|---|---|---|
| IDX | Yes | No |
| VOW | Yes | No |
| Private | Yes | No |
Available Services
All Property Types
URI: /<API Version>/propertytypes
URI: /<API Version>/mls/<MlsId>/propertytypes
| HTTP Method | Description | Notes |
|---|---|---|
| GET | Returns a list of all property types for the specified MLS | |
| POST,PUT,DELETE | Returns HTTP 405 (Method Not Allowed) | Not implemented |
GET Request
Parameters:- None
GET Response
Example:{
"D": {
"Success": true,
"Results": [
{
"MlsName": "Residential",
"MlsCode": "A",
"RentalCalendar": false
},
{
"MlsName": "Multi Family",
"MlsCode": "B",
"RentalCalendar": false
},
{
"MlsName": "Land",
"MlsCode": "C",
"RentalCalendar": false
},
{
"MlsName": "Commercial",
"MlsCode": "D",
"RentalCalendar": false
},
{
"MlsName": "Farm",
"MlsCode": "E",
"RentalCalendar": false
},
{
"MlsName": "Rental",
"MlsCode": "F",
"RentalCalendar": true
}
]
}
}
Response Description
| Attribute | Description |
|---|---|
| MlsName | The property type label as chosen by the MLS. |
| MlsCode | The code representing the property type, used for searching. |
| RentalCalendar | true if the Rental Calendar listings subservice is available for this property type. |