Service Provider API-Guide

Download As PDF

POST api/Filtering

Request Information

URI Parameters

None.

Body Parameters

Collection of PartialFilterClauseModel
NameDescriptionTypeAdditional information
QueryBy

FilterQueryBy None.
AreKeywordsInclusive

boolean None.
Keywords

Collection of PartialFilterKeywordModel None.

Request Formats

application/json, text/json

Sample: 
[
  {
    "QueryBy": 0,
    "AreKeywordsInclusive": true,
    "Keywords": [
      {
        "Operation": 0,
        "NegateOperation": true,
        "Keyword": "sample string 2"
      },
      {
        "Operation": 0,
        "NegateOperation": true,
        "Keyword": "sample string 2"
      }
    ]
  },
  {
    "QueryBy": 0,
    "AreKeywordsInclusive": true,
    "Keywords": [
      {
        "Operation": 0,
        "NegateOperation": true,
        "Keyword": "sample string 2"
      },
      {
        "Operation": 0,
        "NegateOperation": true,
        "Keyword": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample: 
<ArrayOfPartialFilterClauseModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/fmPilot.API.Vendor.Models.Filtering">
  <PartialFilterClauseModel>
    <AreKeywordsInclusive>true</AreKeywordsInclusive>
    <Keywords>
      <PartialFilterKeywordModel>
        <Keyword>sample string 2</Keyword>
        <NegateOperation>true</NegateOperation>
        <Operation>Equal</Operation>
      </PartialFilterKeywordModel>
      <PartialFilterKeywordModel>
        <Keyword>sample string 2</Keyword>
        <NegateOperation>true</NegateOperation>
        <Operation>Equal</Operation>
      </PartialFilterKeywordModel>
    </Keywords>
    <QueryBy>Vendor_Address</QueryBy>
  </PartialFilterClauseModel>
  <PartialFilterClauseModel>
    <AreKeywordsInclusive>true</AreKeywordsInclusive>
    <Keywords>
      <PartialFilterKeywordModel>
        <Keyword>sample string 2</Keyword>
        <NegateOperation>true</NegateOperation>
        <Operation>Equal</Operation>
      </PartialFilterKeywordModel>
      <PartialFilterKeywordModel>
        <Keyword>sample string 2</Keyword>
        <NegateOperation>true</NegateOperation>
        <Operation>Equal</Operation>
      </PartialFilterKeywordModel>
    </Keywords>
    <QueryBy>Vendor_Address</QueryBy>
  </PartialFilterClauseModel>
</ArrayOfPartialFilterClauseModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

string

Response Formats

application/json, text/json

Sample: 
"sample string 1"

application/xml, text/xml

Sample: 
<string xmlns="http://schemas.microsoft.com/2003/10/Serialization/">sample string 1</string>