GET api/{lang}/search?query={query}

Search pages by query

Request Information

URI Parameters

NameDescriptionTypeAdditional information
query

Query for search

string

Required

lang

Target language (two-letter ISO 639-1 code).

string

Required

Body Parameters

None.

Response Information

Resource Description

SearchResult
NameDescriptionTypeAdditional information
TotalCount

Total results count.

integer

None.

Language

Language of results.

string

None.

Results

Collection of result items.

Collection of SearchResultItem

None.

Response Formats

application/json, text/json

Sample:
{
  "TotalCount": 1,
  "Language": "sample string 2",
  "Results": [
    {
      "Id": 1,
      "UrlSegment": "sample string 2",
      "Title": "sample string 3",
      "Text": "sample string 4",
      "IsIngredient": true,
      "IsGuide": true,
      "IsInstruction": true,
      "IsTechnique": true,
      "Type": "Guide"
    },
    {
      "Id": 1,
      "UrlSegment": "sample string 2",
      "Title": "sample string 3",
      "Text": "sample string 4",
      "IsIngredient": true,
      "IsGuide": true,
      "IsInstruction": true,
      "IsTechnique": true,
      "Type": "Guide"
    }
  ]
}