Bridge API users will now see the previously announced Lookup metadata changes live in production.
What’s changed?
All fields previously reported as “Enums” in the current OData metadata are now instead reported as “Strings”. The enum values for these fields can be found in the Lookups resource. This change supports the inclusion of all enum values found in our system, making our data and metadata more consistent. Users of the vRETS interface may notice that fetching metadata takes longer due to the larger volume of enums.
Why?
This change improves the fidelity of our metadata, allowing for better interoperability and data integrity.
We’re notifying all Bridge API users in advance of an important change to the API metadata. A UAT environment is available now and data consumers are strongly encouraged to test against it to prepare.
What’s changing?
All fields reported as “Enums” in the current OData metadata will instead be reported as “Strings”. The enum values for these fields can be found in the Lookups resource. This change will support the inclusion of all enum values found in our system, making our data and metadata more consistent. Users of the vRETS interface may notice that fetching metadata will take longer due to the larger volume of enums.
Why?
This change improves the fidelity of our metadata, allowing for better interoperability and data integrity.
When?
This change will be released in production on August 1, 2023.
There is also a UAT environment with the new format available now, see below.
How can I prepare?
Please test against https://uat.bridgedataoutput.com/api/v2/ to confirm that your ingestion processes are compatible with the new metadata format before we switch over in production on August 1st. vRETS users in particular are strongly encouraged to confirm compatibility.
Please note two imminent changes to the Bridge API metadata affecting all datasets.
The “Order” field in our embedded Media array is incorrectly being returned as a string and will be changed to an integer. This will be rolled out gradually through all datasets over the next month. We recommend coding defensively for this change if necessary on your end.
Our OData Metadata endpoint will stop using “self” to refer to other data types in our service and use “ODataService” instead. For example, a NavigationProperty will no longer refer to “self.Member”, but instead to “ODataService.Member”. This change will be deployed to production on Tuesday, June 27.
Now that Bridge API and Bridge Agreement Management have integrated into one platform, you may wish to merge your BAM and API accounts into a single account.
Merging accounts is optional but highly encouraged: By merging accounts, you will be able to use the new Bridge platform to manage all of your data access and license agreements in a single streamlined interface.
If your existing BAM and API accounts used the same username and password, your login will now default to the API account. You’ll need to merge those accounts together before you’re able to access agreements from the BAM account.
By merging Bridge accounts, you will combine all the applications, users, agreements and payment profiles into a single account. You will need the platform credentials for the account(s) you wish to merge. Please note that account merges cannot be undone.
In the upper right corner, click your name to open the settings menu. Click User & Account Settings.
Click Account Settings, then Merge Account. Enter the credentials for your other Bridge account.
Click Find Account. A confirmation screen will appear to verify the details of the accounts you are merging. Please review carefully; account merges CANNOT be undone.
To complete the merger, click Confirm Merge. A confirmation banner will briefly appear to confirm that the account merge was successful.
Bridge Agreement Management and Bridge API have come together into a single integrated solution!
We’ve combined everything you need to gain greater efficiencies in your agreement management and find added peace of mind with your data distribution.
Our new Bridge platform will continue to streamline your data licensing processes, automate billing, and deliver more data access choices — but now, it’s all accessible in one place.
Check out the new experience using your existing Bridge credentials (or through your MLS Single Sign On) and let us know what you think: bridgedataoutput.com/login
Please note that on Tuesday, June 15 starting at 19:00 PDT, the Bridge platform will be down for maintenance. We expect to be up after a couple of hours with a brand new upgraded experience for you. Both the Bridge API and Bridge Agreement Management dashboards will be unavailable during this time.
The API itself will not be affected by this change and will continue to operate as usual.
Move faster, innovate more.
Contact us to set up a demo and see how Bridge can take you where you want to go.
