PBDB Data Service 1.2 v2 > Taxonomic names > Single taxon

DESCRIPTION

This operation returns information about a single taxonomic name, specified either by name or by identifier.

Follow this link for more information on the use of taxonomic names in this data service.

USAGE

Here are some usage examples:

PARAMETERS

You must specify one of the following parameters for this operation:

taxon_name

Return information about the taxonomic name matching the specified string. You may also use the alias name for this parameter. If more than one name matches, the one with the largest number of occurrences in the database will be returned. The characters . % _ may be used as wildcards. If no taxonomic name matches the value of this parameter, you will get an HTTP 404 (Not Found) response.

taxon_id

Return information about the taxonomic name corresponding to the specified identifier. You may also use the alias id for this parameter. If the value is syntactically correct but does not correspond to any taxonomic name in the database, you will get an HTTP 404 (Not Found) response. The value can have any of the following forms:

txn:285777

Return the currently accepted variant of the taxonomic name identified by 285777. This may be taxonomic name 285777, or it may be a different name that has been grouped with it such as a recombination or corrected spelling.

var:285777

Return the exact name variant identified by 285777.

285777

Return the currently accepted variant. Purely numeric identifiers are deprecated, and will not be accepted by the next version of the data service.

285777&exact

If the paramter exact is also given, return the exact variant.

You may not specify both taxon_name and taxon_id in the same query.

You may also specify any of the following parameters:

exact

As indicated above, if you provide a purely numeric value for the taxon_id parameter, you can also include this parameter to specify that the exact matching taxonomic name variant should be returned. Identifiers of the form var:nnn or txn:nnn are not affected by this parameter. This parameter is deprecated, and will be removed in the next version of the data service.

common

This parameter indicates that name lookup should be done on common names instead of (or in addition to) scientific names. The value should be one or more two-character language codes as a comma-separated list, indicating which language(s) to match. For example:

The following parameter indicates which information should be returned about the selected name:

show

This parameter is used to select additional blocks of information to be returned along with the basic record for each taxon. Its value should be one or more of the following, separated by commas:

full

This is a shortcut for including all of the information that defines this record. Currently, this includes the following blocks: attr, app, common, parent size, class, ecospace, otaph, etbasis, refattr. If we subsequently add new data fields to this record then full will include those as well. So if you are publishing a URL, it might be a good idea to include show=full.

attr

The attribution of this taxonomic name (author and year)

app

The age of first and last appearance of this taxon from all of the occurrences recorded in this database

common

The common name of this taxon, if one is entered in the database.

parent

If the classification of this taxon has been entered into the database, the name of the parent taxon, or its senior synonym if there is one.

immparent

You can use this instead of parent if you wish to know the immediate parent taxon. If the immediate parent is a junior synonym, both it and its senior synonym will be displayed.

acconly

Only return accepted names, and suppress the fields difference, accepted_name, accepted_rank, and accepted_no, because they are only relevant for non-accepted names.

size

The number of subtaxa appearing in this database, including the taxon itself.

class

The classification of this taxon: phylum, class, order, family, genus. Also includes the type taxon, if one is entered in the database. This information is also included in the nav block, so do not specify both at once.

classext

Like class, but also includes the relevant taxon identifiers.

subcounts

The number of subtaxa known to this database, summarized by rank.

ecospace

Information about ecological space that this organism occupies or occupied. This has only been filled in for a relatively few taxa. Here is a list of values.

ttaph

Information about the taphonomy of this organism. You can also use the alias taphonomy. Here is a list of values.

etbasis

Annotates the output block ecospace, indicating at which taxonomic level each piece of information was entered.

nav

Additional information for the PBDB Navigator taxon browser. This block should only be selected if the output format is json.

seq

The sequence numbers that mark this taxon's position in the tree.

img

The identifier of the image (if any) associated with this taxon. These images are sourced from phylopic.org.

ref

The reference from which this taxonomic name was entered, as formatted text.

refattr

The author(s) and year of publication of the reference. Note that this may be different from the attribution of the name itself, if the reference is a secondary source.

ent

The identifiers of the people who authorized, entered and modified this record

entname

The names of the people who authorized, entered and modified this record

crmod

