Difference between revisions of "OJ Break v2 Taxon Reference"

Revision as of 19:53, 20 April 2015

Introduction

OJ_Break is the name of the xBio:D RESTful API service to facilitate discovery of data within the xBio:D database. The API can respond with JavaScript Object Notation (JSON), XML, or JSON with padding (JSONP) and accepts HTTP GET and POST requests indiscriminately. The backend of the API is written in Oracle's PL/SQL database language, which is fast but often inflexible, while a Python presentation layer mitigates request handling and authentication.

OJ_Break Version 2 is a new and improved edition of the work started in Version 1. Version 2 introduces a completely restructured and standardized data model to further enhance the functionality of the xBio:D database.

API Information and Access

This page specifies the methods and data defined by OJ_Break Version 2, more precisely those that are defined by the Taxon data domain. To get information on any of the other data domains defined in OJ_Break Version 2, visit the See also section.

Using the OJ_Break Version 2 API requires calling methods with corresponding, method specific parameters (found on this page) and a few other required parameters. These required parameters include specifying a return format, an API access key, and a version number.

   Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInfo?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

Notice the specification of the version parameter at the end of the example method call. With the introduction of OJ_Break Version 2, the version parameter has a default value of 2 making the specification in the example unnecessary. To read more about using the OJ_Break Version 2 API, go to OJ_Break API Access.

Procedural Reference

Taxon

getTaxonInfo

Description

Parameters

tnuid: tnuid
*inst_id: inst_id
format: String
key: String
version: Number

Return

TaxonComplete

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInfo?tnuid=30148&inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonHierarchy

Description

Parameters

tnuid: tnuid
format: String
key: String
version: Number

Return

TaxonRelationship

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonHierarchy?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonIncludedTaxa

Description

Parameters

tnuid: tnuid
*inst_id: inst_id
*rank: rank
*offset: Number
*limit: Number
*show_syns: Boolean_flag
*show_fossils: Boolean_flag
*types_only: Boolean_flag
format: String
key: String
version: Number

Return

TaxonReturnIncluded

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonIncludedTaxa?tnuid=30148&inst_id=1&show_syns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonSynonyms

Description

Parameters

tnuid: tnuid
*offset: Number
*limit: Number
*show_fossils: Boolean_flag
format: String
key: String
version: Number

Return

TaxonReturnSynonyms

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonSynonyms?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonAssociations

Description

Parameters

tnuid: tnuid
*offset: Number
*limit: Number
*basic_only: Boolean_flag
format: String
key: String
version: Number

Return

TaxonReturnAssociations

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonAssociations?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonLiteratureCitations

Description

Parameters

tnuid: tnuid
*offset: Number
*limit: Number
*show_children: Boolean_flag
format: String
key: String
version: Number

Return

TaxonReturnLiteratureCitations

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLiteratureCitations?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonOccurrences

Description

Parameters

tnuid: tnuid
*inst_id: inst_id
*place_id: place_id
*offset: Number
*limit: Number
*show_children: Boolean_flag
*basic_only: Boolean_flag
format: String
key: String
version: Number

Return

TaxonReturnOccurrences

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonOccurrences?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonTypes

Description

Parameters

tnuid: tnuid
*inst_id: inst_id
*offset: Number
*limit: Number
*basic_only: Boolean_flag
*show_children: Boolean_flag
*primary_only: Boolean_flag
format: String
key: String
version: Number

Return

TaxonReturnOccurrences

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonTypes?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonLocalities

Description

Parameters

tnuid: tnuid
*inst_id: inst_id
*place_id: place_id
*offset: Number
*limit: Number
*show_children: Boolean_flag
format: String
key: String
version: Number

Return

TaxonReturnLocalities

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLocalities?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonDeterminers

Description

Parameters

tnuid: tnuid
*inst_id: inst_id
*offset: Number
*limit: Number
format: String
key: String
version: Number

Return

TaxonReturnDeterminers

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonDeterminers?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonInstitutions

Description

Parameters

tnuid: tnuid
*offset: Number
*limit: Number
format: String
key: String
version: Number

Return

TaxonReturnInstitutions

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInstitutions?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonHabitats

Description

Parameters

tnuid: tnuid
*offset: Number
*limit: Number
format: String
key: String
version: Number

