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

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