OJ Break API Reference

Introduction

OJ_Break is the name of the xBio:D RESTful(-like) API service to facilitate discovery of data within the xBio:D database. The API responds exclusively in JavaScript Object Notation (JSON) and accepts only HTTP GET and POST requests indiscriminately unlike a true REST API. Built using Oracle's PL/SQL database language, the API is fast but often inflexible and inconsistent, so take note of all of the comments below.

API Access

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

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

To read more about using the OJ_Break API, go to OJ_Break API Access.

Procedural Reference

Taxon

getTaxonStats

Description

Get some basic taxonomic statistics for a taxon from a tnuid.

Parameters

• tnuid: number
• callback: string

Return

• taxon: string
• author: string
• stats: taxon_stats

Example

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

getTaxonInfo

Description

Get some basic taxonomic information for a taxon from a tnuid.

Parameters

• tnuid: number
• inst_id: number
• callback: string

Return

• taxon_rel_extended class with below extensions
• valid_taxon: taxon_basic (only present when defined)
• parent_taxon: taxon_basic
• hier: taxon_hierarchy
• source: taxon_source
• common_names: array of common_name
• orig_desc: contrib_literature_basic (only present when defined)
• stats: taxon_info_stats
• contribs: array of contribution

Example

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

getTaxonHierarchy

Description

Get the taxonomic hierarachy in which a taxon is at the terminal node from a tnuid.

Parameters

• tnuid: number
• callback: string

Return

• taxon: string
• author: string
• hier: taxon_hierarchy

Example

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

getIncludedTaxa

Description

Get the taxa that are directly included within a taxon but not synonymous with it.

Parameters

• tnuid: number
• inst_id: number
• showSyns: string
• showFossils: string
• types_only: string
• show_num_spms: boolean_flag
• callback: string

Return

• tnuid: number
• parent_tnuid: number
• includedTaxa: array of taxon_extended

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getIncludedTaxa?tnuid=491&inst_id=0&showSyns=Y&showFossils=Y&types_only=N&show_num_spms=N&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxonSynonyms

Description

Get the taxa that are objective or subjectively synonymous with a taxon.

Parameters

• tnuid: number
• showFossils: string
• callback: string

Return

• synonyms: array of taxon_rel_extended

Example

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

getLocalities

Description

Get the localities from vouchered and unvouchered records for a taxon.

Parameters

• tnuid: number
• inst_id: number
• precDecimals: number
• showChildren: string
• callback: string

Return

• localities: array of loc_coords

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalities?tnuid=30148&inst_id=0&precDecimals=4&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getLocalities

Description

Get the localities within geopolitical divisions from vouchered and unvouchered records for a taxon.

Parameters

• tnuid: number
• pnids: array of pnid
• inst_id: number
• precDecimals: number
• showChildren: string
• callback: string

Return

• localities: array of loc_coords

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalities?tnuid=30148&pnids=5816,5735&inst_id=0&precDecimals=4&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getCuids

Description

Get the occurrence identifiers (collecting unit IDs) for a taxon.

Parameters

• tnuid: number
• showChildren: string
• inst_id: number
• pnids: array of pnid
• callback: string

Return

• cuids: array of cuid

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getCuids?tnuid=30148&showChildren=Y&inst_id=1&pnids=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getCuids

Description

Get the occurrence identifiers (collecting unit IDs) for selected taxa.

Parameters

• tnuids: array of tnuid
• pnids: array of pnid
• callback: string

Return

• cuids: array of cuid

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getCuids?tnuids=30148,491&pnids=5816,5735&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTypes

Parameters

• tnuid: number
• showSyns: string
• inst_id: number
• primary_only: string
• taxon_author_search: string
• offset: number
• limit: number
• callback: string

Return

• num_records: number
• types: array of taxon_basic and the below extensions
  • valid_taxon: taxon_basic
  • hier: taxon_hierarchy
  • cuid: string
  • inst_code: string
  • inst_id: string
  • type: string
  • orig_desc: pubs
  • images: media_basic

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTypes?tnuid=52&showSyns=F&inst_id=1&primary_only=Y&taxon_author_search=&offset=1&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getInsts

Parameters

• tnuid: number
• callback: string

Return

• collections: array of collection (not yet added)

Example

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

getTaxonLiterature (deprecated)

Description

Deprecated. Use getTaxonLit instead

Parameters

• tnuid: number
• showSyns: string
• callback: string

Return

• lit: pubs

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLiterature?tnuid=30148&showSyns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxonLit

Description

Preferred

Parameters

• tnuid: number
• showSyns: string
• callback: string

Return

• pubs: array of pubs

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLit?tnuid=30148&showSyns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getAssociations