The created and modified timestamps for the collection record

You can also use any of the special parameters with this request.

METHODS

This data service accepts the following HTTP methods: GET, HEAD

RESPONSE

The response to an HTTP request with this operation will consist of fields from the following list. The block basic is always present. The others may be selected using the parameter show.

Field nameBlockDescription
pbdbcom
orig_no oid basic

A unique identifier for this taxonomic name

taxon_no vid basic

A unique identifier for the selected variant of this taxonomic name. By default, this is the variant currently accepted as most correct.

record_type typ basic

The type of this object: txn for a taxon.

flags flg basic

This field will be empty for most records. Otherwise, it will contain one or more of the following letters:

B

This taxon is one of the ones specified explicitly in the query. If the result is a subtree, this represents the 'base'.

E

This taxon was specified in the query as an exclusion.

V

This taxonomic name is a variant that is not currently accepted.

I

This taxon is an ichnotaxon.

F

This taxon is a form taxon.

taxon_rank rnk basic

The rank of this taxon, ranging from subspecies up to kingdom

taxon_name nam basic

The scientific name of this taxon

taxon_attr att attr

The attribution (author and year) of this taxonomic name

common_name nm2 common, full

The common (vernacular) name of this taxon, if any

difference tdf basic

If this name is either a junior synonym or is invalid for some reason, this field gives the reason. The fields accepted_no and accepted_name then specify the name that should be used instead.

tax_status n/a basic

The taxonomic status of this name, in the Darwin Core vocabulary. This field only appears if that vocabulary is selected.

nom_status n/a basic

The nomenclatural status of this name, in the Darwin Core vocabulary. This field only appears if that vocabulary is selected.

accepted_no acc basic

If this name is either a junior synonym or an invalid name, this field gives the identifier of the accepted name to be used in its place. Otherwise, its value will be the same as orig_no. In the compact vocabulary, this field will be omitted in that case.

accepted_rank acr basic

If accepted_no is different from orig_no, this field gives the rank of the accepted name. Otherwise, its value will be the same as taxon_rank. In the compact voabulary, this field will be omitted in that case.

accepted_name acn basic

If accepted_no is different from orig_no, this field gives the accepted name. Otherwise, its value will be the same as taxon_name. In the compact vocabulary, this field will be omitted in that case.

parent_no par basic

The identifier of the parent taxon, or of its senior synonym if there is one. This field and those following are only available if the classification of this taxon is known to the database.

parent_name prl parent, immparent

The name of the parent taxon, or of its senior synonym if there is one.

immpar_no ipn immparent

The identifier of the immediate parent taxon, even if it is a junior synonym.

immpar_name ipl immparent

The name of the immediate parent taxon, even if it is a junior synonym.

container_no ctn basic

The identifier of a taxon from the result set containing this one, which may or may not be the parent. This field will only appear in the result of the occs/taxa operation, where no base taxon is specified. The taxa reported in this case are the "classical" ranks, rather than the full taxonomic hierarcy.

ref_author aut refattr, refattr

The author(s) of the reference from which this name was entered. Note that the author of the name itself may be different if the reference is a secondary source.

ref_pubyr pby refattr, refattr

The year of publication of the reference from which this name was entered. Note that the publication year of the name itself may be different if the reference is a secondary source.

reference_no rid basic

The identifier of the reference from which this name was entered.

is_extant ext basic

True if this taxon is extant on earth today, false if not, not present if unrecorded

n_occs noc basic

The number of fossil occurrences in this database that are identified as belonging to this taxon or any of its subtaxa.

firstapp_max_ma fea app

The early age bound for the first appearance of this taxon in the database

firstapp_min_ma fla app

The late age bound for the first appearance of this taxon in the database

lastapp_max_ma lea app

The early age bound for the last appearance of this taxon in the database

lastapp_min_ma lla app

The late age bound for the last appearance of this taxon in the database

early_interval tei app

The name of the interval in which this taxon first appears, or the start of its range.

late_interval tli app

The name of the interval in which this taxon last appears, if different from early_interval.

taxon_size siz size

The total number of taxa in the database that are contained within this taxon, including itself

extant_size exs size

The total number of extant taxa in the database that are contained within this taxon, including itself

