Difference between revisions of "OJ Break API Reference"

Latest revision as of 14:57, 9 July 2018

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.

The reference for version 2 of the API can be found here: OJ_Break_Version_2_API_Reference

API Information and Access

This page specifies the methods and data defined by OJ_Break Version 1. Using the OJ_Break Version 1 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: https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

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

Procedural Reference

Agent

getCollectorInfo

Description

Parameters

collector_id: number
format: string
key: string

Return

collector_info: array of author_info

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCollectorInfo?collector_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getAuthorPubs

Description

Parameters

author_id: number
format: string
key: string

Return

pubs: array of literature_extended

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getAuthorPubs?author_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getCollTrips2

Description

Parameters

collector_id: number
format: string
key: string

Return

coll_trips: array of collection_basic, taxon_basic, loc_coords, and collector.

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCollTrips2?collector_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getAuthorTaxa

Description

Parameters

author_id: number
format: string
key: string

Return

taxa: array of taxon_basic

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getAuthorTaxa?author_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Taxon

getTaxonStats

Description

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

Parameters

tnuid: number
format: string
key: string

Return

taxon: string
author: string
stats: taxon_stats

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/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
format: string
key: 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

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/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
format: string
key: string

Return

taxon: string
author: string
hier: taxon_hierarchy

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/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: boolean_flag
showFossils: boolean_flag
types_only: boolean_flag
show_num_spms: boolean_flag
format: string
key: string

Return

tnuid: number
parent_tnuid: number
includedTaxa: array of taxon_extended

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/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 objectively or subjectively synonymous with a taxon.

Parameters

tnuid: number
showFossils: boolean_flag
format: string
key: string

Return

synonyms: array of taxon_rel_extended

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/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: boolean_flag
format: string
key: string

Return

localities: array of loc_coords

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/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: boolean_flag
format: string
key: string

Return

localities: array of loc_coords

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/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: boolean_flag
inst_id: number
pnids: array of pnid
format: string
key: string

Return

cuids: array of cuid

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/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
format: string
key: string

Return

cuids: array of cuid

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCuids?tnuids=30148,491&pnids=5816,5735&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTypes

Description

Gets information and specimen types for a specified taxon.

Parameters

tnuid: number
showSyns: boolean_flag
inst_id: number
primary_only: boolean_flag
taxon_author_search: string
offset: number
limit: number
format: string
key: string

Return

num_records: number
types: array of type_extended

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTypes?tnuid=434&showSyns=F&inst_id=1&primary_only=Y&taxon_author_search=&offset=1&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getInsts

Description

Gets institutions which hold specimens for a selected taxon.

Parameters

tnuid: number
format: string
key: string

Return

collections: array of collection_extended

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInsts?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxonLiterature (deprecated)

Description

Deprecated. Use getTaxonLit instead

Parameters

tnuid: number
showSyns: string
format: string
key: string

Return

lit: pubs

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonLiterature?tnuid=30148&showSyns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxonLit

Description

Preferred. Get literature for a selected taxon.

Parameters

tnuid: number
showSyns: boolean_flag
format: string
key: string

Return

pubs: array of pub_extended

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonLit?tnuid=30148&showSyns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getAssociations

Description

Get evolutionary relationships for a certain taxon.

Parameters

tnuid: number
rank_grouping: string
format: string
key: string

Return

associations: array of association

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getAssociations?tnuid=491&rank_grouping=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getHabitats

Description

Get descriptions of the habitats that a selected specimen inhabits.

Parameters

tnuid: number
format: string
key: string

Return

habitats: array of habitat

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getHabitats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxonMedia

Description

Get images, videos, or sound clips of a selected taxon.

Parameters

tnuid: number
format: string
key: string

Return

media: array of media_basic

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonMedia?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxonBreakdown

Description

Get count of genders and total specimen included in the current rank.

Parameters

tnuid: number
format: string
key: string

Return

taxa: array of taxon_basic with below extension
- count: number
sex: array of spm_sex

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonBreakdown?tnuid=491&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxonPhenology

Description

Get taxon specimens by date.

Parameters

tnuid: number
format: string
key: string

Return

spms: array of below elements
- date: string
- sort_date: string
- cuid: string

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonPhenology?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxonNewTaxaByPub

Description

Get count of new specimens for a specific taxon by publication.

Parameters

tnuid: number
validOnly: boolean_flag
format: string
key: string

Return