Parameters

• tnuid: number
• rank_grouping: string
• callback: string

Return

• associations: array of taxon_basic (tnuid is not a number) with the below extensions
  • type: string
  • relationship: string
  • hier: taxon_hierarchy
  • cuids: array of cuids

Example

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

getHabitats

Parameters

• tnuid: number
• callback: string

Return

• habitats: array of media_basic with the below extensions
  • habitat: string

Example

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

getTaxonMedia

Parameters

• tnuid: number
• callback: string

Return

• media: array of media_basic

Example

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

getTaxonBreakdown

Parameters

• tnuid: number
• callback: string

Return

• taxa: array of taxon_extended (tnuid is not a number)
• sex: array of spm_sex

Example

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

getTaxonPhenology

Parameters

• tnuid: number
• callback: string

Return

• spms: array of the below elements
  • date: string
  • sort_date: string
  • cuid: string

Example

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

getTaxonNewTaxaByPub

Parameters

• tnuid: number
• validOnly: string
• callback: string

Return

• pubs: array of literature_basic with the below extension
  • taxa_num: string

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonNewTaxaByPub?tnuid=491&validOnly=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxonNewTaxaByYear

Parameters

• tnuid: number
• validOnly: string
• callback: string

Return

• years: array of the below elements
  • taxa_num: string
  • year: string

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonNewTaxaByYear?tnuid=52&validOnly=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxonStatsForYear

Parameters

• tnuid: number
• stats_year: number
• callback: string

Return

• stats: array of below elements
  • new_spm_num: number
  • all_spm_num: number
  • new_taxa_spm_num: array of number
  • all_taxa_spm_num: array of number
  • new_images_num: number
  • all_images_num: number
  • spm_years: array of string
  • images_years: array of string

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStatsForYear?tnuid=30148&stats_year=2014&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Occurrence / Specimen

getSpmInfo

Parameters

• cuid: string
• callback: string

Return

• spmInfo: array of ..

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getSpmInfo?cuid=OSUC+59557&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getSpmsInfo

Parameters

• cuids: array of string
• callback: string

Return

• spmsInfo: array of ..

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getSpmsInfo?cuids=OSUC+59557,OSUC+56308&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Locality

getLocalityInfo

Parameters

• loc_id: number
• tnuid: number
• inst_id: number
• per_id: number
• pnid: number
• showChildren: string
• completeSpmInfo: string
• callback: string

Return

• locInfo: array of loc_coords_extended

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityInfo?loc_id=1&tnuid=30148&inst_id=1&per_id=1&pnid=1&showChildren=Y&completeSpmInfo=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Place / Geopolitical Entity

getPlaceInfo

Parameters

• place_id: number
• callback: string

Return

• place_info: place_extended (not yet added)

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceInfo?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getSubdivisions

Parameters

• place_id: number
• callback: string

Return

• subdivs: array of place_basic

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getSubdivisions?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getGeoTaxa

Parameters

• place_id: number
• callback: string

Return

• taxa: array of taxon_extended (tnuid is not a number) with the below extensions
  • valid_taxon: taxon_basic
  • hier: taxon_hierarchy

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getGeoTaxa?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getGeoCollTrips

Parameters

• place_id: number
• callback: string

Return

• coll_trips: array of taxon_basic with below extensions
  • institution class (not yet added)
  • collector class (not yet added)

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getGeoCollTrips?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getGeoCollTrips2

Parameters

• place_id: number
• callback: string

Return

• coll_trips: array of taxon_basic with below extensions
  • institution class (not yet added)
  • collector class (not yet added)

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getGeoCollTrips2?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getGeoInsts

Parameters

• place_id: number
• callback: string

Return

• collections: array of institution (not yet added)

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getGeoInsts?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Literature

getLitReference

Parameters

• pub_id: number
• callback: string

Return

• pub_ref: array of literature_basic (extended?)

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getLitReference?pub_id=419&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getLitParts

Parameters

• pub_id: number
• callback: string

Return

• pub_parts: array of ..

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getLitParts?pub_id=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getPubTaxonCitation

Parameters

• pub_id: number
• callback: string

Return

• pub_cits: array of ..
• public: string
• author: string

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getPubTaxonCitation?pub_id=419&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getPubAssocCitation

Parameters

• pub_id: number
• callback: string

Return

• assoc_cits: array of ..

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getPubAssocCitation?pub_id=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Journal

getJournalInfo

Parameters

• jrnl_id: number
• callback: string

Return

