Skip to content

Commit e508696

Browse files
committed
Add docs for salesOffice query parameter
1 parent 0e1249c commit e508696

File tree

1 file changed

+23
-8
lines changed

1 file changed

+23
-8
lines changed

api/simplyrets-openapi.yaml

Lines changed: 23 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -474,8 +474,9 @@ paths:
474474
- "$ref": "#/components/parameters/subtype"
475475
- "$ref": "#/components/parameters/subTypeText"
476476
- "$ref": "#/components/parameters/agent"
477-
- "$ref": "#/components/parameters/salesAgent"
478477
- "$ref": "#/components/parameters/brokers"
478+
- "$ref": "#/components/parameters/salesAgent"
479+
- "$ref": "#/components/parameters/salesOffice"
479480
- "$ref": "#/components/parameters/specialListingConditions"
480481
- "$ref": "#/components/parameters/ownership"
481482
- "$ref": "#/components/parameters/minprice"
@@ -1264,6 +1265,21 @@ components:
12641265
type: array
12651266
items:
12661267
type: string
1268+
brokers:
1269+
required: false
1270+
in: query
1271+
name: brokers
1272+
description: |
1273+
Filter the listings returned by brokerage with a Broker
1274+
ID. For some MLS areas, this is the ListOfficeId (Listing
1275+
Office ID). You can specific multiple broker
1276+
parameters. Note, this query parameter is only available
1277+
if a Broker ID is provided by your RETS vendor or MLS.
1278+
explode: true
1279+
schema:
1280+
type: array
1281+
items:
1282+
type: string
12671283
salesAgent:
12681284
required: false
12691285
in: query
@@ -1281,16 +1297,15 @@ components:
12811297
type: array
12821298
items:
12831299
type: string
1284-
brokers:
1300+
salesOffice:
12851301
required: false
12861302
in: query
1287-
name: brokers
1303+
name: salesOffice
12881304
description: |
1289-
Filter the listings returned by brokerage with a Broker
1290-
ID. For some MLS areas, this is the ListOfficeId (Listing
1291-
Office ID). You can specific multiple broker
1292-
parameters. Note, this query parameter is only available
1293-
if a Broker ID is provided by your RETS vendor or MLS.
1305+
Filter the listings returned by the `sales.office.brokerid`
1306+
field. This parameter can be specified multiple times.
1307+
1308+
Note, Office MLS IDs are provided by your MLS or data vendor.
12941309
explode: true
12951310
schema:
12961311
type: array

0 commit comments

Comments
 (0)