pubs: array of literature_extended with below extension
- taxa_num: string

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonNewTaxaByPub?tnuid=491&validOnly=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxonNewTaxaByYear

Description

Get count of new specimens for a specific taxon by year.

Parameters

tnuid: number
validOnly: string
format: string
key: string

Return

years: array of below elements
- taxa_num: string
- year: string

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonNewTaxaByYear?tnuid=52&validOnly=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxonStatsForYear

Description

Get stats, such as image count, new genera introduced, new specimen introduced, and more by year for a selected taxon.

Parameters

tnuid: number
stats_year: number
format: string
key: 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

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonStatsForYear?tnuid=30148&stats_year=2014&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Occurrence

Specimen Record

getSpmInfo

Description

Get info for a specific specimen occurrence.

Parameters

cuid: string
format: string
key: string

Return

spmInfo: record_vouchered

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSpmInfo?cuid=OSUC+59557&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getSpmsInfo

Description

Get info for multiple specimen occurrences.

Parameters

cuids: array of string
format: string
key: string

Return

spmsInfo: array of record_vouchered

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSpmsInfo?cuids=OSUC+59557,OSUC+56308&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Unvouchered Record

getUnvoucheredRecord

Description

Get specimen record information for a selected unvouchered specimen.

Parameters

unv_id: number
format: string
key: string

Return

unvoucheredRecord: record_unvouchered

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getUnvoucheredRecord?unv_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getUnvoucheredRecords

Description

Get unvouchered specimen records for a selected taxon and place.

Parameters

tnuid: number
showChildren: string
pnids: array of number
format: string
key: string

Return

unvoucheredRecords: array of record_unvouchered

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getUnvoucheredRecords?tnuid=44&showChildren=Y&pnids=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Locality

getLocalityInfo

Description

Get basic information for a specific locality, including specimen occurrences, place hierarchy, and coordinates.

Parameters

loc_id: number
tnuid: number
inst_id: number
per_id: number
pnid: number
showChildren: string
completeSpmInfo: string
format: string
key: string

Return

locInfo: array of loc_info with below extensions
- hier: array of place
- cuids: array of record_vouchered (only present if specified) or array of cuid
- sex: array of spm_sex

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLocalityInfo?loc_id=1&tnuid=30148&inst_id=1&per_id=1&pnid=1&showChildren=Y&completeSpmInfo=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getUnvLocalityInfo

Description

Get locality information and occurrences (specimens) for a selected locality. The request can be narrowed down further by selected multiple parameter options.

Parameters

loc_id: number
tnuid: number
per_id: number
pnid: number
showChildren: string
format: string
key: string

Return

locInfo: loc_info with below extensions
- hier: array of place
- cuids: array of cuid

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getUnvLocalityInfo?loc_id=1&tnuid=30148&per_id=1&pnid=1&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Place / Geopolitical Entity

getPlaceInfo

Description

Get basic place information including the place hierarchy, number of specimens, and number of species.

Parameters

place_id: number
format: string
key: string

Return

place_info: place with below extension
- hier: array of place
- num_species: number
- num_spms: number

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPlaceInfo?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getSubdivisions

Description

Get smaller levels of divisions for a selected place.

Parameters

place_id: number
format: string
key: string

Return

subdivs: array of place

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSubdivisions?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getGeoTaxa

Description

Get taxonomic information from a specified place.

Parameters

place_id: number
format: string
key: string

Return

taxa: array of taxon_basic with below extensions
- valid_taxon: taxon_basic (only present when defined)
- hier: taxon_hierarchy
- count: number
- rank: string

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getGeoTaxa?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getGeoCollTrips

Description

Get collecting trips info for a specified place.

Parameters

place_id: number
format: string
key: string

Return

coll_trips: array of loc_basic and collector.

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getGeoCollTrips?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getGeoCollTrips2

Description

Get collecting trips and taxa info for a specified place.

Parameters

place_id: number
format: string
key: string

Return

coll_trips: array of taxon_basic, collection, collector and loc_basic with below extension
- valid_taxon: taxon_basic (only present when defined)

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getGeoCollTrips2?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getGeoInsts

Description

Get institutions from a selected place.

Parameters

place_id: number
format: string
key: string

Return

collections: array of collection_extended

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getGeoInsts?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Literature

getLitReference

Description

Get the reference for a selected publication.

Parameters

pub_id: number
format: string
key: string

Return

pub_ref: literature_extended

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLitReference?pub_id=419&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getLitParts

