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 .jsv suffix or ?format=jsv

HTTP + JSV

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

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

{
	word: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	request: 
	{
		word: String
	},
	result: 
	[
		{
			conceptBaseId: 0,
			concept: String
		}
	],
	responseStatus: 
	{
		errorCode: String,
		message: String,
		stackTrace: String,
		errors: 
		[
			{
				errorCode: String,
				fieldName: String,
				message: String
			}
		]
	}
}