OJ Break v2 Taxon Reference

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

Parameters

• tnuid: tnuid
• inst_id: inst_id (optional)
• 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

Parameters

• tnuid: tnuid
• format: string
• key: string
• version: number

Return

• TaxonReturnHierarchy

Example

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

getTaxonIncludedTaxa

Parameters

• tnuid: tnuid
• offset: number (optional)
• limit: number (optional)
• inst_id: inst_id (optional)
• show_syns: Boolean_flag (optional)
• show_fossils: Boolean_flag (optional)
• types_only: Boolean_flag (optional)
• show_num_spms: Boolean_flag (optional)
• 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

Parameters

• tnuid: tnuid
• offset: number (optional)
• limit: number (optional)
• show_fossils: Boolean_flag (optional)
• 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

Parameters

• tnuid: tnuid
• offset: number (optional)
• limit: number (optional)
• rank_grouping: rank (optional)
• 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

Parameters

• tnuid: tnuid
• offset: number (optional)
• limit: number (optional)
• show_syns: Boolean_flag (optional)
• 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

Parameters

• tnuid: tnuid
• offset: number (optional)
• limit: number (optional)
• show_children: Boolean_flag (optional)
• inst_id: inst_id (optional)
• place_id: place_id (optional)
• 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

Parameters

• tnuid: tnuid
• offset: number (optional)
• limit: number (optional)
• inst_id: inst_id (optional)
• taxon_author_search: string (optional)
• show_syns: Boolean_flag (optional)
• primary_only: Boolean_flag (optional)
• limit: number (optional)
• offset: number (optional)
• 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

Parameters

• tnuid: tnuid
• offset: number (optional)
• limit: number (optional)
• show_children: Boolean_flag (optional)
• inst_id: inst_id (optional)
• place_ids: array of place_id (optional)
• 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

Parameters

• tnuid: tnuid
• offset: number (optional)
• limit: number (optional)
• inst_id: inst_id (optional)
• 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

Parameters

• tnuid: tnuid
• offset: number (optional)
• limit: number (optional)
• 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

Parameters

• tnuid: tnuid
• offset: number (optional)
• limit: number (optional)
• 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

Parameters

• tnuid: tnuid
• offset: number (optional)
• limit: number (optional)
• media_type: media_type (optional)
• inst_id: inst_id (optional)
• 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 class
• assoc_type: assoc_type element
• assoc_type_full: assoc_type_full element
• assoc_occurrences: array of OccurrenceBasic class

TaxonBasic

• tnuid: tnuid element
• taxon: taxon element
• taxon_author: taxon_author element

TaxonComplete (extends TaxonRelationship)

• stats: TaxonInfoStats class
• contribs: array of Contribution class
• orig_desc: LiteratureExtended class

TaxonExtended (extends TaxonBasic)

• describer: describer element
• status: status element
• valid: valid element
• rank: rank element
• valid_taxon: TaxonBasic class
• fossil: fossil element
• homonym: homonym element
• common_names': array of common_name element
• source: TaxonSource class

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)

TaxonHierClass

• Class: TaxonHierUnit class

TaxonHierCohort

• Cohort: TaxonHierUnit class

TaxonHierDivision

• Division: TaxonHierUnit class

TaxonHierFamily

• Family: TaxonHierUnit class

TaxonHierGenus

• Genus: TaxonHierUnit class

TaxonHierInfraclass

• Infraclass: TaxonHierUnit class

TaxonHierInfraorder

• Infraorder: TaxonHierUnit class

TaxonHierKingdom

• Kingdom: TaxonHierUnit class

TaxonHierOrder

• Order: TaxonHierUnit class

TaxonHierPhylum

• Phylum: TaxonHierUnit class

TaxonHierSpecies

• Species: TaxonHierUnit class

TaxonHierSubclass

• Subclass: TaxonHierUnit class

TaxonHierSubcohort

• Subcohort: TaxonHierUnit class

TaxonHierSubfamily

• Subfamily: TaxonHierUnit class

TaxonHierSuborder

• Suborder: TaxonHierUnit class

TaxonHierSubphylum

• Subphylum: TaxonHierUnit class

TaxonHierSubspecies

• Subspecies: TaxonHierUnit class

TaxonHierSubtribe

• Subtribe: TaxonHierUnit class

TaxonHierSuperfamily

• Superfamily: TaxonHierUnit class

TaxonHierTribe

• Tribe: TaxonHierUnit class

TaxonHierUnit (extends TaxonBasic)

• next: rank element

TaxonInfoStats (extends TaxonStats)

• child_stats: array of TaxonStats
• num_spms: Number

TaxonRelationship (extends TaxonExtended)

• rel_type: rel_type element
• parent_taxon: TaxonBasic class
• hier: TaxonHierarchy class

TaxonReturn

• general: TaxonBasic class

TaxonReturnAssociations (extends TaxonReturn)

• associations: array of TaxonAssociation class

TaxonReturnDeterminers (extends TaxonReturn)

• determiners: array of AgentExtended class

TaxonReturnHabitats (extends TaxonReturn)

• hatitats: array of habitat element

TaxonReturnIncluded (extends TaxonReturn)

• includedTaxa: array of AgentExtended class

TaxonReturnInstitutions (extends TaxonReturn)

• institutions: array of InstitutionBasic class

TaxonReturnLiteratureCitations (extends TaxonReturn)

• pub_citations: array of LiteratureTaxonCitationExtended class

TaxonReturnLocalities (extends TaxonReturn)

• localities: array of LocalityExtended class

TaxonReturnMedia (extends TaxonReturn)

• media: array of MediaExtended class

TaxonReturnOccurrences (extends TaxonReturn)

• occurrences: array of OccurrenceExtended class

TaxonReturnSynonyms (extends TaxonReturn)

• synonyms: array of TaxonRelationship class

TaxonSource

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

TaxonStats

• rank: rank element
• rank_value: rank_value element
• num_taxa: Number

See also

Visit any of the below links to find information about the other data domains defined by OJ_Break Version 2.

• Agent
• Geographic Place
• Institution
• Journal
• Literature
• Locality
• Occurrence
• Search