Return

TaxonReturnHabitats

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonHabitats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonMedia

Description

Parameters

tnuid: tnuid
*media_type: media_type
*inst_id: inst_id
*offset: Number
*limit: Number
format: String
key: String
version: Number

Return

TaxonReturnMedia

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonMedia?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

Taxon Data Type Glossary

Classes

TaxonAssociation

assoc_taxon: TaxonRelationship
assoc_type: assoc_type
assoc_type_full: assoc_type_full
assoc_occurrences: array of OccurrenceBasic

TaxonBasic

tnuid: tnuid
taxon: taxon
taxon_author: taxon_author

TaxonComplete (extends TaxonRelationship)

stats: TaxonInfoStats
contribs: array of Contribution
orig_desc: LiteratureExtended

TaxonExtended (extends TaxonBasic)

describer: describer
status: status
valid: valid
rank: rank
valid_taxon: TaxonBasic
fossil: fossil
homonym: homonym
common_names: array of common_name
source: TaxonSource

TaxonHierarchy

Aggregate of one or more of the following classes:

TaxonHierKingdom (1)
TaxonHierPhylum (0 or 1)
TaxonHierDivision (0 or 1)
TaxonHierSubphylum (0 or 1)
TaxonHierClass (0 or 1)
TaxonHierSubclass (0 or 1)
TaxonHierInfraclass (0 or 1)
TaxonHierOrder (0 or 1)
TaxonHierSuborder (0 or 1)
TaxonHierInfraorder (0 or 1)
TaxonHierCohort (0 or 1)
TaxonHierSubcohort (0 or 1)
TaxonHierSuperfamily (0 or 1)
TaxonHierFamily (0 or 1)
TaxonHierSubfamily (0 or 1)
TaxonHierTribe (0 or 1)
TaxonHierSubtribe (0 or 1)
TaxonHierGenus (0 or 1)
TaxonHierSpecies (0 or 1)
TaxonHierSubspecies (0 or 1)

TaxonHierInfraclass

Infraclass: TaxonHierUnit

TaxonHierInfraorder

Infraorder: TaxonHierUnit

TaxonHierKingdom

Kingdom: TaxonHierUnit

TaxonHierOrder

Order: TaxonHierUnit

TaxonHierPhylum

Phylum: TaxonHierUnit

TaxonHierSpecies

Species: TaxonHierUnit

TaxonHierSubclass

Subclass: TaxonHierUnit

TaxonHierSubcohort

Subcohort: TaxonHierUnit

TaxonHierSubfamily

Subfamily: TaxonHierUnit

TaxonHierSuborder

Suborder: TaxonHierUnit

TaxonHierSubphylum

Subphylum: TaxonHierUnit

TaxonHierSubspecies

Subspecies: TaxonHierUnit

TaxonHierSubtribe

Subtribe: TaxonHierUnit

TaxonHierSuperfamily

Superfamily: TaxonHierUnit

TaxonHierTribe

Tribe: TaxonHierUnit

TaxonHierUnit (extends TaxonBasic)

next: rank

TaxonInfoStats (extends TaxonStats)

child_stats: array of TaxonStats
num_records: Number
num_spms: Number

TaxonRelationship (extends TaxonExtended)

rel_type: rel_type
parent_taxon: TaxonBasic
hier: TaxonHierarchy

TaxonReturn

general: TaxonBasic

TaxonReturnAssociations (extends TaxonReturn)

associations: array of TaxonAssociation

TaxonReturnDeterminers (extends TaxonReturn)

determiners: array of AgentExtended

TaxonReturnHabitats (extends TaxonReturn)

hatitats: array of habitat

TaxonReturnIncluded (extends TaxonReturn)

includedTaxa: array of AgentExtended

TaxonReturnInstitutions (extends TaxonReturn)

institutions: array of InstitutionBasic

TaxonReturnLiteratureCitations (extends TaxonReturn)

pub_citations: array of LiteratureTaxonCitationExtended

TaxonReturnLocalities (extends TaxonReturn)

localities: array of LocalityExtended

TaxonReturnMedia (extends TaxonReturn)

media: array of MediaExtended

TaxonReturnOccurrences (extends TaxonReturn)