• journal_info: array of below elements
  • name: string
  • url: string
  • is_public: string
  • copyright_holder: string
  • num_articles: number
  • num_pdfs: number
  • num_taxa: number
  • last_article_time: string

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalInfo?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getJournalPubs

Parameters

• jrnl_id: number
• callback: string

Return

• pubs: array of literature_basic (extended?)

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalPubs?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getJournalTaxa

Parameters

• jrnl_id: number
• callback: string

Return

• taxa: array of taxon_basic

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalTaxa?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Institution

getCollectionInfo

Parameters

• inst_id: number
• callback: string

Return

• collection_info: array of below elements
  • name: string
  • code: string
  • vouchered: boolean (needs change to Y or N)
  • num_prim_types: number
  • num_sec_types: number
  • num_species: number
  • num_spms: number
  • last_spm_time: string
  • oldest_spm: array of the following
    • cuid: string
    • coll_date: string

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getCollectionInfo?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getPrimaryTypes

Parameters

• inst_id: number
• callback: string

Return

• types: array of taxon_basic with below extensions
  • cuid: string
  • type: string
  • hier: taxon_hierarchy
  • orig_desc: pubs (not yet added)

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getPrimaryTypes?inst_id=6&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getSecondaryTypes

Parameters

• inst_id: number
• callback: string

Return

• types: array of taxon_basic with below extensions
  • cuid: string
  • type: string
  • hier: taxon_hierarchy
  • orig_desc: pubs (not yet added)

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getSecondaryTypes?inst_id=6&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getInstTaxa

Parameters

• inst_id: number
• callback: string

Return

• taxa: array of taxon_extended with below extension
  • hier: taxon_hierarchy

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getInstTaxa?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getInstCollTrips2

Parameters

• inst_id: number
• callback: string

Return

• coll_trips: array of taxon_basic with below extensions
  • institution class (not yet added)
  • collector class (not yet added)

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getInstCollTrips2?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getInstPubs

Parameters

• inst_id: number
• callback: string

Return

• pubs: array of literature_basic

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getInstPubs?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Unvouchered Record

getUnvoucheredRecord

Parameters

• unv_id: number
• callback: string

Return

• unvoucheredRecord: array of ..

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getUnvoucheredRecord?unv_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getUnvoucheredRecords

Parameters

• tnuid: number
• showChildren: string
• pnids: array of number
• callback: string

Return

• unvoucheredRecords: array of ..

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getUnvoucheredRecords?tnuid=44&showChildren=Y&pnids=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getUnvoucheredRecords

Parameters

• tnuid: number
• pnids: array of number
• callback: string

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getUnvoucheredRecords?tnuid=44&pnids=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getUnvLocalityInfo

Parameters

• loc_id: number
• tnuid: number
• per_id: number
• pnid: number
• showChildren: string
• callback: string

Return

• locInfo: array of ..

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getUnvLocalityInfo?loc_id=1&tnuid=30148&per_id=1&pnid=1&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Text Search

getSearchResults

Parameters

• name: string
• limit: number
• categoryLimit: string
• callback: string

Return

• taxon_results:
• cuid_results:
• agent_results:
• inst_results:
• place_results:
• journal_results:

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getSearchResults?name=Heptascelio+striatosternus&limit=20&categoryLimit=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxaFromText

Parameters

• name: string
• limit: number
• nameOnly: string
• callback: string

Return

• taxa:
• count: number

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxaFromText?name=Heptascelio+striatosternus&limit=10&nameOnly=N&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getCuidsFromText

Parameters

• name: string
• limit: number
• callback: string

Return

• cuids: array of cuid
• count: number

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getCuidsFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getAgentsFromText

Parameters

• name: string
• limit: number
• includeParty: string
• callback: string

Return

• agents:
• count: number

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentsFromText?name=Heptascelio+striatosternus&limit=10&includeParty=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getInstFromText

Parameters

• name: string
• limit: number
• callback: string

Return

• inst:
• count: number

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getInstFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getJournalsFromText

Parameters

• name: string
• limit: number
• callback: string

Return

• journals:
• count: number

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalsFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getOrgsFromText

Parameters

• name: string
• limit: number
• callback: string

Return

• orgs:
• count: number

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getOrgsFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getPlacesFromText

Parameters

• name: string
• limit: number
• callback: string

Return

• places:
• count: number

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getPlacesFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getLocalitiesFromText

Parameters

• name: string
• limit: number
• callback: string

Return

• locs:
• count: number

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalitiesFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getCollMethodsFromText

Parameters

• name: string
• limit: number
• callback: string

Return

• coll_methods:
• count: number

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getCollMethodsFromText?name=Heptascelio+striatosternus&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Data Type Glossary

OJ_Break API Data Type Glossary