Version: 2011.01.25

Krames StayWell External Web Service Documentation

DocumentSearchByMeSH Method

This method combines the GetMeSHList(searchphrase) and DocumentSearch(MeSHList) calls into one specialized method; it finds documents based solely on MeSH terms. It returns a small amount of meta-data for each document that matches the supplied criteria. The supplied search phrase is compared to the terms of each MeSH code assigned to the license's documents. The includedBlocked parameter is optional and defaults to false if not present. If includeBlocked is set to true, blocked documents will be included in the result xml with an attribute called “blocked” set to true.

The list of documents that match the search phrase are sorted by the following rules:

  1. A MeSH term matches the search phrase exactly and the RegularTitle contains the search phrase
  2. A MeSH term matches the search phrase partially and the RegularTitle contains the search phrase
  3. A MeSH term matches the search phrase exactly
  4. All other matches

Documents within each of the three categories are sorted alphabetically on RegularTitle.

Only HTTP GET and POST calls are supported at this time

Parameter Names: searchPhrase, includeBlocked

Sample Request

http://external.ws.staywell.com/[SiteName]/Documents.svc/DocumentSearchByMesh?searchPhrase=abdomen&includeBlocked=true

Sample Result XML

<?xml version="1.0" encoding="utf-8" ?>
<DocumentList xmlns="http://ws.staywell.com">
	<Document ContentTypeId="3" ContentId="83650" MeSHTerm="Hearing">
		<RegularTitle xmlns="http://ws.staywell.com/markup">Adjusting to Having a Hearing Aid: New Ways to Hear</RegularTitle>
		<InvertedTitle xmlns="http://ws.staywell.com/markup">Hearing Aid, Adjusting to: New Ways to Hear</InvertedTitle>
	</Document>
	<Document ContentTypeId="3" ContentId="89839" MeSHTerm="Hearing">
		<RegularTitle xmlns="http://ws.staywell.com/markup">Hearing Tests for Infants and Children</RegularTitle>
	</Document>
	<Document ContentTypeId="3" ContentId="85619" MeSHTerm="Hearing">
		<RegularTitle xmlns="http://ws.staywell.com/markup">How You Hear</RegularTitle>
		<InvertedTitle xmlns="http://ws.staywell.com/markup">Hear, How You</InvertedTitle>
	</Document>
	<Document ContentTypeId="3" ContentId="85622" MeSHTerm="Hearing">
		<RegularTitle xmlns="http://ws.staywell.com/markup">Pérdida de la audición</RegularTitle>
		<InvertedTitle xmlns="http://ws.staywell.com/markup">Audición, pérdida de</InvertedTitle>
	</Document>
	<Document ContentTypeId="3" ContentId="83648" MeSHTerm="Hearing Aids">
		<RegularTitle xmlns="http://ws.staywell.com/markup">Adjusting to Wearing a Hearing Aid</RegularTitle>
		<InvertedTitle xmlns="http://ws.staywell.com/markup">Hearing Aid, Adjusting to Wearing</InvertedTitle>
	</Document>
	<Document ContentTypeId="3" ContentId="83652" MeSHTerm="Hearing Aids">
		<RegularTitle xmlns="http://ws.staywell.com/markup">Assistive Listening Devices (ALDs)</RegularTitle>
		<InvertedTitle xmlns="http://ws.staywell.com/markup">Assistive Listening Devices (ALDs) </InvertedTitle>
	</Document>
	<Document ContentTypeId="3" ContentId="83641" MeSHTerm="Hearing Tests">
		<RegularTitle xmlns="http://ws.staywell.com/markup">Audiograma</RegularTitle>
		<InvertedTitle xmlns="http://ws.staywell.com/markup">Audiograma </InvertedTitle>
	</Document>
	<Document ContentTypeId="3" ContentId="83646" MeSHTerm="Hearing Aids">
		<RegularTitle xmlns="http://ws.staywell.com/markup">Caring for a Hearing Aid</RegularTitle>
		<InvertedTitle xmlns="http://ws.staywell.com/markup">Hearing Aid, Caring for a</InvertedTitle>
	</Document>
</DocumentList>