GET api/Search?searchTerm={searchTerm}

Search parts across all brands. Returns top 50 most relevant results.

Request Information

URI Parameters

Name	Description	Type	Additional information
searchTerm	Search string	string	Required

Body Parameters

None.

Response Information

Resource Description

Most relevant search results

SearchResults

Name	Type	Additional information
TotalHits	integer	None.
PageNumber	integer	None.
HitLimit	integer	None.
SearchQuery	string	None.
BrandNodeFilter	integer	None.
QueryTimeInMs	decimal number	None.
Documents	Collection of SearchDocument	None.

Response Formats

application/json, text/json

Sample:

{
  "Documents": [
    {
      "Boost": 1.1,
      "fields": [
        {
          "internalName": "sample string 1",
          "fieldsData": "sample string 2"
        },
        {
          "internalName": "sample string 1",
          "fieldsData": "sample string 2"
        }
      ]
    },
    {
      "Boost": 1.1,
      "fields": [
        {
          "internalName": "sample string 1",
          "fieldsData": "sample string 2"
        },
        {
          "internalName": "sample string 1",
          "fieldsData": "sample string 2"
        }
      ]
    }
  ],
  "TotalHits": 1,
  "PageNumber": 2,
  "HitLimit": 3,
  "SearchQuery": "sample string 4",
  "BrandNodeFilter": 1,
  "QueryTimeInMs": 5.1
}

text/html

Sample:

{"Documents":[{"Boost":1.1,"fields":[{"internalName":"sample string 1","fieldsData":"sample string 2"},{"internalName":"sample string 1","fieldsData":"sample string 2"}]},{"Boost":1.1,"fields":[{"internalName":"sample string 1","fieldsData":"sample string 2"},{"internalName":"sample string 1","fieldsData":"sample string 2"}]}],"TotalHits":1,"PageNumber":2,"HitLimit":3,"SearchQuery":"sample string 4","BrandNodeFilter":1,"QueryTimeInMs":5.1}

application/xml, text/xml

Sample:

<SearchResults xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Jotunheim.Models.Search">
  <BrandNodeFilter>1</BrandNodeFilter>
  <Documents>
    <SearchDocument>
      <Boost>1.1</Boost>
      <fields>
        <SearchField>
          <fieldsData>sample string 2</fieldsData>
          <internalName>sample string 1</internalName>
        </SearchField>
        <SearchField>
          <fieldsData>sample string 2</fieldsData>
          <internalName>sample string 1</internalName>
        </SearchField>
      </fields>
    </SearchDocument>
    <SearchDocument>
      <Boost>1.1</Boost>
      <fields>
        <SearchField>
          <fieldsData>sample string 2</fieldsData>
          <internalName>sample string 1</internalName>
        </SearchField>
        <SearchField>
          <fieldsData>sample string 2</fieldsData>
          <internalName>sample string 1</internalName>
        </SearchField>
      </fields>
    </SearchDocument>
  </Documents>
  <HitLimit>3</HitLimit>
  <PageNumber>2</PageNumber>
  <QueryTimeInMs>5.1</QueryTimeInMs>
  <SearchQuery>sample string 4</SearchQuery>
  <TotalHits>1</TotalHits>
</SearchResults>