Description

Get parts of the selected publication, such as pages, pdf urls, chapters, titles, authors, and more.

Parameters

pub_id: number
format: string
key: string

Return

pub_parts: array of literature_extended

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLitParts?pub_id=20239&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getPubTaxonCitation

Description

Get cited taxon information from a selected publication.

Parameters

pub_id: number
format: string
key: string

Return

pub_cits: array of pub_basic and taxon_basic with below extensions
- tnucid: number
- rank: string
public: string
author: string

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPubTaxonCitation?pub_id=419&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getPubAssocCitation

Description

Parameters

pub_id: number
format: string
key: string

Return

assoc_cits: array of ..

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPubAssocCitation?pub_id=23683&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Journal

getJournalInfo

Description

Parameters

jrnl_id: number
format: string
key: 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

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getJournalInfo?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getJournalPubs

Description

Parameters

jrnl_id: number
format: string
key: string

Return

pubs: array of literature_extended

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getJournalPubs?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getJournalTaxa

Description

Parameters

jrnl_id: number
format: string
key: string

Return

taxa: array of taxon_basic

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getJournalTaxa?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Institution

getCollectionInfo

Description

Parameters

inst_id: number
format: string
key: string

Return

collection_info: array of collection_extended with below extensions
- vouchered: boolean
- num_prim_types: number
- num_sec_types: number
- num_species: number
- last_spm_time: string
- oldest_spm: array of below elements
  - cuid: string
  - coll_date: string

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCollectionInfo?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getPrimaryTypes

Description

Get specimen of which the description of a new species is based.

Parameters

inst_id: number
format: string
key: string

Return

types: array of type

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPrimaryTypes?inst_id=6&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getSecondaryTypes

Description

Get specimen that are occurrences of a specific species, but not a primary type.

Parameters

inst_id: number
format: string
key: string

Return

types: array of type

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSecondaryTypes?inst_id=6&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getInstTaxa

Description

Get taxa and related taxonomic information from a selected institution.

Parameters

inst_id: number
format: string
key: string

Return

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

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInstTaxa?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getInstCollTrips2

Description

Get collecting trip events and the specimen collected for a selected institution.

Parameters

inst_id: number
format: string
key: string

Return

coll_trips: array of taxon_basic, collection, collector, and loc_basic.

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInstCollTrips2?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getInstPubs

Description

Get published literature from a selected institution.

Parameters

inst_id: number
format: string
key: string

Return

pubs: array of literature_extended

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInstPubs?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Text Search

getSearchResults

Description

Get database results from a text keyword search.

Parameters

name: string
limit: number
categoryLimit: string
format: string
key: string

Return

taxon_results: array of below extensions
- taxa: array of taxon_extended with below extension
  - lsid: number
- count: number
cuid_results: array of below extensions
- cuids: array of cuids
- count: number
agent_results: array of below extensions
- agents: array of below extensions
  - type: string
  - id: number
  - name: string
  - inst: string
- count: number
inst_results: array of below extensions
- inst: array of collection_extended
- count: number
place_results: array of below extensions
- places: array of place with below extension
  - hier: array of place
- count: number
journal_results: array of below extensions
- journals: array of below extensions
  - name: string
  - id: number
- count: number

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSearchResults?name=%OSU%&limit=20&categoryLimit=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getTaxaFromText

Description

Get taxa results from a selected search keyword.

Parameters

name: string
limit: number
nameOnly: string
format: string
key: string

Return

taxa: array of taxon_extended with below extensions
- lsid: number
count: number

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxaFromText?name=Heptascelio+striatosternus&limit=10&nameOnly=N&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getCuidsFromText

Description

Get occurrence results from a selected search keyword.

Parameters

name: string
limit: number
format: string
key: string

Return

cuids: array of cuid
count: number

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCuidsFromText?name=%OSUC%&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getAgentsFromText

Description

Get agent (person and/or party) results from a selected search keyword.

Parameters

name: string
limit: number
includeParty: string
format: string
key: string

Return

agents: array of below elements
- id: number
- type: string
- name: string
- inst: string
count: number

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getAgentsFromText?name=%Johnson,%20N.%20F.%&limit=10&includeParty=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getInstFromText

Description

Get institution/collection results from a selected search keyword(s).

Parameters

name: string
limit: number
format: string
key: string

Return

inst: array of collection_extended
count: number

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInstFromText?name=Hymenoptera&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getJournalsFromText

