Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add docs for salesOffice query parameter #46

Open
wants to merge 2 commits into
base: master
Choose a base branch
from
Open

Add docs for salesOffice query parameter #46

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
7b3612f
Add docs for salesOffice query parameter
CodyReichert Feb 3, 2022
566efeb
Clarify description of `brokers` parameter
CodyReichert Jun 2, 2022
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
33 changes: 25 additions & 8 deletions api/simplyrets-openapi.yaml
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -476,8 +476,9 @@ paths:
- "$ref": "#/components/parameters/subtype"
- "$ref": "#/components/parameters/subTypeText"
- "$ref": "#/components/parameters/agent"
- "$ref": "#/components/parameters/salesAgent"
- "$ref": "#/components/parameters/brokers"
- "$ref": "#/components/parameters/salesAgent"
- "$ref": "#/components/parameters/salesOffice"
- "$ref": "#/components/parameters/specialListingConditions"
- "$ref": "#/components/parameters/ownership"
- "$ref": "#/components/parameters/minprice"
Expand Down Expand Up @@ -1267,6 +1268,23 @@ components:
type: array
items:
type: string
brokers:
required: false
in: query
name: brokers
description: |
Filter the listings by returned by ListOfficeMlsId
(`.office.brokerid`). For most MLS areas, this will
correspond to the "Office MLS ID". You can specify
multiple `broker` parameters per query.

Note: your data feed must contain a ListOfficeMlsId or similar
field for this filter to work.
explode: true
schema:
type: array
items:
type: string
salesAgent:
required: false
in: query
Expand All @@ -1284,16 +1302,15 @@ components:
type: array
items:
type: string
brokers:
salesOffice:
required: false
in: query
name: brokers
name: salesOffice
description: |
Filter the listings returned by brokerage with a Broker
ID. For some MLS areas, this is the ListOfficeId (Listing
Office ID). You can specific multiple broker
parameters. Note, this query parameter is only available
if a Broker ID is provided by your RETS vendor or MLS.
Filter the listings returned by the `sales.office.brokerid`
field. This parameter can be specified multiple times.

Note, Office MLS IDs are provided by your MLS or data vendor.
explode: true
schema:
type: array
Expand Down