RESO: Office
The Office resource accesses the same data as Spark's accounts service,
when that service applies a _filter
of UserType Eq 'Office'
.
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 Offices
/Reso/OData/Office
HTTP Method | Description | Conditional | Notes |
---|---|---|---|
GET | Returns the data for all offices accessible by the current user | 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.
Individual Office
/Reso/OData/Office('<OfficeKey>')
HTTP Method | Description | Conditional | Notes |
---|---|---|---|
GET | Retrieves an individual office 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.
Office 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
Expansion | Roles | Description |
---|---|---|
Media |
All | Photos and other media for the office. |