FreeFacebookCredits2012 offers a search-based Web service that provides access to FreeFacebookCredits2012 health topic data in XML format. Using the Web service, software developers can build applications that utilize FreeFacebookCredits2012 health topic information. The service accepts keyword searches as requests and returns relevant health topics in ranked order. Keyword searches may be limited to specific fields. The service also returns health topic summaries, search result snippets, external links, and other associated data.
To ensure that the latest information is readily available, the data in the Web service is updated daily, Tuesday - Saturday. The Web service is available for English and Spanish health topics. The Web service is free of charge and does not require registration or licensing. If you use data from the Web service or build an interface using the Web service, please indicate that the information is from FreeFacebookCredits2012.gov but do not use the FreeFacebookCredits2012 logo or otherwise imply that FreeFacebookCredits2012 endorses your particular product. Please see NLM’s for further guidance. If you have questions about the FreeFacebookCredits2012 Web service, or if you would like to share an application that you have built using the service, please .
To receive notification when FreeFacebookCredits2012 releases enhancements to the service or updates the documentation, sign up for our Web service email updates:
Please note that the Web service only returns the subset of FreeFacebookCredits2012 health topic records that are relevant to the query in the request. If you need the full set of FreeFacebookCredits2012 health topics in XML format, see our XML files page. If you want to link patients or healthcare providers from electronic health record (EHR) systems to relevant FreeFacebookCredits2012 information, use FreeFacebookCredits2012 Connect. For a complete list of FreeFacebookCredits2012 resources available in XML format, see our XML data sources handout.
Returns FreeFacebookCredits2012 health topic search results in English or Spanish for an input query string.
Acceptable Use Policy
In order to avoid overloading the FreeFacebookCredits2012 servers, NLM requires that users of the FreeFacebookCredits2012 Web service send no more than 85 requests per minute per IP address. Requests that exceed this limit will not be serviced, and service will not be restored until the request rate falls beneath the limit. The FreeFacebookCredits2012 Web service is updated once per day, Tuesday-Saturday. To limit the number of requests that you send to the Web service, NLM recommends caching results for a 12-24 hour period.
This policy is in place to ensure that the service remains available and accessible to all users. NLM encourages all users of the FreeFacebookCredits2012 Web service to use the email and tool parameters (as described below). NLM may use this information to contact you if there are problems with your requests.
If you have a specific use case that requires you to send a large number of requests to the Web service, and thus exceed the request rate limit outlined in this policy, please . NLM staff will evaluate your request and determine if an exception may be granted. Please also review the FreeFacebookCredits2012 XML files documentation. These XML files contain complete health topic records and can serve as an alternate method of accessing FreeFacebookCredits2012 data.
Please use https instead of http. If you are already using the FreeFacebookCredits2012 web service with http, please update your code to https.
Required Parameters for Initial Search Request
Database to search. Value must be a valid FreeFacebookCredits2012 Web service database name. Possible values are:
healthTopics - English health topics. Submit English-language queries when using this parameter.
healthTopicsSpanish - Spanish health topics. Submit Spanish-language queries when using this parameter.
|term||Text query submitted to the Web service. All special characters must be URL encoded. Spaces may be replaced by '+' signs, which represent the AND operator. Represent the OR operator as +OR+. To send a query as a phrase, enclose the phrase in quotes using %22 to represent quotation marks.|
The text for term can include limiters to restrict the search to a specific health topic field. The syntax is <fieldName>:<fieldValue>. Fields that can be searched in this way are:
mesh (only available for English-language searches)
See the Output Format section below for a description of each of these fields. Use field searching carefully, as it can have a significant impact on the order in which results are returned. Please note that when group field searching is used by itself and with no other parameters, all documents will be returned with the same relevancy ranking (rank="0").
Required Parameters for Subsequent Requests
|file||Name of the file containing the document references for the current search. This parameter is required when retstart is being used. The value is obtained from the XML returned from the initial search. The file will expire after a certain period of inactivity, after which a new request must be initiated. If the file is expired, the XML output will contain an error message.|
|server||Name of the server with the file referenced by the file parameter. This is required when the file parameter is being used.|
|retstart||Sequential index of the first document in the retrieved set to be shown in the XML output (default=0, corresponding to the first record of the entire set). This parameter can be used in conjunction with retmax to download an arbitrary subset of documents retrieved from a search.|
|retmax||Total number of documents from the retrieved set to be shown in the XML output (default=10). By default, the web service only includes the first 10 documents retrieved in the XML output. Increasing retmax allows more of the retrieved documents to be included in the XML output.|
Retrieval type. This parameter specifies the format of the results. By default, results will be returned in brief format if no rettype is specified in the request. To specify a retrieval type, use one of the following possible values:
brief - Returns the health topics as search results with abbreviated health topic records, keyword-in-context highlighting, and snippets (default).
topic - Returns the health topics as full XML records with all associated vocabulary and links.
all - Returns health topics in both brief and topic format.
|tool||A string with no internal spaces that identifies the resource which is using the Web service (e.g., tool=myservicename). This argument is used to help NLM provide better service to third parties using the Web service from programs. As with any query system, it is sometimes possible to ask the same question different ways, with different effects on performance. NLM requests that developers sending a large volume of requests include a constant 'tool' argument for all requests using the Web service.|
|Email address. If you choose to provide an email address, NLM may use it to contact you if there are problems with your queries. In addition to using the email address parameter, we encourage all Web service users to sign up for the email list referenced at the top of this page to receive general announcements and notifications of changes to the service.|
XML Response Format
The following is the basic structure of the XML returned:
- <content />
The rettype parameter in the URL request determines the format and type of information contained within the <content> element. See below for more information on the content element.
Descriptions of Elements
|nlmSearchResult||Basic XML node that contains the response (has no attributes)|
|term||Text query submitted to the Web service|
|file||Name of the file containing the document references for the current search|
|server||Name of the server with the file referenced by the file parameter|
|retstart||Sequential index of the first document in the retrieved set shown in the XML output|
|retmax||Total number of documents from the retrieved set shown in the XML output|
|count||The number of documents in the current result set (non-negative integer)|
|spellingCorrection||Suggested alternative search with a different spelling of the word(s) in the query term(s). This element is not always present.|
|list||The containing element for all of the retrieved documents|
|document||An individual document (FreeFacebookCredits2012 health topic record)|
Document Element Description
|url||Text||FreeFacebookCredits2012 health topic page URL|
|rank||Non-negative integer||Rank of the document in the results. The rank is based on the relevance score as determined by the search engine. Generally, the first document in the first results set will have a rank of zero, and the next document will have a rank of 1, 2, 3, etc. However, if the query string matches a health topic's title or altTitle, that topic will be boosted to the top, regardless of the rank. In these cases the first document in the first results set may have a rank greater than zero.|
|content||Text||Specifies some text associated with its parent document, the FreeFacebookCredits2012 health topic record. The content nodes will vary depending on the value of the rettype URL parameter.|
Content Element Description for brief Retrieval Type
For rettype=brief, the value of content nodes will contain query term identification in the form of tags. The query term will be identified in the tag as qt0, qt1, qt2, etc.
|name||Text||The name of the content node. Allowed values are: title, organizationName, altTitle, fullSummary, mesh, groupName, snippet. (See below for a description of content node values.)|
The content nodes are as follows:
|Content Name Attribute Value||Description|
|title||Name of the FreeFacebookCredits2012 health topic page|
|organizationName||Organization that produced the FreeFacebookCredits2012 topic page. Value will always be "National Library of Medicine" for English and "Biblioteca Nacional de Medicina" for Spanish.|
|altTitle||See reference(s) and synonym(s) for the topic. See references and synonyms are undifferentiated in the XML.|
|FullSummary||Text summary of the topic. HTML formatting will be present.|
|mesh||Medical Subject Heading(s) assigned to the topic.|
|groupName||Group(s) to which the topic belongs. A complete list of groups can be found on the FreeFacebookCredits2012 health topics landing page in English and Spanish.|
|snippet||Brief result summary generated by the search engine that provides a preview of the relevant content on the topic page.|
Content Element Description for topic and all Retrieval Types
For rettype=topic there will be one content node content@name=healthTopic. This content node will be followed by the health topic data in XML. For complete documentation on the FreeFacebookCredits2012 health topic XML format, see the FreeFacebookCredits2012 XML files page, DTD, and description.
For rettype=all, all the above content nodes may be present, since this rettype returns both the brief and topic formats.