occurrences: array of OccurrenceExtended

TaxonReturnSynonyms (extends TaxonReturn)

synonyms: array of TaxonRelationship

TaxonSource

id: Number
name: String
logo: URL
url: URL
query: URL

TaxonStats

rank: rank
rank_value: rank_value
num_taxa: Number

Elements

assoc_type

String - A description of the biological relationship between a specified taxon and another organism.

assoc_type_full

String - A complete description of the biological relationship between a specified taxon and another organism.

common_name

String - A common name for a taxon that can be included as a taxon name string but is never valid.

describer

String - the describer(s) of a taxon.

fossil

String - A modified boolean_flag, either Y, N or B, representing whether a taxon name is a extinct fossil, exclusively extant, or present today and in fossils.

habitat

String - Description or identifier of the ecological or environmental area that a particular species is known to inhabit.

homonym

Boolean_flag - Boolean_flag indicating whether or not the determination was a homonym

rank

String - The taxonomic (hierarchical) rank of a taxon name.

rank_value

Number - A number representing the rank of a taxon with higher numbers representing higher positions in the taxonomic hierarchy.

rel_type

String - The taxonomic (hierarchical) relationship between the taxonomic concept indicated by the taxon name and its parent taxonomic concept. Can be Member, Junior synonym, etc.

status

String - The nomenclatural status of a taxon name using a formalized vocabulary.

taxon

String - A taxon name string.

taxon_author

String - The author(s) of a taxon with parenthesis surrounding the name of the author(s) if necessary.

tnuid

Number - The taxon name use identifier which uniquely identifies a taxon.

valid

String - A Valid or Invalid string representing the validity of a taxon name using subjective interpretations if warranted.

@@ Line 25: / Line 25: @@
 * ''version'': Number
 ===== Return =====
