Skip to content
This repository

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP

API for taxonfinder & NetiNeti namefinding tools

branch: master

This branch is 0 commits ahead and 0 commits behind master

Fetching latest commit…

Cannot retrieve the latest commit at this time

README
NameFinding API Documentation

Required Gems:
bundler (this will take care of gem installation)

Dependencies:
TaxonFinder Perl server

URL:
http://namefinding.localhost/find/

Inputs:

-input
  --requirements: Input must be URL encoded.
  --description:  Free text or url to be parsed or followed and parsed.
  --example:
    -input:   "Mus musculus is a species in this sentence"
    -usage:   http://namefinding.localhost/find?input=Mus+musculus+is+a+species+in+this+sentence&type=text&format=xml&client=neti
  --example:
    -input:   "http://names.mbl.edu/tools/Small.txt"
    -usage:   http://namefinding.localhost/find?input=http%3A%2F%2Fnames.mbl.edu%2Ftools%2FSmall.txt&type=url&format=xml&client=taxonfinder

-type
  --description:  Type of input.
  --options:      text, url
  --example:      see examples above

-format
  --description:  The preferred output format. This will default to XML if not provided.
  --options:      xml,json
  --example:      see examples above

-client
  --description:  Which algorithm you want to use to find names.
  --options:      neti, taxonfinder
  --example:      see examples above

HTTP Method(s):
GET
 
Requires Authentication:
false
 
Rate limited:
false
 
Outputs:

Each name found will return the following details:

verbatim:           The exact string which was matched
dwc:scientificName: The scientific name which was found
offset:             The character offsets of the first and last characters in the name


Response: 
XML example (truncated):
          
<?xml version="1.0" encoding="UTF-8"?>
<names xmlns:dwc="http://rs.tdwg.org/dwc/terms/">
  <name>
    <verbatim>Angiospermae</verbatim>
    <dwc:scientificName>Angiospermae</dwc:scientificName>
    <offsets>
      <offset start="599" end="610"/>
    </offsets>
  </name>
  <name>
    <verbatim>Cycadales</verbatim>
    <dwc:scientificName>Cycadales</dwc:scientificName>
    <offsets>
      <offset start="1239" end="1247"/>
    </offsets>
  </name>
  <name>
    <verbatim>Taxaceae</verbatim>
    <dwc:scientificName>Taxaceae</dwc:scientificName>
    <offsets>
      <offset start="1438" end="1445"/>
    </offsets>
  </name>
  <name>
    <verbatim>Cycadales</verbatim>
    <dwc:scientificName>Cycadales</dwc:scientificName>
    <offsets>
      <offset start="1634" end="1642"/>
    </offsets>
  </name>
  <name>
    <verbatim>Pinales</verbatim>
    <dwc:scientificName>Pinales</dwc:scientificName>
    <offsets>
      <offset start="1714" end="1720"/>
    </offsets>
  </name>
  <name>
    <verbatim>Angiospermae</verbatim>
    <dwc:scientificName>Angiospermae</dwc:scientificName>
    <offsets>
      <offset start="1758" end="1769"/>
    </offsets>
  </name>
  <name>
    <verbatim>Pandanales</verbatim>
    <dwc:scientificName>Pandanales</dwc:scientificName>
    <offsets>
      <offset start="2684" end="2693"/>
    </offsets>
  </name>
  <name>
    <verbatim>Arales</verbatim>
    <dwc:scientificName>Arales</dwc:scientificName>
    <offsets>
      <offset start="2823" end="2828"/>
    </offsets>
  </name>
  <name>
    <verbatim>Poales</verbatim>
    <dwc:scientificName>Poales</dwc:scientificName>
    <offsets>
      <offset start="3058" end="3063"/>
    </offsets>
  </name>
</names>
Something went wrong with that request. Please try again.