POST api/CandidateSearch

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
Query	string	None.
ScrollId	string	None.
SearchLocation	string	None.
Distance	string	None.
DateFilter	string	None.
BusinessUnit	Collection of BusinessUnit	None.

Request Formats

application/json, text/json

Sample:

{
  "Query": "sample string 1",
  "ScrollId": "sample string 2",
  "SearchLocation": "sample string 3",
  "Distance": "sample string 4",
  "DateFilter": "sample string 5",
  "BusinessUnit": [
    {
      "BusinessUnitId": "sample string 1"
    },
    {
      "BusinessUnitId": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample:

<SearchQuery xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/PrismAPI.Controllers">
  <BusinessUnit>
    <BusinessUnit>
      <BusinessUnitId>sample string 1</BusinessUnitId>
    </BusinessUnit>
    <BusinessUnit>
      <BusinessUnitId>sample string 1</BusinessUnitId>
    </BusinessUnit>
  </BusinessUnit>
  <DateFilter>sample string 5</DateFilter>
  <Distance>sample string 4</Distance>
  <Query>sample string 1</Query>
  <ScrollId>sample string 2</ScrollId>
  <SearchLocation>sample string 3</SearchLocation>
</SearchQuery>

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

Response Information

Resource Description

ISearchResponseOfCandidateSearchResult

Name	Type	Additional information
Shards	ShardStatistics	None.
HitsMetadata	HitsMetadataOfCandidateSearchResult	None.
Aggregations	Collection of Object	None.
Aggs	Collection of Object	None.
Profile	Profile	None.
Suggest	Collection of Object	None.
Took	integer	None.
TimedOut	boolean	None.
TerminatedEarly	boolean	None.
ScrollId	string	None.
Total	integer	None.
MaxScore	decimal number	None.
NumberOfReducePhases	integer	None.
Documents	Collection of CandidateSearchResult	None.
Hits	Collection of IHitOfCandidateSearchResult	None.
Fields	Collection of Collection of Object	None.

Response Formats

application/json, text/json, application/xml, text/xml

Sample:

Sample not available.