Find name...    11,106,374 NameBank Records
 
 uBio Project
Introduction
News
 
 Servers
NameBank
 ClassificationBank
List Classifications
Statistics
Name sources
Attribution
Reports
 
 Web Services
Methods
Using uBio SOAP
 
 Sample Applications
References
Nomenclator Zoologicus
uBioRSS
uBioPortal
Demo Applications
 
 Tools/Algorithms
LinkIT
FindIT
ParseIT
MapIT
CrawLIT
X:ID
 
 Editors: Sign in
TNS version 2 methods WebServices - TNS version 1 methods | TNS version 2 methods | XML methods

TNS version 2 methods are accessible via the SOAP service (http://ubio.org/soap/). TNS version 2 represents the current development version of uBio services and uses the development version of NameBank with over 5.7 million records.


Functions:
namebank_object:
   Returns a NameBank data object based on it's unique identifier
namebankID (int) - NameBank identifier for the record you wish to receive
keyCode (string) - your uBio keycode. If you don't have one, obtain one here

namebank_search:
   Searches NameBank for scientific or vernacular names
searchName (string) - term to search within name string
searchAuth (string) - term to search within name authorship
searchYear (string) - term to search within name year
order (string) - (name or namebankID) field by which the results will be sorted (default is namebankID)
rank (string) - (equals, begins, contains) type of search query to be performed (default is contains)
sci (int) - (sci, vern, or all) type of results to be returned (default is all)
linkedVern (int) - number of first record to be returned
vern (int) - (limit 1000) maximum number of results to be returned (default is 1000)
keyCode (string) - your uBio keycode. If you don't have one, obtain one here

classificationbank_object:
   Returns a classification object containing taxonomic concept information
hierarchiesID (int) - ClassificationBank identifier for the record you wish to receive
childrenFlag (int) - (0 or 1) to include the classifications' children of the taxon
ancestryFlag (int) - (0 or 1) to include the classifications' taxonomic ancestry of the taxon
justificationsFlag (int) - (0 or 1) to include the classifications' bibliographic references for the taxon
synonymsFlag (int) - (0 or 1) to include the classifications' synonyms of the taxon
clientVersion (string) - (0 or 1) to include the classifications' synonyms of the taxon
requestorIP (string) - (0 or 1) to include the classifications' synonyms of the taxon
keyCode (string) - your uBio keycode. If you don't have one, obtain one here

classificationbank_search:
   Searches ClassificationBank for instances of a specific name
namebankID (int) - NameBank identifier you wish to search for in ClassificationBank
clientVersion (string) - NameBank identifier you wish to search for in ClassificationBank
requestorIP (string) - NameBank identifier you wish to search for in ClassificationBank
classificationTitleID (int) - NameBank identifier you wish to search for in ClassificationBank
keyCode (string) - your uBio keycode. If you don't have one, obtain one here

classification_list:
   Returns a list of classification identifiers and description metadata
classificationTitleID (int) - include a classificationTitleID to limit results to a single classification
clientVersion (string) - your personal uBio keycode. If you don't have one, obtain one here
requestorIP (string) - your personal uBio keycode. If you don't have one, obtain one here
keyCode (string) - your uBio keycode. If you don't have one, obtain one here

synonym_list:
   A specialized method taking multiple concept identifiers as arguments and returning distinct synonymy array
hierarchiesID (int[] array) - the ClassificationBank identifier to receive the classification synonyms
clientVersion (string) - version if your SOAP client (optional)
requestorIP (string) - IP address of remote user of your SOAP client (optional)
keyCode (string) - your uBio keycode. If you don't have one, obtain one here

language_list:
   Returns a list of language names and codes for use with language limits in name search functions. Based on MARC, ISO language codes
clientVersion (string) - including a packageID will limit the result to just the one package
requestorIP (string) - including a packageID will limit the result to just the one package
keyCode (string) - your uBio keycode. If you don't have one, obtain one here

namebank_search_authors:
   One of two methods associated with the Author Abbreviation Resolver. This method searches the author dataset by string and returns a SOAP object or XML string
searchAuth (string) - term to search author database. Use % as wildcard. If using wildcard or 'contains' qualifier, at least 3 characters must be included
searchQualifier (string) - (exact, contains, or regex) use the qualifier to modify search flexibility
limitBP (int) - (1-6) use to limit results to particular author list
returnXML (int) - (0 or 1) use to limit results to particular author list

namebank_object_authors:
   The second of two methods associated with the Author Abbreciation Resolver. This method retrieves author groups based on a unique identifier (obtained through a keyword search with the namebank_search_authors) method. Output is a SOAP object or XML string
groupID (int) - you must include the groupID for the author name group to be returned
returnXML (int) - (0 or 1) use to limit results to particular author list

taxonFinder:
   This function uses our TaxonFinder algorithm to scan for and return the scientific names within the given text
url (string) - Include to get names from a web resource (webpages, text files, or PDF documents)
freeText (string) - Include to only get names from the given block of text
includeLinks (int) - (0 or 1) setting to 1 will include data from the NameBank collection of web resources on the taxa names returned

findIT:
   This function uses our FindIT algorithm to scan for and return the scientific names within the given text
url (string) - Include to get names from a web resource (webpages, text files, or PDF documents)
freeText (string) - Include to only get names from the given block of text
strict (int) - (0 or 1) setting to 1 will only find names without authorship. Strict mode finds valid nameString more reliably
threshold (float) - (between 0 and 1) if strict=0, setting a threshold closer to 1 will decrease the flexibility of the algorithm (.5 is a common setting)

Mission statement | Advisory board | People | Contact us
uBio copyright © 2017 by The Marine Biological Laboratory