Description

Get journal results from a selected search keyword(s).

Parameters

name: string
limit: number
format: string
key: string

Return

journals: array of below elements
- name: string
- id: number
count: number

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getJournalsFromText?name=Insect&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getOrgsFromText

Description

Get organization results for a selected search keyword(s).

Parameters

name: string
limit: number
format: string
key: string

Return

orgs: array of below elements
- name: string
- id: number
count: number

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getOrgsFromText?name=%Geo%&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getPlacesFromText

Description

Parameters

name: string
limit: number
format: string
key: string

Return

places: array of place with below extension
- hier: array of place
count: number

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPlacesFromText?name=Guyana&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getLocalitiesFromText

Description

Parameters

name: string
limit: number
format: string
key: string

Return

locs: array of below elements
- name: string
- id: number
count: number

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLocalitiesFromText?name=Guyana&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getCollMethodsFromText

Description

Parameters

name: string
limit: number
format: string
key: string

Return

coll_methods: array of below elements
- name: string
- id: number
count: number

Example

https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCollMethodsFromText?name=reared&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

Data Type Glossary

OJ_Break API Data Type Glossary

@@ Line 4: / Line 4: @@
-== API Use and Access ==
+The reference for version 2 of the API can be found here: [[OJ_Break_Version_2_API_Reference]]
-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]].
+== API Information and Access ==
+This page specifies the methods and data defined by OJ_Break Version 1. Using the OJ_Break Version 1 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: https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+To read more about using the OJ_Break Version 1 API, go to [[OJ_Break API Access]].
 == Procedural Reference ==
+=== Agent ===
+==== getCollectorInfo ====
+===== Description =====
+===== Parameters =====
+* ''collector_id'': number
+* ''format'': string
+* ''key'': string
+===== Return =====
+* ''collector_info'': array of author_info
+===== Example =====
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCollectorInfo?collector_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+==== getAuthorPubs ====
+===== Description =====
+===== Parameters =====
+* ''author_id'': number
+* ''format'': string
+* ''key'': string
+===== Return =====
+* ''pubs'': array of literature_extended
+===== Example =====
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getAuthorPubs?author_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+==== getCollTrips2 ====
+===== Description =====
+===== Parameters =====
+* ''collector_id'': number
+* ''format'': string
+* ''key'': string
+===== Return =====
+* ''coll_trips'': array of collection_basic, taxon_basic, loc_coords, and collector.
+===== Example =====
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCollTrips2?collector_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+==== getAuthorTaxa ====
+===== Description =====
+===== Parameters =====
+* ''author_id'': number
+* ''format'': string
+* ''key'': string
+===== Return =====
+''taxa'': array of taxon_basic
+===== Example =====
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getAuthorTaxa?author_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 === Taxon ===
 ==== getTaxonStats ====
