Rooms Metadata
The Rooms Metadata service describes the available fields for listing rooms data.
- Supported Roles
- Available Services
- All Rooms
- Individual Room Field
- Rooms Metadata Description
- Expansions
- API Explorer
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 Rooms
/<API Version>/rooms
/<API Version>/mls/<MlsId>/rooms
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:
GET Response
{
"D": {
"Success": true,
"Results":[
{
"RoomName": {
"Type": "Character",
"ResourceUri": "/v1/rooms/RoomName",
"Label": "Room Name",
"HasList": true,
"Searchable": false,
"MlsVisible": [
"A",
"E"
]
},
"LevelOrFloor": {
"Type": "Character",
"ResourceUri": "/v1/rooms/LevelOrFloor",
"Label": "Room Level",
"HasList": true,
"Searchable": false,
"MlsVisible": [
"A"
]
},
"room_nbr": {
"Type": "Character",
"ResourceUri": "/v1/rooms/room_nbr",
"Label": "No. of Rooms",
"HasList": false,
"Searchable": false,
"MlsVisible": [
"A"
]
},
"Length": {
"Type": "Character",
"ResourceUri": "/v1/rooms/Length",
"Label": "Length",
"HasList": false,
"Searchable": false,
"MlsVisible": [
"A"
]
},
"Width": {
"Type": "Character",
"ResourceUri": "/v1/rooms/Width",
"Label": "Width",
"HasList": false,
"Searchable": false,
"MlsVisible": [
"A"
]
},
"Description": {
"Type": "Character",
"ResourceUri": "/v1/rooms/Description",
"Label": "Room Remarks",
"HasList": false,
"Searchable": false,
"MlsVisible": [
"A"
]
},
"RoomFeature": {
"Type": "Boolean",
"ResourceUri": "/v1/rooms/RoomFeature",
"Label": "Room Feature",
"HasList": true,
"MultiSelect": true,
"Searchable": false,
"MlsVisible": [
"A"
]
}
}
],
}
}
Available Services
Individual Room Field
/<API Version>/rooms/<Room.Field>
/<API Version>/mls/<MlsId>/rooms/<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:
GET Response
{
"D": {
"Success": true,
"Results":[
{
"RoomName": {
"Type": "Character",
"ResourceUri": "/v1/rooms/RoomName",
"Label": "Room Name",
"HasList": true,
"Searchable": false,
"MlsVisible": [
"A",
"E"
],
"FieldList": [
{
"Name": "Bath",
"Value": "Bath",
"AppliesTo": [
"A"
]
},
{
"Name": "Bedroom 1",
"Value": "Bedroom 1",
"AppliesTo": [
"A"
]
},
{
"Name": "Bedroom 2",
"Value": "Bedroom 2",
"AppliesTo": [
"A"
]
},
{
"Name": "Bedroom 3",
"Value": "Bedroom 3",
"AppliesTo": [
"A"
]
},
{
"Name": "Bedroom 4",
"Value": "Bedroom 4",
"AppliesTo": [
"A"
]
},
{
"Name": "Bedroom 5",
"Value": "Bedroom 5",
"AppliesTo": [
"A"
]
},
{
"Name": "Bedroom 6",
"Value": "Bedroom 6",
"AppliesTo": [
"A"
]
},
{
"Name": "Den/Office",
"Value": "Den/Office",
"AppliesTo": [
"A"
]
},
{
"Name": "Dining Room",
"Value": "Dining Room",
"AppliesTo": [
"A"
]
},
{
"Name": "Family Room",
"Value": "Family Room",
"AppliesTo": [
"A"
]
},
{
"Name": "Fireplace/Woodstove",
"Value": "Fireplace/Woodstove",
"AppliesTo": [
"A"
]
},
{
"Name": "Half Bath",
"Value": "Half Bath",
"AppliesTo": [
"A"
]
},
{
"Name": "Kitchen",
"Value": "Kitchen",
"AppliesTo": [
"A"
]
},
{
"Name": "Library",
"Value": "Library",
"AppliesTo": [
"A"
]
},
{
"Name": "Living Room",
"Value": "Living Room",
"AppliesTo": [
"A"
]
},
{
"Name": "Master Bath",
"Value": "Master Bath",
"AppliesTo": [
"A"
]
},
{
"Name": "Room",
"Value": "Room",
"AppliesTo": [
"B",
"C",
"D",
"E",
"F",
"G",
"H",
"I",
"J"
]
},
{
"Name": "Shower",
"Value": "Shower",
"AppliesTo": [
"A"
]
},
{
"Name": "Utility",
"Value": "Utility",
"AppliesTo": [
"A"
]
}
]
}
}
],
}
}
Rooms 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. |
MultiSelect |
Boolean |
true if the field has a FieldList attribute and listing data for this field can have multiple values from this list. |
ResourceUri |
Character |
|
Type |
Character |
The data type of the field. |
Expansions
None.
API Explorer
Interact with this service using the
API Explorer.