-* [[#TaxonComplete_.28extends_TaxonRelationship.29|TaxonComplete]]
+* [[#TaxonComplete (extends TaxonRelationship)|TaxonComplete]]
 ===== Example =====
@@ Line 38: / Line 38: @@
 * ''version'': Number
 ===== Return =====
-* [[#TaxonRelationship_.28extends_TaxonExtended.29|TaxonRelationship]]
+* [[#TaxonRelationship (extends TaxonExtended)|TaxonRelationship]]
 ===== Example =====
@@ Line 58: / Line 58: @@
 * ''version'': Number
 ===== Return =====
-* [[#TaxonReturnIncluded_.28extends_TaxonReturn.29|TaxonReturnIncluded]]
+* [[#TaxonReturnIncluded (extends TaxonReturn)|TaxonReturnIncluded]]
 ===== Example =====
@@ Line 74: / Line 74: @@
 * ''version'': Number
 ===== Return =====
-* [[#TaxonReturnSynonyms_.28extends_TaxonReturn.29|TaxonReturnSynonyms]]
+* [[#TaxonReturnSynonyms (extends TaxonReturn)|TaxonReturnSynonyms]]
 ===== Example =====
@@ Line 91: / Line 91: @@
 ===== Return =====
-* [[#TaxonReturnAssociations_.28extends_TaxonReturn.29|TaxonReturnAssociations]]
+* [[#TaxonReturnAssociations (extends TaxonReturn)|TaxonReturnAssociations]]
 ===== Example =====
@@ Line 107: / Line 107: @@
 * ''version'': Number
 ===== Return =====
-* [[#TaxonReturnLiteratureCitations_.28extends_TaxonReturn.29|TaxonReturnLiteratureCitations]]
+* [[#TaxonReturnLiteratureCitations (extends TaxonReturn)|TaxonReturnLiteratureCitations]]
 ===== Example =====
@@ Line 126: / Line 126: @@
 * ''version'': Number
 ===== Return =====
-* [[#TaxonReturnOccurrences_.28extends_TaxonReturn.29|TaxonReturnOccurrences]]
+* [[#TaxonReturnOccurrences (extends TaxonReturn)|TaxonReturnOccurrences]]
 ===== Example =====
@@ Line 145: / Line 145: @@
 * ''version'': Number
 ===== Return =====
-* [[#TaxonReturnOccurrences_.28extends_TaxonReturn.29|TaxonReturnOccurrences]]
+* [[#TaxonReturnOccurrences (extends TaxonReturn)|TaxonReturnOccurrences]]
 ===== Example =====
@@ Line 163: / Line 163: @@
 * ''version'': Number
 ===== Return =====
-* [[#TaxonReturnLocalities_.28extends_TaxonReturn.29|TaxonReturnLocalities]]
+* [[#TaxonReturnLocalities (extends TaxonReturn)|TaxonReturnLocalities]]
 ===== Example =====
@@ Line 179: / Line 179: @@
 * ''version'': Number
 ===== Return =====
-* [[#TaxonReturnDeterminers_.28extends_TaxonReturn.29|TaxonReturnDeterminers]]
+* [[#TaxonReturnDeterminers (extends TaxonReturn)|TaxonReturnDeterminers]]
 ===== Example =====
@@ Line 194: / Line 194: @@
 * ''version'': Number
 ===== Return =====
-* [[#TaxonReturnInstitutions_.28extends_TaxonReturn.29|TaxonReturnInstitutions]]
+* [[#TaxonReturnInstitutions (extends TaxonReturn)|TaxonReturnInstitutions]]
 ===== Example =====
@@ Line 209: / Line 209: @@
 * ''version'': Number
 ===== Return =====
-* [[#TaxonReturnHabitats_.28extends_TaxonReturn.29|TaxonReturnHabitats]]
+* [[#TaxonReturnHabitats (extends TaxonReturn)|TaxonReturnHabitats]]
 ===== Example =====
@@ Line 226: / Line 226: @@
 * ''version'': Number
 ===== Return =====
-* [[#TaxonReturnMedia_.28extends_TaxonReturn.29|TaxonReturnMedia]]
+* [[#TaxonReturnMedia (extends TaxonReturn)|TaxonReturnMedia]]
 ===== Example =====
@@ Line 234: / Line 234: @@
 === Classes ===
 ==== TaxonAssociation ====
-* ''assoc_taxon'': [[#TaxonRelationship_.28extends_TaxonExtended.29|TaxonRelationship]]
+* ''assoc_taxon'': [[#TaxonRelationship (extends TaxonExtended)|TaxonRelationship]]
 * ''assoc_type'': ''[[#assoc_type|assoc_type]]''
 * ''assoc_type_full'': ''[[#assoc_type_full|assoc_type_full]]''
@@ Line 244: / Line 244: @@
 * ''taxon_author'': ''[[#taxon_author|taxon_author]]''
-==== TaxonComplete (extends [[#TaxonRelationship_.28extends_TaxonExtended.29|TaxonRelationship]]) ====
+==== TaxonComplete (extends [[#TaxonRelationship (extends TaxonExtended)|TaxonRelationship]]) ====
-* ''stats'': [[#TaxonInfoStats_.28extends_TaxonStats.29|TaxonInfoStats]]
+* ''stats'': [[#TaxonInfoStats (extends TaxonStats)|TaxonInfoStats]]
 * ''contribs'': array of Contribution
 * ''orig_desc'': [[OJ_Break v2 Literature Reference#LiteratureExtended|LiteratureExtended]]
@@ Line 284: / Line 284: @@
 ==== TaxonHierClass ====
-* ''Class'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Class'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierCohort ====
-* ''Cohort'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Cohort'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierDivision ====
-* ''Division'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Division'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierFamily ====
-* ''Family'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Family'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierGenus ====
-* ''Genus'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Genus'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierInfraclass ====
-* ''Infraclass'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Infraclass'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierInfraorder ====
-* ''Infraorder'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Infraorder'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierKingdom ====
-* ''Kingdom'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Kingdom'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierOrder ====
-* ''Order'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Order'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierPhylum ====
-* ''Phylum'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Phylum'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierSpecies ====
-* ''Species'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Species'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierSubclass ====
-* ''Subclass'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Subclass'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierSubcohort ====
-* ''Subcohort'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Subcohort'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierSubfamily ====
-* ''Subfamily'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Subfamily'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierSuborder ====
-* ''Suborder'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Suborder'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierSubphylum ====
-* ''Subphylum'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Subphylum'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierSubspecies ====
-* ''Subspecies'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Subspecies'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierSubtribe ====
-* ''Subtribe'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Subtribe'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierSuperfamily ====
-* ''Superfamily'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Superfamily'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierTribe ====
-* ''Tribe'': [[#TaxonHierUnit_.28extends_TaxonBasic.29|TaxonHierUnit]]
+* ''Tribe'': [[#TaxonHierUnit (extends TaxonBasic)|TaxonHierUnit]]
 ==== TaxonHierUnit (extends [[#TaxonBasic|TaxonBasic]]) ====
@@ Line 351: / Line 351: @@
 * ''num_spms'': Number
-==== TaxonRelationship (extends [[#TaxonExtended_.28extends_TaxonBasic.29|TaxonExtended]]) ====
+==== TaxonRelationship (extends [[#TaxonExtended (extends TaxonBasic)|TaxonExtended]]) ====
 * ''rel_type'': ''[[#rel_type|rel_type]]''
 * ''parent_taxon'': [[#TaxonBasic|TaxonBasic]]
@@ Line 363: / Line 363: @@
 ==== TaxonReturnDeterminers (extends [[#TaxonReturn|TaxonReturn]]) ====
-* ''determiners'': array of [[#TaxonExtended_.28extends_TaxonBasic.29|AgentExtended]]
+* ''determiners'': array of [[#TaxonExtended (extends TaxonBasic)|AgentExtended]]
 ==== TaxonReturnHabitats (extends [[#TaxonReturn|TaxonReturn]]) ====
@@ Line 369: / Line 369: @@
 ==== TaxonReturnIncluded (extends [[#TaxonReturn|TaxonReturn]]) ====
-* ''includedTaxa'': array of [[#TaxonExtended_.28extends_TaxonBasic.29|AgentExtended]]
+* ''includedTaxa'': array of [[#TaxonExtended (extends TaxonBasic)|AgentExtended]]
 ==== TaxonReturnInstitutions (extends [[#TaxonReturn|TaxonReturn]]) ====
@@ Line 381: / Line 381: @@
 ==== TaxonReturnMedia (extends [[#TaxonReturn|TaxonReturn]]) ====
-* ''media'': array of [[OJ_Break v2 Media Reference#MediaExtended_.28extends_MediaBasic.29|MediaExtended]]
+* ''media'': array of [[OJ_Break v2 Media Reference#MediaExtended (extends MediaBasic)|MediaExtended]]
 ==== TaxonReturnOccurrences (extends [[#TaxonReturn|TaxonReturn]]) ====
@@ Line 387: / Line 387: @@
 ==== TaxonReturnSynonyms (extends [[#TaxonReturn|TaxonReturn]]) ====
-* ''synonyms'': array of [[#TaxonRelationship_.28extends_TaxonExtended.29|TaxonRelationship]]
+* ''synonyms'': array of [[#TaxonRelationship (extends TaxonExtended)|TaxonRelationship]]
 ==== TaxonSource ====

Difference between revisions of "OJ Break v2 Taxon Reference"

Revision as of 19:53, 20 April 2015

Contents

API Information and Access

Procedural Reference

Taxon

getTaxonInfo

Description

Parameters

Return

Example

getTaxonHierarchy

Description

Parameters

Return

Example

getTaxonIncludedTaxa

Description

Parameters

Return

Example

getTaxonSynonyms

Description

Parameters

Return

Example

getTaxonAssociations

Description

Parameters

Return

Example

getTaxonLiteratureCitations

Description

Parameters

Return

Example

getTaxonOccurrences

Description

Parameters

Return

Example

getTaxonTypes

Description

Parameters

Return

Example

getTaxonLocalities

Description

Parameters

Return

Example

getTaxonDeterminers

Description

Parameters

Return

Example

getTaxonInstitutions

Description

Parameters

Return

Example

getTaxonHabitats

Description

Parameters

Return

Example

getTaxonMedia

Description

Parameters

Return

Example

Taxon Data Type Glossary

Classes

TaxonAssociation

TaxonBasic

TaxonComplete (extends TaxonRelationship)

TaxonExtended (extends TaxonBasic)

TaxonHierarchy

TaxonHierClass

TaxonHierCohort