Enterprise Search API

Endpoint Index

Action	Endpoint
Execute Search	POST /search
Search Result Pagination	GET /search/{searchToken}/{pageNumber}

Details

Execute Search¶

POST /search

Request:

Name	Position	Type	Required
searchRequest	body	SearchRequest	required

Response: SearchResponse

SearchRequest¶

optional
includeReplaced boolean
products [string]
returnType string
searchString string
searchTerms [SearchTermRequest]

Note

Either searchString or searchTerms must be provided. See the search syntax section for details on searchString syntax.

SearchResponse¶

required
results [SearchResultResponse]

optional
pageNumber integer
searchToken string

Note

No search results is signified by an empty results array.

SearchResultResponse¶

required
policyholderLocator string
score number
type string

optional
policyLocator string
claimLocator string
paymentDisplayId string
paymentLocator string
premiumReportLocator string
quoteLocator string
searchSummary [SearchSummaryItemResponse]
subclaimLocator string

SearchSummaryItemResponse¶

required
fieldName string
fieldType string
fieldValue [string]

All SearchSummaryItemResponse values will be returned as strings, regardless of configured type; for example, timestamps will be returned as numeric strings. Multi-value selects will have more than one entry for the fieldValue array.

Items in the searchSummary will be returned in the same relative order as the configured searchSummary list, but may be preceded by default SearchSummaryItemResponse entries, depending on the returned entity type.

SearchTermRequest¶

required
searchTerm string

optional
fieldName string
absolute string
match string

The SearchTermRequest property absolute can have the following values:
- none (default)
- required
- excluded
The SearchTermRequest property match can have the following values:
- fuzzy (default)
- exact
- startsWith

Search Result Pagination¶

GET /search/{searchToken}/{pageNumber}

Request:

Name	Position	Type	Required
pageNumber	path	string	required
searchToken	path	string	required

Response: SearchResponse

Search String Examples

Search Intent	Search String
Search all fields for red	`red`
Search all fields for red	`+red`
Search all fields for excluding red	`-red`
Search all fields for red or green	`red green`
Search all fields for red and green	`+red +green`
Search all fields for (red or green) and blue	`red green +blue`
Search all fields for exact match “dark red” and green	`"dark red" +green`
Search “door” field for exact match “dark red” and all fields for green	`door:"dark red" +green`
Search all fields for dark or red or exact match blue	`dark red "blue"`
Search all fields for exact match “dark red” or exact match “dark green”	`"dark red" "dark green"`
Search “door” for red or “hood” for green	`door:red hood:green`
Search “front door” field for “dark red” and field “hood” that starts with “blue”	`"front door": "dark red" +hood:blue*`