@@ Line 26: / Line 79: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTaxonInfo ====
@@ Line 47: / Line 100: @@
 * ''contribs'': array of contribution
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInfo?tnuid=30148&inst_id=0&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonInfo?tnuid=30148&inst_id=0&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTaxonHierarchy ====
@@ Line 61: / Line 114: @@
 * ''hier'': taxon_hierarchy
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonHierarchy?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonHierarchy?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getIncludedTaxa ====
@@ Line 81: / Line 134: @@
 * ''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
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getIncludedTaxa?tnuid=491&inst_id=0&showSyns=Y&showFossils=Y&types_only=N&show_num_spms=N&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTaxonSynonyms ====
@@ Line 95: / Line 148: @@
 * ''synonyms'': array of taxon_rel_extended
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonSynonyms?tnuid=30148&showFossils=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonSynonyms?tnuid=30148&showFossils=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getLocalities ====
@@ Line 111: / Line 164: @@
 * ''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
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLocalities?tnuid=30148&inst_id=0&precDecimals=4&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getLocalities ====
@@ Line 128: / Line 181: @@
 * ''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
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLocalities?tnuid=30148&pnids=5816,5735&inst_id=0&precDecimals=4&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getCuids ====
@@ Line 144: / Line 197: @@
 * ''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
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCuids?tnuid=30148&showChildren=Y&inst_id=1&pnids=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getCuids ====
@@ Line 158: / Line 211: @@
 * ''cuids'': array of cuid
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getCuids?tnuids=30148,491&pnids=5816,5735&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCuids?tnuids=30148,491&pnids=5816,5735&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTypes ====
@@ Line 180: / Line 233: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTypes?tnuid=434&showSyns=F&inst_id=1&primary_only=Y&taxon_author_search=&offset=1&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTypes?tnuid=434&showSyns=F&inst_id=1&primary_only=Y&taxon_author_search=&offset=1&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getInsts ====
@@ Line 195: / Line 248: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getInsts?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInsts?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTaxonLiterature (deprecated) ====
@@ Line 209: / Line 262: @@
 * ''lit'': pubs
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLiterature?tnuid=30148&showSyns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonLiterature?tnuid=30148&showSyns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTaxonLit ====
@@ Line 224: / Line 277: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLit?tnuid=30148&showSyns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonLit?tnuid=30148&showSyns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getAssociations ====
@@ Line 239: / Line 292: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getAssociations?tnuid=491&rank_grouping=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getAssociations?tnuid=491&rank_grouping=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getHabitats ====
@@ Line 254: / Line 307: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getHabitats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getHabitats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTaxonMedia ====
@@ Line 268: / Line 321: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonMedia?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonMedia?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTaxonBreakdown ====
@@ Line 284: / Line 337: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonBreakdown?tnuid=491&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonBreakdown?tnuid=491&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTaxonPhenology ====
@@ Line 301: / Line 354: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonPhenology?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonPhenology?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTaxonNewTaxaByPub ====
@@ Line 317: / Line 370: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonNewTaxaByPub?tnuid=491&validOnly=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonNewTaxaByPub?tnuid=491&validOnly=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTaxonNewTaxaByYear ====
@@ Line 334: / Line 387: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonNewTaxaByYear?tnuid=52&validOnly=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonNewTaxaByYear?tnuid=52&validOnly=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTaxonStatsForYear ====
@@ Line 357: / Line 410: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStatsForYear?tnuid=30148&stats_year=2014&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonStatsForYear?tnuid=30148&stats_year=2014&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 === Occurrence ===
@@ Line 372: / Line 425: @@
 * ''spmInfo'': record_vouchered
 ====== Example ======
-http://osuc.biosci.ohio-state.edu/OJ_Break/getSpmInfo?cuid=OSUC+59557&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSpmInfo?cuid=OSUC+59557&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ===== getSpmsInfo =====
@@ Line 385: / Line 438: @@
 * ''spmsInfo'': array of record_vouchered
 ====== Example ======
-http://osuc.biosci.ohio-state.edu/OJ_Break/getSpmsInfo?cuids=OSUC+59557,OSUC+56308&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSpmsInfo?cuids=OSUC+59557,OSUC+56308&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== Unvouchered Record ====
@@ Line 400: / Line 453: @@
 ====== Example ======
-http://osuc.biosci.ohio-state.edu/OJ_Break/getUnvoucheredRecord?unv_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getUnvoucheredRecord?unv_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ===== getUnvoucheredRecords =====
@@ Line 416: / Line 469: @@
 ====== Example ======
