POST api/searchengine/search

Request Information

URI Parameters

None.

Body Parameters

SearchInputModel
NameDescriptionTypeAdditional information
Origin

string

None.

Terms

string

None.

MaxResults

integer

None.

SplitTerms

boolean

None.

Categories

Collection of ResultCategory

None.

ExcludeTags

Collection of string

None.

Request Formats

application/json, text/json

Sample:
{
  "Origin": "sample string 1",
  "Terms": "sample string 2",
  "MaxResults": 3,
  "SplitTerms": true,
  "Categories": [
    1,
    1
  ],
  "ExcludeTags": [
    "sample string 1",
    "sample string 2"
  ]
}

application/xml, text/xml

Sample:
<SearchInputModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UniversalSearchEngine.Model">
  <Categories>
    <ResultCategory>Sede</ResultCategory>
    <ResultCategory>Sede</ResultCategory>
  </Categories>
  <ExcludeTags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ExcludeTags>
  <MaxResults>3</MaxResults>
  <Origin>sample string 1</Origin>
  <SplitTerms>true</SplitTerms>
  <Terms>sample string 2</Terms>
</SearchInputModel>

application/x-www-form-urlencoded

Sample:

Sample not available.

Response Information

Resource Description

Collection of SearchResultModel
NameDescriptionTypeAdditional information
IDResult

integer

None.

Description

string

None.

Category

ResultCategory

None.

ParentApplication

string

None.

Url

string

None.

UrlDetails

string

None.

Status

boolean

None.

Error

boolean

None.

Tags

Collection of ResultTag

None.

Response Formats

application/json, text/json

Sample:
[
  {
    "IDResult": 1,
    "Description": "sample string 2",
    "Category": 1,
    "ParentApplication": "sample string 3",
    "Url": "sample string 4",
    "UrlDetails": "sample string 5",
    "Status": true,
    "Error": true,
    "Tags": [
      {
        "Text": "sample string 1",
        "Color": "sample string 2"
      },
      {
        "Text": "sample string 1",
        "Color": "sample string 2"
      }
    ]
  },
  {
    "IDResult": 1,
    "Description": "sample string 2",
    "Category": 1,
    "ParentApplication": "sample string 3",
    "Url": "sample string 4",
    "UrlDetails": "sample string 5",
    "Status": true,
    "Error": true,
    "Tags": [
      {
        "Text": "sample string 1",
        "Color": "sample string 2"
      },
      {
        "Text": "sample string 1",
        "Color": "sample string 2"
      }
    ]
  }
]

application/xml, text/xml

Sample:
<ArrayOfSearchResultModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/UniversalSearchEngine.Model">
  <SearchResultModel>
    <Category>Sede</Category>
    <Description>sample string 2</Description>
    <Error>true</Error>
    <IDResult>1</IDResult>
    <ParentApplication>sample string 3</ParentApplication>
    <Status>true</Status>
    <Tags>
      <ResultTag>
        <Color>sample string 2</Color>
        <Text>sample string 1</Text>
      </ResultTag>
      <ResultTag>
        <Color>sample string 2</Color>
        <Text>sample string 1</Text>
      </ResultTag>
    </Tags>
    <Url>sample string 4</Url>
    <UrlDetails>sample string 5</UrlDetails>
  </SearchResultModel>
  <SearchResultModel>
    <Category>Sede</Category>
    <Description>sample string 2</Description>
    <Error>true</Error>
    <IDResult>1</IDResult>
    <ParentApplication>sample string 3</ParentApplication>
    <Status>true</Status>
    <Tags>
      <ResultTag>
        <Color>sample string 2</Color>
        <Text>sample string 1</Text>
      </ResultTag>
      <ResultTag>
        <Color>sample string 2</Color>
        <Text>sample string 1</Text>
      </ResultTag>
    </Tags>
    <Url>sample string 4</Url>
    <UrlDetails>sample string 5</UrlDetails>
  </SearchResultModel>
</ArrayOfSearchResultModel>