Units Metadata
The Units Metadata service describes the available fields for listing units data.
Supported Roles
Role | Reads | Writes | Notes |
---|---|---|---|
IDX | Yes | No | |
Public | Yes | No | |
VOW | Yes | No | |
Portal | Yes | No | |
Private | Yes | No |
More information about roles may be found here.
Available Services
All Units
/<API Version>/units
/<API Version>/mls/<MlsId>/units
HTTP Method | Description | Conditional | Notes |
---|---|---|---|
GET | No | ||
POST | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
PUT | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
DELETE | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
GET Request
Parameters:
- None
GET Response
{
"D": {
"Success": true,
"Results": [
{
"UnitsTotal": {
"Type": "Character",
"ResourceUri": "/v1/unitfields/UnitsTotal",
"Label": "# of Units",
"HasList": false,
"Searchable": false,
"MlsVisible": [
"B"
]
},
"unit_nbr": {
"Type": "Character",
"ResourceUri": "/v1/unitfields/unit_nbr",
"Label": "Unit Type",
"HasList": true,
"Searchable": false,
"MlsVisible": [
"B"
]
},
"ActualRent": {
"Type": "Character",
"ResourceUri": "/v1/unitfields/ActualRent",
"Label": "Rent",
"HasList": false,
"Searchable": false,
"MlsVisible": [
"B"
]
},
"sqft": {
"Type": "Character",
"ResourceUri": "/v1/unitfields/sqft",
"Label": "SqFt",
"HasList": true,
"Searchable": false,
"MlsVisible": [
"B"
]
},
"BedsTotal": {
"Type": "Character",
"ResourceUri": "/v1/unitfields/BedsTotal",
"Label": "Bedrooms",
"HasList": false,
"Searchable": false,
"MlsVisible": [
"B"
]
},
"BathsTotal": {
"Type": "Character",
"ResourceUri": "/v1/unitfields/BathsTotal",
"Label": "Bath",
"HasList": true,
"Searchable": false,
"MlsVisible": [
"B"
]
}
}
],
}
}
Available Services
Individual Room Field
/<API Version>/units/<Room.Field>
/<API Version>/mls/<MlsId>/units/<Room.Field>
HTTP Method | Description | Conditional | Notes |
---|---|---|---|
GET | No | ||
POST | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
PUT | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
DELETE | Returns HTTP 405 (Method Not Allowed) | No | Not implemented |
GET Request
Parameters:
- None
GET Response
{
"D": {
"Success": true,
"Results":[
{
"BathsTotal": {
"Type": "Character",
"ResourceUri": "/v1/unitfields/BathsTotal",
"Label": "Bath",
"HasList": true,
"Searchable": false,
"MlsVisible": [
"B"
],
"FieldList": [
{
"Name": "1 Bath",
"Value": "1 Bath",
"AppliesTo": [
"B"
]
},
{
"Name": "1 Shower",
"Value": "1 Shower",
"AppliesTo": [
"B"
]
},
{
"Name": "2 or more Baths",
"Value": "2 or more Baths",
"AppliesTo": [
"B"
]
},
{
"Name": "Shared Bath",
"Value": "Shared Bath",
"AppliesTo": [
"B"
]
}
]
}
}
],
}
}
Units Metadata Description
Attribute | Data Type | Description |
---|---|---|
FieldList.Name |
Character | The human-readable name of the list item. |
FieldList.Value |
Character | The universal name for the list item. |
FieldList.AppliesTo |
Character List | A list of property types the list item is enabled for. |
HasList |
Boolean | If true , there is a corresponding FieldList for this field. |
Label |
Character | The human-friendly name of this field. |
MlsVisible |
Character List | A list of property types the field is enabled for. |
ResourceUri |
Character | |
Type |
Character | The data type of the field. |
Expansions
None.