RESO: Room
The Room resource accesses room data for a given Property. FBS recommends utilizing the $expand parameter to access these records. The subresources listed below should only be used if the $expand parameter will not accommodate your use case.
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 for a Property
/Reso/OData/Property('<ListingKey>')/Room
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Returns the data for all rooms attached to a listing | 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:
| Parameter | Required | Notes |
|---|---|---|
| Attribute selection parameters | No | |
| Pagination parameters | No |
GET Response
Please review the documentation for the RESO Web API for an example response.
Specific Room Record for a Property
/Reso/OData/Property('<ListingKey>')/Room('<RoomKey>')
| HTTP Method | Description | Conditional | Notes |
|---|---|---|---|
| GET | Retrieves an individual room record by Id | 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:
| Parameter | Required | Notes |
|---|---|---|
| Attribute selection parameters | No |
GET Response
Please review the documentation for the RESO Web API for an example response.
Room Description
This service uses the RESO Data Dictionary. Please review the currently supported dictionary on our overview page as well as the data dictionary documentation provided by RESO.
Expansions
None.