phylum phl class

The name of the phylum in which this taxon is classified

phylum_no phn classext

The identifier of the phylum in which this taxon is classified. This is only included with the block classext.

class cll class

The name of the class in which this taxon is classified

class_no cln classext

The identifier of the class in which this taxon is classified. This is only included with the block classext.

order odl class

The name of the order in which this taxon is classified

order_no odn classext

The identifier of the order in which this occurrence is classified. This is only included with the block classext.

family fml class

The name of the family in which this taxon is classified

family_no fmn classext

The identifier of the family in which this occurrence is classified. This is only included with the block classext.

genus gnl class

The name of the genus in which this taxon is classified. A genus may be listed as occurring in a different genus if it is a junior synonym; a species may be listed as occurring in a different genus than its name would indicate if its genus is synonymized but no synonymy opinion has been entered for the species.

genus_no gnn classext

The identifier of the genus in which this occurrence is classified. This is only included with the block classext.

subgenus_no sgn classext

The identifier of the subgenus in which this occurrence is classified, if any. This is only included with the block classext.

type_taxon ttl class

The name of the type taxon for this taxon, if known.

type_taxon_no ttn classext

The identifier of the type taxon for this taxon, if known.

n_orders odc subcounts

The number of orders within this taxon. For lists of taxa derived from a set of occurrences, this will be the number of orders that appear within that set. Otherwise, this will be the total number of orders within this taxon that are known to the database.

n_families fmc subcounts

The number of families within this taxon, according to the same rules as n_orders above.

n_genera gnc subcounts

The number of genera within this taxon, according to the same rules as n_orders above.

n_species spc subcounts

The number of species within this taxon, according to the same rules as n_orders above.

taxon_environment jev ecospace

The general environment or environments in which this life form is found. See ecotaph vocabulary.

environment_basis jec ecospace

Specifies the taxon from which the environment information is inherited.

motility jmo ecospace

Whether the organism is motile, attached and/or epibiont, and its mode of locomotion if any. See ecotaph vocabulary.

motility_basis jmc etbasis

Specifies the taxon for which the motility information was set. The taphonomy and ecospace information are inherited from parent taxa unless specific values are set.

life_habit jlh ecospace

The general life mode and locality of this organism. See ecotaph vocabulary.

life_habit_basis jhc etbasis

Specifies the taxon for which the life habit information was set. See motility_basis above. These fields are only included if the ecospace block is also included.

vision jvs ecospace

The degree of vision possessed by this organism. See ecotaph vocabulary.

vision_basis jvc etbasis

Specifies the taxon for which the vision information was set. See motility_basis above. These fields are only included if the ecospace block is also included.

diet jdt ecospace

The general diet or feeding mode of this organism. See ecotaph vocabulary.

diet_basis jdc etbasis

Specifies the taxon for which the diet information was set. See motility_basis above. These fields are only included if the ecospace block is also included.

reproduction jre ecospace

The mode of reproduction of this organism. See ecotaph vocabulary.

reproduction_basis jrc etbasis

Specifies the taxon for which the reproduction information was set. See motility_basis above. These fields are only included if the ecospace block is also included.

ontogeny jon ecospace

Briefly describes the ontogeny of this organism. See ecotaph vocabulary.

ontogeny_basis joc etbasis

Specifies the taxon for which the ontogeny information was set. See motility_basis above. These fields are only included if the ecospace block is also included.

ecospace_comments jcm ecospace

Additional remarks about the ecospace, if any.

composition jco ttaph

The composition of the skeletal parts of this organism. See taphonomy vocabulary.

architecture jsa ttaph

An indication of the internal skeletal architecture. See taphonomy vocabulary.

thickness jth ttaph

An indication of the relative thickness of the skeleton. See taphonomy vocabulary.

reinforcement jsr ttaph

An indication of the skeletal reinforcement, if any. See taphonomy vocabulary.

taphonomy_basis jtc etbasis

Specifies the taxon for which the taphonomy information was set. See motility_basis above. These fields are only included if the otaph block is also included.

senpar_name prl nav

The name of the parent taxon or its senior synonym if any

senpar_rank prr nav

The rank of the parent taxon or its senior synonym if any

