POST api/v1/essentials/optionlist

Jos: WRITE COMMENTS

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
OptionTypeKey	The OptionTypeKey the requested list is for.	string	None.
Limit	The amount of rows requested per page. Default 500	integer	None.
Page	The requested page related to the limit. default 1	integer	None.

Request Formats

application/json, text/json

Sample:

{
  "OptionTypeKey": "sample string 1",
  "Limit": 2,
  "Page": 3
}

application/xml, text/xml

Sample:

<GetOptionListParameter xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://promotionaloffice.promidata.com/2012/08/08">
  <Limit>2</Limit>
  <OptionTypeKey>sample string 1</OptionTypeKey>
  <Page>3</Page>
</GetOptionListParameter>

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 'GetOptionListParameter'.

Response Information

Resource Description

GetOptionListResult

Name	Description	Type	Additional information
TotalOptionCount	The total count of options from the requested optionType	integer	None.
OptionList	The found options with the requested parameters	Collection of OptionItem	None.

Response Formats

application/json, text/json

Sample:

{
  "TotalOptionCount": 1,
  "OptionList": [
    {
      "Key": "sample string 1",
      "Translations": [
        {
          "Language": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Language": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Disabled": true,
      "IsSystemType": true,
      "OptionTypeKey": "sample string 4"
    },
    {
      "Key": "sample string 1",
      "Translations": [
        {
          "Language": "sample string 1",
          "Value": "sample string 2"
        },
        {
          "Language": "sample string 1",
          "Value": "sample string 2"
        }
      ],
      "Disabled": true,
      "IsSystemType": true,
      "OptionTypeKey": "sample string 4"
    }
  ]
}

application/xml, text/xml

Sample:

<GetOptionListResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://promotionaloffice.promidata.com/2012/08/08">
  <OptionList xmlns:d2p1="http://schemas.datacontract.org/2004/07/Promidata.PromotionalOffice.Webservice.Contracts">
    <d2p1:OptionItem>
      <d2p1:Disabled>true</d2p1:Disabled>
      <d2p1:IsSystemType>true</d2p1:IsSystemType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:OptionTypeKey>sample string 4</d2p1:OptionTypeKey>
      <d2p1:Translations>
        <d2p1:TranslationItem>
          <d2p1:Language>sample string 1</d2p1:Language>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:TranslationItem>
        <d2p1:TranslationItem>
          <d2p1:Language>sample string 1</d2p1:Language>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:TranslationItem>
      </d2p1:Translations>
    </d2p1:OptionItem>
    <d2p1:OptionItem>
      <d2p1:Disabled>true</d2p1:Disabled>
      <d2p1:IsSystemType>true</d2p1:IsSystemType>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:OptionTypeKey>sample string 4</d2p1:OptionTypeKey>
      <d2p1:Translations>
        <d2p1:TranslationItem>
          <d2p1:Language>sample string 1</d2p1:Language>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:TranslationItem>
        <d2p1:TranslationItem>
          <d2p1:Language>sample string 1</d2p1:Language>
          <d2p1:Value>sample string 2</d2p1:Value>
        </d2p1:TranslationItem>
      </d2p1:Translations>
    </d2p1:OptionItem>
  </OptionList>
  <TotalOptionCount>1</TotalOptionCount>
</GetOptionListResult>