POST api/utils/search_encode

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
query_text	string	None.
filter_group	filter_group	None.
max_item_count	integer	None.
first_item_index	integer	None.
sort_fields	Collection of sort_field	None.
proximity_filter	ProximityFilter	None.
shuffle	boolean	None.

Request Formats

application/json, text/json

Sample:

{
  "query_text": "sample string 1",
  "filter_group": {
    "operator": 0,
    "filter_groups": [],
    "filters": [
      {
        "field": "sample string 1",
        "operator": 0,
        "value": {}
      },
      {
        "field": "sample string 1",
        "operator": 0,
        "value": {}
      }
    ]
  },
  "max_item_count": 1,
  "first_item_index": 1,
  "sort_fields": [
    {
      "field": "sample string 1",
      "desc": true
    },
    {
      "field": "sample string 1",
      "desc": true
    }
  ],
  "proximity_filter": {
    "longitude": 1.0,
    "latitude": 2.0,
    "distance": 3
  },
  "shuffle": true
}

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

Response Information

Resource Description

IHttpActionResult

None.

Response Formats

application/json, text/json

Sample:

Sample not available.