Therefore Web API Programming Interface 1.0

Zoom Window Out
Larger Text | Smaller Text
Hide Page Header
Show Expanding Text
Printable Version
Save Permalink URL

Therefore Web API > Web API Reference > Operations

GetNextSearchSessionHits

REST URL (POST) https://tenant.thereforeonline.com/theservice/v0001/restun/GetNextSearchSessionHits

SOAP Action (POST) http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetNextSearchSessionHits

Gets the next set of results (hits) for the given full-text search session. Returns only the new hits (those found at the moment and not yet sent/requested via GetNextSearchSessionHits).

Input Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetNextSearchSessionHits

Element Name

Element Type

Restrictions

Description

■ parameters

■ SessionId

xs:string

mandatory

GUID string template:

[\da-fA-F]{8}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{4}-[\da-fA-F]{12}

Sets the ID of the search session.

Output Message: http://schemas.therefore.net/webservices/interop/v0001/messages/IThereforeService/GetNextSearchSessionHitsResponse

Element Name	Element Type	Restrictions	Description
■ parameters
□ Hits		nillable	Gets the next set of results (hits) for the given full-text search session.
≡ WSSearchSessionHit		list nillable
■ StreamNo	xs:int		A zero-based index of the document stream associated with the search hit.
■ PageNo	xs:int		A 1-based index of the page associated with the search hit.
□ Text	xs:string	nillable	A string value that respresents the found text.
□ LeftHighlightItem		nillable	Gets the left highlight. Can be Null if it isn't available.
□ Text	xs:string	nillable	A string value that represents the text of the highlight.
□ RightHighlightItem		nillable	Gets the right highlight. Can be Null if it isn't available.
□ Text	xs:string	nillable	A string value that represents the text of the highlight.
■ IsCompleted	xs:boolean		Retrieves the status of the search session. If it returns 'false', it means there may be more hits to be found and returned in the next call to the GetNextSearchSessionHits method.

Legend:

■	Not nillable element.
□	Nillable element.
≡	List of elements.
Bold	Mandatory element.