POST api/Search/GetSearchResults
Request Information
URI Parameters
None.
Body Parameters
SearchInput| Name | Description | Type | Additional information |
|---|---|---|---|
| Sentence | string |
None. |
|
| SearchGroupID | integer |
None. |
|
| SearchObjects | Collection of enumSearchObjects |
None. |
|
| Filters | Collection of integer |
None. |
|
| FilterParameters | Collection of SearchFilterParameters |
None. |
|
| URL | string |
None. |
|
| PageRowStart | integer |
None. |
|
| PageRowEnd | integer |
None. |
Request Formats
application/json, text/json
Sample:
{
"sentence": "sample string 1",
"searchGroupID": 1,
"searchObjects": [
1,
1
],
"filters": [
1,
2
],
"filterParameters": [
{
"searchFilterID": 1,
"parameters": [
{
"name": "sample string 1",
"value": "sample string 2"
},
{
"name": "sample string 1",
"value": "sample string 2"
}
]
},
{
"searchFilterID": 1,
"parameters": [
{
"name": "sample string 1",
"value": "sample string 2"
},
{
"name": "sample string 1",
"value": "sample string 2"
}
]
}
],
"url": "sample string 2",
"pageRowStart": 1,
"pageRowEnd": 1
}
application/xml, text/xml
Sample:
<SearchInput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIService.Models.Public.Search">
<FilterParameters>
<SearchFilterParameters>
<Parameters>
<SearchFilterParameters.Parameter>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</SearchFilterParameters.Parameter>
<SearchFilterParameters.Parameter>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</SearchFilterParameters.Parameter>
</Parameters>
<SearchFilterID>1</SearchFilterID>
</SearchFilterParameters>
<SearchFilterParameters>
<Parameters>
<SearchFilterParameters.Parameter>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</SearchFilterParameters.Parameter>
<SearchFilterParameters.Parameter>
<Name>sample string 1</Name>
<Value>sample string 2</Value>
</SearchFilterParameters.Parameter>
</Parameters>
<SearchFilterID>1</SearchFilterID>
</SearchFilterParameters>
</FilterParameters>
<Filters xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:int>1</d2p1:int>
<d2p1:int>2</d2p1:int>
</Filters>
<PageRowEnd>1</PageRowEnd>
<PageRowStart>1</PageRowStart>
<SearchGroupID>1</SearchGroupID>
<SearchObjects>
<enumSearchObjects>OpportunitySearch_Jobs</enumSearchObjects>
<enumSearchObjects>OpportunitySearch_Jobs</enumSearchObjects>
</SearchObjects>
<Sentence>sample string 1</Sentence>
<URL>sample string 2</URL>
</SearchInput>
application/x-www-form-urlencoded
Sample:
Sample not available.
Response Information
Resource Description
SearchResultsOutput| Name | Description | Type | Additional information |
|---|---|---|---|
| Results | Collection of Object |
None. |
|
| ResultCount | integer |
None. |
Response Formats
application/json, text/json
Sample:
{
"results": [
{},
{}
],
"resultCount": 1
}
application/xml, text/xml
Sample:
<SearchResultsOutput xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/APIService.Models.Public.JobSearch">
<ResultCount>1</ResultCount>
<Results xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d2p1:anyType />
<d2p1:anyType />
</Results>
</SearchResultsOutput>