VitalWare API

<back to all web services

SherpaSearchSuggestions

The following routes are available for this service:
GET POST/sherpaSearchSuggestionsGet search suggestions based on user input
GET POST/sherpaSearchSuggestions/{word}Get search suggestions based on user inputWord can be directly within the URL as part of the path

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /xml/reply/SherpaSearchSuggestions HTTP/1.1 
Host: api.vitalware.com 
Content-Type: application/xml
Content-Length: length

<SherpaSearchSuggestions xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
  <word>String</word>
</SherpaSearchSuggestions>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<SherpaSearchSuggestionsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/ServiceStack">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
      </d2p1:ResponseError>
    </d2p1:Errors>
  </ResponseStatus>
  <request>
    <word>String</word>
  </request>
  <result>
    <SearchSuggestionConcept>
      <concept>String</concept>
      <conceptBaseId>0</conceptBaseId>
    </SearchSuggestionConcept>
  </result>
</SherpaSearchSuggestionsResponse>