spacing image spacing image spacing image spacing image
ITIS Logo ITIS Web Service Logo spacing image
spacing image Web Service Search APIs

 Search for Any Match
Description
Returns matches found by comparing the search key to the ITIS common names, scientific names, and TSNs.
Input
A string containing the search key.
Output
A set of strings containing the type of match, the resulting matches (scientific name and common names) and the corresponding TSNs. Common names will be a set (zero to many) of strings containing the name and its language. If there are no matches, an empty result set will be returned.
Example
http://www.itis.gov/ITISWebService/services/ITISService/searchForAnyMatch?srchKey=dolphin (by text)
http://www.itis.gov/ITISWebService/services/ITISService/searchForAnyMatch?srchKey=202385 (by TSN)

 Search for Any Match Paged
Description
Returns matches found by comparing the search key to the ITIS common names, scientific names, and TSNs. Number of matches returned are limited by the page size. Position in the result set is determined by the page number. Search results can be provided in ascending or descending alphabetical order.
Input
A string containing the search key.
An integer containing the page size
An integer containing the page number
A boolean containing true for ascending sort order or false for descending.
Output
A set of strings containing the type of match, the resulting matches (scientific name and common names) and the corresponding TSNs. Common names will be a set (zero to many) of strings containing the name and its language. If there are no matches, an empty result set will be returned.
Example
http://www.itis.gov/ITISWebService/services/ITISService/searchForAnyMatchPaged?srchKey=Zy&pageSize=100&pageNum=1&ascend=false (by text)
http://www.itis.gov/ITISWebService/services/ITISService/searchForAnyMatchPaged?srchKey=202385&pageSize=100&pageNum=1&ascend=false (by TSN)

 Get Any Match Count
Description
Returns a count of the matches found by comparing the search key to the ITIS common names, scientific names, and TSNs.
Input
A string containing the search key.
Output
An integer containing the number of matches the search will return.
Example
http://www.itis.gov/ITISWebService/services/ITISService/getAnyMatchCount?srchKey=dolphin (by text)
http://www.itis.gov/ITISWebService/services/ITISService/getAnyMatchCount?srchKey=202385 (by TSN)

 Search by Common Name
Description
Returns matches found by comparing the search key to the ITIS common names.
Input
A string containing the search key.

Note: In this function a record will match if the common name contains the search key. So, searching for bear would return entries like bear lake, bearded, beardfish, bearer, woolybear, etc. as well as names like brown bear, grizzly bear, black bear, etc.
Output
A set of strings containing the resulting matches and their corresponding Scientific name, TSN, and language. If there are no matches, an empty result set will be returned.
Example
http://www.itis.gov/ITISWebService/services/ITISService/searchByCommonName?srchKey=ferret-badger
http://www.itis.gov/ITISWebService/services/ITISService/searchByCommonName?srchKey=american bullfrog

 Search by Common Name Begins With
Description
Return matches found by comparing the search key to the beginning of the ITIS common names.
Input
A string containing the search key.

Note: In this function a record will match if the common name starts with the search key. So, searching for bear would return entries that start with bear, like bear lake, bearded barbet, beardfish, but not barred livebearer, woollybear, black bear, etc.
Output
A set of strings containing the resulting matches and their corresponding Scientific name, TSN, and language. If there are no matches, an empty result set will be returned.
Example
http://www.itis.gov/ITISWebService/services/ITISService/searchByCommonNameBeginsWith?srchKey=inch

 Search by Common Name Ends With
Description
Return matches found by comparing the search key to the end of the ITIS common names.
Input
A string containing the search key.

Note: In this function a record will match if the common name ends with the search key. So, searching for bear would return entries that end with bear, like Asian Black Bear, grizzly bear, brown bear, banded woollybear, but not bear lake, bearded barbet, beardfish, barred livebearer, etc.
Output
A set of strings containing the resulting matches and their corresponding Scientific name, TSN, and language. If there are no matches, an empty result set will be returned.
Example
http://www.itis.gov/ITISWebService/services/ITISService/searchByCommonNameEndsWith?srchKey=grizzly%20bear

 Search by Scientific Name
Description
Returns matches found by comparing the search key to the ITIS full Scientific Names, both with and without the indicator fields.
Input
A string containing the search key. This may contain only the individual name parts or a mixture of the name and indicator parts as contained in the ITIS database.

Note: In this function a record will match if the scientific name contains the search key. So, searching for ursus would return entries like Pheidole ursus, Pseudotropheus pursus, Ursus Linnaeus, Ursus americanus Pallas, Ammopursus ohlingerae, Senecio aureus var. intercursus, etc.
Output
A set of strings containing the resulting matches and their corresponding TSN, or an empty result set if there are no matches.
Example
http://www.itis.gov/ITISWebService/services/ITISService/searchByScientificName?srchKey=Tardigrada

 Get ITIS Terms
Description
Gets a list of ITIS Terms as used by the Resource Catalog Input Tool from a common or scientific name match, or an empty result set if there is no match.
Input
A string containing the name to match.
Output
A set of data structures containing the scientific name, a list of common names and the usage information, or an empty set if there is no match.
Example
http://www.itis.gov/ITISWebService/services/ITISService/getITISTerms?srchKey=bear

 Get ITIS Terms from Common Name
Description
Gets a list of ITIS Terms as used by the Resource Catalog Input Tool from a common name match, or an empty result set if there is no match.
Input
A string containing the name to match.
Output
A set of data structures containing the scientific name, a list of common names and the usage information, or an empty set if there is no match.
Example
http://www.itis.gov/ITISWebService/services/ITISService/getITISTermsFromCommonName?srchKey=buya

Get ITIS Terms from Scientific Name
Description
Gets a list ITIS Terms as used by the Resource Catalog Input Tool from a scientific name match, or an empty result set if there is no match.
Input
A string containing the name to match.
Output
A set of data structures containing the scientific name, a list of common names and the usage information, or an empty set if there is no match.
Example
http://www.itis.gov/ITISWebService/services/ITISService/getITISTermsFromScientificName?srchKey=ursidae

Get TSNs By Vernacular Language
Description
Provide a listing of TSNs with vernaculars entered in the requested language. Currently language is only specified in the ITIS database for vernaculars.
Input
A string containing the language. This is a language string, not the international language code. Currently supported strings can be obtained from the Get Vernacular Languages API.
Output
A set of strings containing the matching TSNs, or an empty set if there is no match.
Example
http://www.itis.gov/ITISWebService/services/ITISService/getTsnByVernacularLanguage?language=french
spacing image
spacing image spacing image spacing image spacing image
A gray bar