lexs:SearchResponseMetadata

Element information

Content

• Sequence [1..1]
  1. lexs:StructuredQueryMatchScore [0..1]Structured query match score is a positive integer between 0 and 100 representing a hit percentage. Service providers will make best effort to answer queries the way they are asked. StructuredQueryMatchScore represents the number of search elements that were matched for a structured search query. A result that matches all requested fields is always a perfect match, represented by the value 100. Match scores for structured queries where the service provider had to ignore one or more search terms will be provided using numbers less than 100 to represent the percentage. StructuredQueryMatchScore is not applicable for text search results.
  2. lexs:MaxItemMatchesRequested [1..1]The maximum number of hits the user (or application acting on behalf of the user) wants back in a response.
  3. lexs:NumberItemMatches [1..1]Number of matches found, as opposed to returned, by the service provider. Text field that can contain a number or an indication that there were more than a certain number of hits, such as 100+.
  4. lexs:ServerLimitIndicator [1..1]A flag which indicates whether the number of hits was restricted due to a service provider limit. True means the number returned was limited due to a server restriction.
  5. lexs:MatchBeginPoint [0..1]Value is used by a service provider on a next/previous query to determine what set of data to return. Value is of string type to give service provider as much flexibility as possible for point data format.
  6. lexs:MatchEndPoint [0..1]Value is used by a service provider on a next/previous query to determine what set of data to return. Value is of string type to give service provider as much flexibility as possible for point data format.
  7. lexs:ServiceProviderSearchID [0..1]Search ID value that is meaningful to the service provider for returning additional hits. This allows the service provider to utilize any state information it may retain so that it does not have to rerun the query again to get the next or previous set of results. Service providers define this value; requesters merely copy the value back into the follow-up query.
  8. lexs:DomainAttribute [0..1]Placeholder for various domain attributes. For Value/Pair attributes use lexs:AttributeName and lexs:AttributeValue elements. For hierarchical data xsd:any structure should be used.

Attributes

Used in

• Type lexs:SearchResponseMessageType (Element lexs:SearchResponseMessage)

Sample instance

<lexs:SearchResponseMetadata>
   <lexs:MaxItemMatchesRequested>10</lexs:MaxItemMatchesRequested>
   <lexs:NumberItemMatches>0</lexs:NumberItemMatches>
   <lexs:ServerLimitIndicator>false</lexs:ServerLimitIndicator>
</lexs:SearchResponseMetadata>