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.
For Version 3 POST, PATCH, and DELETE operations, see the Add/Edit developer guide. The GET reference below also applies to read-only clients. Writes require Dictionary 2.0 and appropriate listing/resource permissions. Writes require private with the required client keyrole, or private_full without operation-specific keyrole requirements; see Add/Edit access requirements.
Supported Roles
| Role | Reads | Writes | Notes |
|---|---|---|---|
| IDX | Yes | No | |
| Public | Yes | No | |
| VOW | Yes | No | |
| Portal | Yes | No | |
| Private | Yes | Yes |
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 | Version 3 Add/Edit. See the developer guide for access, requests, and responses. | No | Dictionary 2.0; see guide for permissions and If-Match support. |
| 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 | Version 3 Add/Edit. See the developer guide for access, requests, and responses. | Optional If-Match | Dictionary 2.0; see guide for permissions and If-Match support. |
| PATCH | Version 3 Add/Edit. See the developer guide for access, requests, and responses. | Optional If-Match | Dictionary 2.0; see guide for permissions and If-Match support. |
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.