RESO: Offices

The Offices resource accesses the same data as Spark's accounts service, when that service applies a _filter of UserType Eq 'Office'.

  1. Supported Roles
  2. Available Services
    1. All Offices
    2. Individual Office
    3. Offices Meta Data
  3. Offices Description

Supported Roles

Role Reads Writes Notes
IDX No No
Public No No
VOW No No
Portal No No
Private Yes No
More information about roles may be found here.

Available Services

All Offices

URI: /Reso/OData/Offices

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

URI: /Reso/OData/Offices('<Office.Id>')

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.

Offices Meta Data

URI: /Reso/OData/Offices/$metadata

HTTP Method Description Conditional Notes
GET Returns the meta data for the Offices resource 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

Please review the documentation for the RESO Web API for an example response.

Offices 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.