POST api/v2/multi_search

Request Information

URI Parameters

None.

Body Parameters

Name	Description	Type	Additional information
searches		Collection of Searches	None.

Request Formats

application/json, text/json

Sample:

{
  "searches": [
    {
      "collection": "sample string 1",
      "q": "sample string 2",
      "query_by": "sample string 3",
      "query_by_weights": "sample string 4",
      "per_page": 1,
      "page": 1,
      "filter_by": "sample string 5",
      "sort_by": "sample string 6",
      "group_by": "sample string 7"
    },
    {
      "collection": "sample string 1",
      "q": "sample string 2",
      "query_by": "sample string 3",
      "query_by_weights": "sample string 4",
      "per_page": 1,
      "page": 1,
      "filter_by": "sample string 5",
      "sort_by": "sample string 6",
      "group_by": "sample string 7"
    }
  ]
}

application/xml, text/xml

Sample:

<Search xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NF_API_V03.Models.ApiV2">
  <searches>
    <Search.Searches>
      <collection>sample string 1</collection>
      <filter_by>sample string 5</filter_by>
      <group_by>sample string 7</group_by>
      <page>1</page>
      <per_page>1</per_page>
      <q>sample string 2</q>
      <query_by>sample string 3</query_by>
      <query_by_weights>sample string 4</query_by_weights>
      <sort_by>sample string 6</sort_by>
    </Search.Searches>
    <Search.Searches>
      <collection>sample string 1</collection>
      <filter_by>sample string 5</filter_by>
      <group_by>sample string 7</group_by>
      <page>1</page>
      <per_page>1</per_page>
      <q>sample string 2</q>
      <query_by>sample string 3</query_by>
      <query_by_weights>sample string 4</query_by_weights>
      <sort_by>sample string 6</sort_by>
    </Search.Searches>
  </searches>
</Search>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

SearchResponse

Name	Type	Additional information
results	Collection of Object	None.
page	integer	None.
per_page	integer	None.
total_page	integer	None.
total_results	integer	None.

Response Formats

application/json, text/json

Sample:

{
  "results": [
    {},
    {}
  ],
  "page": 1,
  "per_page": 2,
  "total_page": 3,
  "total_results": 4
}

application/xml, text/xml

Sample:

<SearchResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/NF_API_V03.Models.ApiV2">
  <page>1</page>
  <per_page>2</per_page>
  <results xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:anyType />
    <d2p1:anyType />
  </results>
  <total_page>3</total_page>
  <total_results>4</total_results>
</SearchResponse>