List

POST 
/options/:apiKey/:optionsName

Retrieve an options list based on given option name.

Request

Path Parameters

apiKey stringrequired

Possible values: <= 50 characters

API Key of Connector

optionsName stringrequired

Possible values: <= 128 characters

Options identifier of the appropriate adapter

application/json

Body

required

Parameters may be required dependent on the adapter

parameters object

Possible values: <= 255 characters

Responses

200

Options response

application/json

Schema

Schema

success boolean

options

object[]

Array [

key string

value string

]

error string
property name* any

Example (from schema)

{
  "success": true,
  "options": [
    {
      "key": "string",
      "value": "string"
    }
  ],
  "error": "string"
}

Success

{
  "success": true,
  "options": {
    "bank1": "Bank One",
    "bank2": "Bank Two",
    "bank3": "Bank Three",
    "bank4": "Bank Four"
  }
}

Error

{
  "success": false,
  "errorMessage": "Given identifier 'someIdentifier' is invalid."
}

Loading...