These XML WebServices functions are replicated from the uBio SOAP methods. Each function returns an XML structure similar to that returned from the SOAP methods. Click on the function name below to see an example of the structure returned (the keyCode included in the examples will only work for uBio administrators. Get your own keycode here). Strings returned by the webservice are base64 encoded for XML delivery.

namebank_object:
   This function will return all Namebank data pertaining to a particular NameBankID
   ex: http://www.ubio.org/webservices/service.php?function=namebank_object&namebankID=2483153&keyCode=

namebankID - NameBank identifier for the record you wish to receive
keyCode - your personal uBio keycode. If you don't have one, obtain one here

classificationbank_object:
   This function will return all ClassificationBank data pertaining to a particular ClassificationBankID
   ex: http://www.ubio.org/webservices/service.php?function=classificationbank_object&hierarchiesID=4091702&synonymsFlag=1&keyCode=

hierarchiesID - ClassificationBank identifier for the record you wish to receive
childrenFlag - (0 or 1) to include the taxon's children taxa
ancestryFlag - (0 or 1) to include the taxon's taxonomic ancestry
justificationsFlag - (0 or 1) to include the bibliographic references
synonymsFlag - (0 or 1) to include the taxon's synonymous taxa
keyCode - your personal uBio keycode. If you don't have one, obtain one here

namebank_search:
   This function will return NameBankIDs that match given search terms
   ex: http://www.ubio.org/webservices/service.php?function=namebank_search&searchName=Octopus&sci=1&vern=1&keyCode=

searchName - search term to search by nameString
searchAuth - search term to search by authorship
searchYear - search term to search by year
order - (nameString or languageCode) by default the results will be ordered by nameString
sci - (0 or 1) to include scientific name results
vern - (0 or 1) to include vernacular (common name) results
keyCode - your personal uBio keycode. If you don't have one, obtain one here

classificationbank_search:
   This function will return ClassificationBankIDs (hierarchiesIDs) that refer to the given NamebankID
   ex: http://www.ubio.org/webservices/service.php?function=classificationbank_search&namebankID=3070378&keyCode=

namebankID - NameBank identifier you wish to search for in ClassificationBank
classificationTitleID - Include if you only which to search within a particular classification
keyCode - your personal uBio keycode. If you don't have one, obtain one here

findIT:
   This function uses our FindIT algorithm to scan for and return the scientific names within the given text
   ex: http://www.ubio.org/webservices/service.php?function=findIT&url=http://www.ubio.org/tools/Small.txt&strict=1

url - Include to get names from a web resource (webpages, text files, or PDF documents)
freeText - Include to only get names from the given block of text
strict - (0 or 1) setting to 1 will only find names without authorship. Strict mode finds valid nameString more reliably
threshold - (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)

taxonFinder:
   This function uses our TaxonFinder algorithm to scan for and return the scientific names within the given text
   ex: http://www.ubio.org/webservices/service.php?function=taxonFinder&includeLinks=1&url=http://www.ubio.org/tools/Small.txt

url - Include to get names from a web resource (webpages, text files, or PDF documents)
freeText - Include to only get names from the given block of text
includeLinks - (0 or 1) setting to 1 will include data from the NameBank collection of web resources on the taxa names returned

namebank_packageList:
   This function returns the package name for a given packageID
   Warning - if no packageID is included over 17,000 elements will be returned
   ex: http://www.ubio.org/webservices/service.php?function=namebank_packageList&packageID=570&keyCode=

packageID - including a packageID will limit the result to just the one package
keyCode - your personal uBio keycode. If you don't have one, obtain one here

classification_list:
   This function returns the title, description, and classificationIDs for all classifications indexed in ClassificationBank
   ex: http://www.ubio.org/webservices/service.php?function=classification_list&keyCode=

classificationTitleID - include a classificationTitleID to limit results to a single classification
keyCode - your personal uBio keycode. If you don't have one, obtain one here

language_list:
   This function returns all of the languages and languageCodes used by NameBank to categorize vernacular common names
   ex: http://www.ubio.org/webservices/service.php?function=language_list&keyCode=

keyCode - your personal uBio keycode. If you don't have one, obtain one here

synonym_list:
   This function returns all of the synonyms for a taxon according to a particular classification
   ex: http://www.ubio.org/webservices/service.php?function=synonym_list&hierarchiesID=4091702&keyCode=

hierarchiesID - you must include the hierarchiesID (ClassificationBankID) to receive the classification synonyms
keyCode - your personal uBio keycode. If you don't have one, obtain one here

namebank_search_authors:
   This function searches a database of author names and variants
   ex: http://www.ubio.org/webservices/service.php?function=namebank_search_authors&searchAuth=Linn%

searchAuth - term to search author database. Use % as wildcard. If using wildcard or 'contains' qualifier, at least 3 characters must be included
searchQualifier - (exact, contains, or regex) use the qualifier to modify search flexibility
limitBP - (1-6) use to limit results to particular author list

namebank_object_authors:
   This function returns all variants of a particular author's name
   ex: http://www.ubio.org/webservices/service.php?function=namebank_object_authors&groupID=9

groupID - you must include the groupID for the author name group to be returned