-http://osuc.biosci.ohio-state.edu/OJ_Break/getUnvoucheredRecords?tnuid=44&showChildren=Y&pnids=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getUnvoucheredRecords?tnuid=44&showChildren=Y&pnids=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 === Locality ===
@@ Line 440: / Line 493: @@
 ===== 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
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLocalityInfo?loc_id=1&tnuid=30148&inst_id=1&per_id=1&pnid=1&showChildren=Y&completeSpmInfo=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getUnvLocalityInfo ====
@@ Line 460: / Line 513: @@
 ===== 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
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getUnvLocalityInfo?loc_id=1&tnuid=30148&per_id=1&pnid=1&showChildren=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 === Place / Geopolitical Entity ===
@@ Line 478: / Line 531: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceInfo?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPlaceInfo?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getSubdivisions ====
@@ Line 492: / Line 545: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getSubdivisions?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSubdivisions?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getGeoTaxa ====
@@ Line 511: / Line 564: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getGeoTaxa?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getGeoTaxa?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getGeoCollTrips ====
@@ Line 525: / Line 578: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getGeoCollTrips?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getGeoCollTrips?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getGeoCollTrips2 ====
@@ Line 541: / Line 594: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getGeoCollTrips2?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getGeoCollTrips2?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getGeoInsts ====
@@ Line 555: / Line 608: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getGeoInsts?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getGeoInsts?place_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 === Literature ===
@@ Line 570: / Line 623: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getLitReference?pub_id=419&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLitReference?pub_id=419&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getLitParts ====
@@ Line 584: / Line 637: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getLitParts?pub_id=20239&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLitParts?pub_id=20239&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getPubTaxonCitation ====
@@ Line 602: / Line 655: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getPubTaxonCitation?pub_id=419&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPubTaxonCitation?pub_id=419&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getPubAssocCitation ====
@@ Line 615: / Line 668: @@
 * ''assoc_cits'': array of ..
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getPubAssocCitation?pub_id=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPubAssocCitation?pub_id=23683&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 === Journal ===
@@ Line 638: / Line 691: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalInfo?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getJournalInfo?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getJournalPubs ====
@@ Line 652: / Line 705: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalPubs?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getJournalPubs?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getJournalTaxa ====
@@ Line 665: / Line 718: @@
 * ''taxa'': array of taxon_basic
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalTaxa?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getJournalTaxa?jrnl_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 === Institution ===
@@ Line 688: / Line 741: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getCollectionInfo?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCollectionInfo?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getPrimaryTypes ====
@@ Line 702: / Line 755: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getPrimaryTypes?inst_id=6&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPrimaryTypes?inst_id=6&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getSecondaryTypes ====
@@ Line 716: / Line 769: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getSecondaryTypes?inst_id=6&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSecondaryTypes?inst_id=6&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getInstTaxa ====
@@ Line 731: / Line 784: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getInstTaxa?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInstTaxa?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getInstCollTrips2 ====
@@ Line 745: / Line 798: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getInstCollTrips2?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInstCollTrips2?inst_id=21&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getInstPubs ====
@@ Line 759: / Line 812: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getInstPubs?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInstPubs?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 === Text Search ===
@@ Line 801: / Line 854: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getSearchResults?name=%OSU%&limit=20&categoryLimit=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getSearchResults?name=%OSU%&limit=20&categoryLimit=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getTaxaFromText ====
@@ Line 819: / Line 872: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxaFromText?name=Heptascelio+striatosternus&limit=10&nameOnly=N&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxaFromText?name=Heptascelio+striatosternus&limit=10&nameOnly=N&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getCuidsFromText ====
@@ Line 835: / Line 888: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getCuidsFromText?name=%OSUC%&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCuidsFromText?name=%OSUC%&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getAgentsFromText ====
@@ Line 856: / Line 909: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentsFromText?name=%Johnson,%20N.%20F.%&limit=10&includeParty=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getAgentsFromText?name=%Johnson,%20N.%20F.%&limit=10&includeParty=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getInstFromText ====
@@ Line 872: / Line 925: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getInstFromText?name=Hymenoptera&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getInstFromText?name=Hymenoptera&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getJournalsFromText ====
@@ Line 890: / Line 943: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalsFromText?name=Insect&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getJournalsFromText?name=Insect&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getOrgsFromText ====
@@ Line 908: / Line 961: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getOrgsFromText?name=%Geo%&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getOrgsFromText?name=%Geo%&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getPlacesFromText ====
@@ Line 925: / Line 978: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getPlacesFromText?name=Guyana&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getPlacesFromText?name=Guyana&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getLocalitiesFromText ====
@@ Line 943: / Line 996: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalitiesFromText?name=Guyana&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getLocalitiesFromText?name=Guyana&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getCollMethodsFromText ====
@@ Line 961: / Line 1,014: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getCollMethodsFromText?name=reared&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getCollMethodsFromText?name=reared&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 == Data Type Glossary ==

Difference between revisions of "OJ Break API Reference"

Latest revision as of 14:57, 9 July 2018

Contents

API Information and Access

Procedural Reference

Agent

getCollectorInfo

Description

Parameters

Return

Example

getAuthorPubs

Description

Parameters

Return

Example

getCollTrips2

Description

Parameters

Return

Example

getAuthorTaxa

Description

Parameters

Return

Example

Taxon

getTaxonStats

Description

Parameters

Return

Example

getTaxonInfo

Description

Parameters

Return

Example

getTaxonHierarchy

Description

Parameters

Return

Example

getIncludedTaxa

Description

Parameters

Return

Example

getTaxonSynonyms

Description

Parameters

Return

Example

getLocalities

Description

Parameters

Return

Example

getLocalities

Description

Parameters

Return

Example

getCuids

Description

Parameters

Return

Example

getCuids

Description

Parameters

Return

Example

getTypes

Description

Parameters

Return

Example

getInsts

Description

Parameters