Month: November 2024

UPDATED – Bridge RESO Web API changes coming

Posted on by Kristin

This post includes updated technical details for the changes coming on November 19, 2024.

These system-wide changes outlined below will prepare Bridge API MLS datasets for RESO Data Dictionary 2.0 certification. Data consumers can also expect to see several field and enumeration changes to individual datasets over the next several months to bring those datasets better in line with the Data Dictionary 2.0 standard.

For most of the field name changes between Data Dictionary versions 1.x and 2.0, Bridge API will support both old and new field names simultaneously for the next several months at minimum. However, each data provider (each MLS) may decide whether or not to include those in their outgoing payloads.

—

The first set of changes included here will apply to the current v2 endpoints and metadata:

  1. Our nextLink logic will be modified to allow for replication of any number of records.
  2. $expand queries will now have a default maximum of 10 results, unless otherwise specified with a $top operator within the $expand parameter (e.g., $expand=Listings($top=20)). 
  3. Some resource names will be changing.
    • A correction will be made to the Lookup resource; it is inconsistently reported as Lookups in some places and the plural `s` will be removed.
    • Teams will be renamed to Team.
    • Fields/Resource will be renamed to ResourceName. (This change is specific to the Fields metadata; it already shows correctly as ResourceName in the /Fields payload.)
  4. All requests will now have a default sort order if not otherwise indicated in the request. 
    • Default Sort: ascending 
    • Default OrderBy: BridgeModificationTimestamp (primary), primary key (secondary)

These changes are currently available for testing in our UAT environment at: https://uat.bridgedataoutput.com/api/v2/
Users can expect to see these changes released into our production environment on November 19, 2024 at: https://api.bridgedataoutput.com/api/v2/

—

Additionally, there will be a new v3 endpoint that includes new $top behavior that will prepare Bridge for RESO Web API Core 2.1.0 compliance, as well as the changes to v2 above.

  1. The $top operator will be modified to match the OData specification.
    • Bridge v2 OData endpoints treat $top as the page size, whereas OData specifies that $top is meant to be the total collection size. In other words, $top is meant to be the total number of records returned once you have consumed every page.
    • Clients may specify a given page size by utilizing the maxpagesize header. The current default is 10 with a maximum value of 200.

RESO Web API users can choose to stay with v2 endpoints for now, or switch to v3 endpoints if desired. There is no current plan to discontinue the v2 endpoint with its current $top behavior at any set future timeline.

RETS and replication endpoint users can convert to a v3 URL as well, but should not expect any material differences from v2 for those transports.

Users can test now against the new endpoint in UAT at: https://uat.bridgedataoutput.com/api/v3/
The new endpoint will be available in production on November 19, 2024 at: https://api.bridgedataoutput.com/api/v3/

—

We sincerely appreciate everyone who took the time to test and review our UAT environment so far over the past month. We’re hopeful that this revision to support both RESO Web API 2.0.0 and 2.1.0 specifications will allow for greater developer choice and flexibility to adapt to the 2.1.0 standard if and when it suits them.

Again, if you have any questions about these changes or further feedback from testing against UAT, please contact our team at support@bridgeinteractive.com and we’ll be glad to assist.