POST api/Kbs_NotificationsAddressees/List

Request Information

URI Parameters

None.

Body Parameters

KbsFilterParameters
NameDescriptionTypeAdditional information
page

integer

None.

itemsPerPage

integer

None.

itemsPerList

integer

None.

filters

Dictionary of string [key] and KbsFilter [value]

None.

orders

Dictionary of string [key] and KbsOrder [value]

None.

Request Formats

application/json, text/json

Sample:
{
  "page": 1,
  "itemsPerPage": 2,
  "itemsPerList": 3,
  "filters": {
    "sample string 1": {
      "table": "sample string 1",
      "fieldName": "sample string 2",
      "operatorCode": "sample string 3",
      "value": {},
      "andOr": "sample string 5"
    },
    "sample string 2": {
      "table": "sample string 1",
      "fieldName": "sample string 2",
      "operatorCode": "sample string 3",
      "value": {},
      "andOr": "sample string 5"
    }
  },
  "orders": {
    "sample string 1": {
      "ascDesc": "sample string 1"
    },
    "sample string 2": {
      "ascDesc": "sample string 1"
    }
  }
}

application/xml, text/xml

Sample:
<KbsFilterParameters xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Kbs385.Helper">
  <filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringKbsFilterpBwh3qQf>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <andOr>sample string 5</andOr>
        <fieldName>sample string 2</fieldName>
        <operatorCode>sample string 3</operatorCode>
        <table>sample string 1</table>
        <value />
      </d2p1:Value>
    </d2p1:KeyValueOfstringKbsFilterpBwh3qQf>
    <d2p1:KeyValueOfstringKbsFilterpBwh3qQf>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <andOr>sample string 5</andOr>
        <fieldName>sample string 2</fieldName>
        <operatorCode>sample string 3</operatorCode>
        <table>sample string 1</table>
        <value />
      </d2p1:Value>
    </d2p1:KeyValueOfstringKbsFilterpBwh3qQf>
  </filters>
  <itemsPerList>3</itemsPerList>
  <itemsPerPage>2</itemsPerPage>
  <orders xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringKbsOrderpBwh3qQf>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <ascDesc>sample string 1</ascDesc>
      </d2p1:Value>
    </d2p1:KeyValueOfstringKbsOrderpBwh3qQf>
    <d2p1:KeyValueOfstringKbsOrderpBwh3qQf>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <ascDesc>sample string 1</ascDesc>
      </d2p1:Value>
    </d2p1:KeyValueOfstringKbsOrderpBwh3qQf>
  </orders>
  <page>1</page>
</KbsFilterParameters>

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.