Get all dealer filter options

Returns all available options for dealer filtering including brands, dealer groups, products, dealer statuses, and DMS types. Response is cacheable.
ApiScope: manage.dealer.read.internal
API Scope Level: ServiceSubscriberScope

Responses

• 200
• 400
• 401
• 403
• 500

---

Successfully retrieved filter options

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string
filterOptions object
brands object[]
Array [
brandName string
brandType string
uuid string
brandLogo string
isValid boolean
oem object
oemCode string
oemName string
motorBrandName string
id int64 deprecated
motorBrandID int64
]
dealerGroups object[]
Array [
groupName string
uuid string
groupType string
parent
]
products object[]
Array [
name string
key string
uuid string
licensed boolean
]
dealerStatuses object[]
Array [
code string
displayName string
colorCode string
]
dmsTypes object[]
Array [
id int64
description string
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "filterOptions": {
    "brands": [
      {
        "brandName": "string",
        "brandType": "string",
        "uuid": "string",
        "brandLogo": "string",
        "isValid": true,
        "oem": {
          "oemCode": "string",
          "oemName": "string"
        },
        "motorBrandName": "string",
        "motorBrandID": 0
      }
    ],
    "dealerGroups": [
      {
        "groupName": "string",
        "uuid": "string",
        "groupType": "string"
      }
    ],
    "products": [
      {
        "name": "string",
        "key": "string",
        "uuid": "string",
        "licensed": true
      }
    ],
    "dealerStatuses": [
      {
        "code": "string",
        "displayName": "string",
        "colorCode": "string"
      }
    ],
    "dmsTypes": [
      {
        "id": 0,
        "description": "string"
      }
    ]
  }
}

Bad Request

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Unauthorized

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Forbidden

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Internal server error while fetching filter data

application/json

Schema

Example (from schema)

---

Schema

errors object[]
Array [
errorCode int32
errorTitle string
errorMessage string
]
warnings object[]
Array [
warningCode int32
warningTitle string
warningMessage string
]
apiRequestId string

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string"
}

Loading...