POST dosconnect/dropdown-pull

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
APIKey		string	None.

Request Formats

application/json, text/json

Sample:

{
  "APIKey": "sample string 1"
}

application/xml, text/xml

Sample:

<DropdownPullInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <APIKey>sample string 1</APIKey>
</DropdownPullInput>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'DropdownPullInput'.

Response Information

Resource Description

DropdownOutput

Name	Description	Type	Additional information
DropDowns		Collection of DropdownMenuModel	None.
ReturnStatus		ReturnStatusModel	None.

Response Formats

application/json, text/json

Sample:

{
  "DropDowns": [
    {
      "MenuCode": "sample string 1",
      "Items": [
        {
          "ItemValue": 1,
          "ItemLabel": "sample string 2"
        },
        {
          "ItemValue": 1,
          "ItemLabel": "sample string 2"
        }
      ]
    },
    {
      "MenuCode": "sample string 1",
      "Items": [
        {
          "ItemValue": 1,
          "ItemLabel": "sample string 2"
        },
        {
          "ItemValue": 1,
          "ItemLabel": "sample string 2"
        }
      ]
    }
  ],
  "ReturnStatus": {
    "ReturnCode": 1,
    "ReturnMessage": "sample string 2",
    "Results": 1
  }
}

application/xml, text/xml

Sample:

<DropdownOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Services.API.DOS">
  <ReturnStatus xmlns="http://schemas.datacontract.org/2004/07/Scarlett.V2.API.DataModels.Core">
    <Results>1</Results>
    <ReturnCode>1</ReturnCode>
    <ReturnMessage>sample string 2</ReturnMessage>
  </ReturnStatus>
  <DropDowns>
    <DropdownMenuModel>
      <Items>
        <DropdownItemModel>
          <ItemLabel>sample string 2</ItemLabel>
          <ItemValue>1</ItemValue>
        </DropdownItemModel>
        <DropdownItemModel>
          <ItemLabel>sample string 2</ItemLabel>
          <ItemValue>1</ItemValue>
        </DropdownItemModel>
      </Items>
      <MenuCode>sample string 1</MenuCode>
    </DropdownMenuModel>
    <DropdownMenuModel>
      <Items>
        <DropdownItemModel>
          <ItemLabel>sample string 2</ItemLabel>
          <ItemValue>1</ItemValue>
        </DropdownItemModel>
        <DropdownItemModel>
          <ItemLabel>sample string 2</ItemLabel>
          <ItemValue>1</ItemValue>
        </DropdownItemModel>
      </Items>
      <MenuCode>sample string 1</MenuCode>
    </DropdownMenuModel>
  </DropDowns>
</DropdownOutput>