immpar_name ipl nav

The name of the immediate parent taxon if it is a junior synonym

parent_txn prt nav
kingdom_no kgn nav

The identifier of the kingdom in which this taxon occurs

kingdom kgl nav

The name of the kingdom in which this taxon occurs

kingdom_txn kgt nav
phylum_no phn nav

The identifier of the phylum in which this taxon occurs

phylum phl nav

The name of the phylum in which this taxon occurs

phylum_txn pht nav
phylum_count phc nav

The number of phyla within this taxon

class_no cln nav

The identifier of the class in which this taxon occurs

class cll nav

The name of the class in which this taxon occurs

class_txn clt nav
class_count clc nav

The number of classes within this taxon

order_no odn nav

The identifier of the order in which this taxon occurs

order odl nav

The name of the order in which this taxon occurs

order_txn odt nav
order_count odc nav

The number of orders within this taxon

family_no fmn nav

The identifier of the family in which this taxon occurs

family fml nav

The name of the family in which this taxon occurs

family_txn fmt nav
family_count fmc nav

The number of families within this taxon

genus_count gnc nav

The number of genera within this taxon

children chl nav

The immediate children of this taxonomic concept, if any

phylum_list phs nav

A list of the phyla within this taxonomic concept

class_list cls nav

A list of the classes within this taxonomic concept

order_list ods nav

A list of the orders within this taxonomic concept

family_list fms nav

A list of the families within this taxonomic concept

genus_list gns nav

A list of the genera within this taxonomic concept

subgenus_list sgs nav

A list of the subgenera within this taxonomic concept

species_list sps nav

A list of the species within this taxonomic concept

subspecies_list sss nav

A list of the subspecies within this taxonomic concept

lft lsq seq

This number gives the taxon's position in a preorder traversal of the taxonomic tree.

rgt rsq seq

This number greater than or equal to the maximum of the sequence numbers of all of this taxon's subtaxa, and less than the sequence of any succeeding taxon in the sequence. You can use this, along with lft, to determine subtaxon relationships. If the pair lft,rgt for taxon <A> is bracketed by the pair lft,rgt for taxon <B>, then A is a subtaxon of B.

image_no img img

If this value is non-zero, you can use it to construct image URLs using taxa/thumb and taxa/icon.

primary_reference ref ref

The primary reference associated with this record (as formatted text)

authorizer_no ati ent, entname

The identifier of the person who authorized the entry of this record

enterer_no eni ent, entname

The identifier of the person who actually entered this record.

modifier_no mdi ent, entname

The identifier of the person who last modified this record, if it has been modified.

authorizer ath entname

The name of the person who authorized the entry of this record

enterer ent entname

The name of the person who actually entered this record

modifier mdf entname

The name of the person who last modified this record, if it has been modified.

created dcr crmod

The date and time at which this record was created.

modified dmd crmod

The date and time at which this record was last modified.

FORMATS

The following response formats are available for this operation. You must select the desired format for a request by adding the appropriate suffix to the URI path.

FormatSuffixDocumentation
JSON .json

JSON format

Comma-separated text .txt

Text formats

Comma-separated text .csv

Text formats

Tab-separated text .tsv

Text formats

VOCABULARIES

The following response vocabularies are available for this operation. If you wish your responses to be expressed in a vocabulary other than the default for your selected format, you can use the vocab parameter with the appropriate vocabulary name.

VocabularyNameDefault forDescription
PaleobioDB field names pbdb txt, csv, tsv

The PBDB vocabulary is derived from the underlying field names and values in the database, augmented by a few new fields. For the most part any response that uses this vocabulary will be directly comparable to downloads from the PBDB Classic interface. This vocabulary is the default for text format responses.

Compact field names com json

The Compact vocabulary is a set of 3-character field names designed to minimize the size of the response message. This is the default for JSON format responses. Some of the field values are similarly abbreviated, while others are conveyed in their entirety. For details, see the documentation for the individual response fields.

 

This service is provided by the Paleobiology Database, hosted by the Department of Geoscience at the University of Wisconsin-Madison.

If you have questions about this data service, or wish to report a bug, please contact the database administrator at admin@paleobiodb.org