Get common option key prompts for the list of dealers

ApiScope: manage.dealer.read
API Scope Level: MultiDealerScope

Query Parameters

isSelfAdmin boolean

application/json

Request Body required

dealerUuids string[]
validate boolean
doNotValidate boolean

Responses

• 200
• 400
• 401
• 403
• 500

---

OK

application/json

application/x-protobuf

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
optionKeyPrompts object[]
Array [
optionKey The unique key of the configuration.
optionDescription The description of the configuration.
configPromptType The type of the configuration value. For example - Date, Number, List etc.
possibleValues The possible values of the configuration.
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "optionKeyPrompts": [
    {
      "optionKey": "string",
      "optionDescription": "string",
      "configPromptType": "string",
      "possibleValues": "string"
    }
  ]
}

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
optionKeyPrompts object[]
Array [
optionKey The unique key of the configuration.
optionDescription The description of the configuration.
configPromptType The type of the configuration value. For example - Date, Number, List etc.
possibleValues The possible values of the configuration.
]

{
  "errors": [
    {
      "errorCode": 0,
      "errorTitle": "string",
      "errorMessage": "string"
    }
  ],
  "warnings": [
    {
      "warningCode": 0,
      "warningTitle": "string",
      "warningMessage": "string"
    }
  ],
  "apiRequestId": "string",
  "optionKeyPrompts": [
    {
      "optionKey": "string",
      "optionDescription": "string",
      "configPromptType": "string",
      "possibleValues": "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

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"
}

POST /v2/dealers/optionKeys/searches

Authorization

name: basicAuthtype: httpscheme: basic

Request

Base URL

/manage

Username

Password

isSelfAdmin — query

---truefalse

Body required

{
  "dealerUuids": [
    "string"
  ],
  "validate": true,
  "doNotValidate": true
}

Accept

application/jsonapplication/x-protobuf

curl / cURL

curl -L -X POST '/manage/v2/dealers/optionKeys/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUuids": [
    "string"
  ],
  "validate": true,
  "doNotValidate": true
}'

python / requests

curl -L -X POST '/manage/v2/dealers/optionKeys/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUuids": [
    "string"
  ],
  "validate": true,
  "doNotValidate": true
}'

go / native

curl -L -X POST '/manage/v2/dealers/optionKeys/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUuids": [
    "string"
  ],
  "validate": true,
  "doNotValidate": true
}'

nodejs / axios

curl -L -X POST '/manage/v2/dealers/optionKeys/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUuids": [
    "string"
  ],
  "validate": true,
  "doNotValidate": true
}'

ruby / Net::HTTP

curl -L -X POST '/manage/v2/dealers/optionKeys/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUuids": [
    "string"
  ],
  "validate": true,
  "doNotValidate": true
}'

csharp / RestSharp

curl -L -X POST '/manage/v2/dealers/optionKeys/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUuids": [
    "string"
  ],
  "validate": true,
  "doNotValidate": true
}'

php / cURL

curl -L -X POST '/manage/v2/dealers/optionKeys/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUuids": [
    "string"
  ],
  "validate": true,
  "doNotValidate": true
}'

java / OkHttp

curl -L -X POST '/manage/v2/dealers/optionKeys/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUuids": [
    "string"
  ],
  "validate": true,
  "doNotValidate": true
}'

powershell / RestMethod

curl -L -X POST '/manage/v2/dealers/optionKeys/searches' \
-H 'Content-Type: application/json' \
-H 'Accept: application/json' \
--data-raw '{
  "dealerUuids": [
    "string"
  ],
  "validate": true,
  "doNotValidate": true
}'