Add docs for salesOffice query parameter

SimplyRETS · Jul 28, 2022 · 7b3612f · 7b3612f
1 parent fdd8c30
commit 7b3612f
Showing 1 changed file with 23 additions and 8 deletions.
diff --git a/api/simplyrets-openapi.yaml b/api/simplyrets-openapi.yaml
@@ -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"
@@ -1267,6 +1268,21 @@ components:
         type: array
         items:
           type: string
+    brokers:
+      required: false
+      in: query
+      name: brokers
+      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.
+      explode: true
+      schema:
+        type: array
+        items:
+          type: string
     salesAgent:
       required: false
       in: query
@@ -1284,16 +1300,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