Difference between revisions of "OJ Break API Reference"

From xBio:D Wiki
Jump to navigation Jump to search
(→‎Return)
(→‎Procedural Reference)
Line 18: Line 18:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': number
 
* ''tnuid'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 
===== Return =====
 
===== Return =====
 
* ''taxon'': string
 
* ''taxon'': string
Line 33: Line 34:
 
* ''tnuid'': number
 
* ''tnuid'': number
 
* ''inst_id'': number
 
* ''inst_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 
===== Return =====
 
===== Return =====
 
* ''taxon_rel_extended'' class with below extensions
 
* ''taxon_rel_extended'' class with below extensions
Line 52: Line 54:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': number
 
* ''tnuid'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 
===== Return =====
 
===== Return =====
 
* ''taxon'': string
 
* ''taxon'': string
Line 70: Line 73:
 
* ''types_only'': boolean_flag
 
* ''types_only'': boolean_flag
 
* ''show_num_spms'': boolean_flag
 
* ''show_num_spms'': boolean_flag
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
  
 
===== Return =====
 
===== Return =====
Line 85: Line 89:
 
* ''tnuid'': number
 
* ''tnuid'': number
 
* ''showFossils'': boolean_flag
 
* ''showFossils'': boolean_flag
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
  
 
===== Return =====
 
===== Return =====
Line 100: Line 105:
 
* ''precDecimals'': number
 
* ''precDecimals'': number
 
* ''showChildren'': boolean_flag
 
* ''showChildren'': boolean_flag
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
  
 
===== Return =====
 
===== Return =====
Line 116: Line 122:
 
* ''precDecimals'': number
 
* ''precDecimals'': number
 
* ''showChildren'': boolean_flag
 
* ''showChildren'': boolean_flag
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
  
 
===== Return =====
 
===== Return =====
Line 131: Line 138:
 
* ''inst_id'': number
 
* ''inst_id'': number
 
* ''pnids'': array of pnid
 
* ''pnids'': array of pnid
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
  
 
===== Return =====
 
===== Return =====
Line 144: Line 152:
 
* ''tnuids'': array of tnuid
 
* ''tnuids'': array of tnuid
 
* ''pnids'': array of pnid
 
* ''pnids'': array of pnid
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''cuids'': array of cuid
 
* ''cuids'': array of cuid
Line 161: Line 171:
 
* ''offset'': number
 
* ''offset'': number
 
* ''limit'': number
 
* ''limit'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
  
 
===== Return =====
 
===== Return =====
Line 183: Line 194:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': number
 
* ''tnuid'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''collections'': array of collection (not yet added)
 
* ''collections'': array of collection (not yet added)
−
 
 
===== Example =====
 
===== Example =====
 
http://osuc.biosci.ohio-state.edu/OJ_Break/getInsts?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 
http://osuc.biosci.ohio-state.edu/OJ_Break/getInsts?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
Line 196: Line 208:
 
* ''tnuid'': number
 
* ''tnuid'': number
 
* ''showSyns'': string
 
* ''showSyns'': string
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''lit'': pubs
 
* ''lit'': pubs
Line 208: Line 222:
 
* ''tnuid'': number
 
* ''tnuid'': number
 
* ''showSyns'': boolean_flag
 
* ''showSyns'': boolean_flag
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
  
 
===== Return =====
 
===== Return =====
Line 221: Line 236:
 
* ''tnuid'': number
 
* ''tnuid'': number
 
* ''rank_grouping'': string
 
* ''rank_grouping'': string
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''associations'': array of taxon_basic (tnuid is not a number) with the below extensions
 
* ''associations'': array of taxon_basic (tnuid is not a number) with the below extensions
Line 237: Line 254:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': number
 
* ''tnuid'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''habitats'': array of media_basic with the below extensions
 
* ''habitats'': array of media_basic with the below extensions
Line 250: Line 269:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': number
 
* ''tnuid'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''media'': array of media_basic (not yet added)
 
* ''media'': array of media_basic (not yet added)
Line 262: Line 283:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': number
 
* ''tnuid'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''taxa'': array of taxon_extended (tnuid is not a number)
 
* ''taxa'': array of taxon_extended (tnuid is not a number)
Line 275: Line 298:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': number
 
* ''tnuid'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''spms'': array of the below elements  
 
* ''spms'': array of the below elements  
Line 291: Line 316:
 
* ''tnuid'': number
 
* ''tnuid'': number
 
* ''validOnly'': boolean_flag
 
* ''validOnly'': boolean_flag
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
  
 
===== Return =====
 
===== Return =====
Line 306: Line 332:
 
* ''tnuid'': number
 
* ''tnuid'': number
 
* ''validOnly'': string
 
* ''validOnly'': string
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''years'': array of the below elements
 
* ''years'': array of the below elements
Line 321: Line 349:
 
* ''tnuid'': number
 
* ''tnuid'': number
 
* ''stats_year'': number
 
* ''stats_year'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''stats'': array of below elements
 
* ''stats'': array of below elements
Line 342: Line 372:
 
===== Parameters =====
 
===== Parameters =====
 
* ''cuid'': string
 
* ''cuid'': string
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''spmInfo'': array of ..
 
* ''spmInfo'': array of ..
Line 371: Line 403:
 
* ''showChildren'': string
 
* ''showChildren'': string
 
* ''completeSpmInfo'': string
 
* ''completeSpmInfo'': string
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''locInfo'': array of loc_coords_extended
 
* ''locInfo'': array of loc_coords_extended
Line 384: Line 418:
 
===== Parameters =====
 
===== Parameters =====
 
* ''place_id'': number
 
* ''place_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''place_info'': place_extended (not yet added)
 
* ''place_info'': place_extended (not yet added)
Line 396: Line 432:
 
===== Parameters =====
 
===== Parameters =====
 
* ''place_id'': number
 
* ''place_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''subdivs'': array of place_basic
 
* ''subdivs'': array of place_basic
Line 408: Line 446:
 
===== Parameters =====
 
===== Parameters =====
 
* ''place_id'': number
 
* ''place_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''taxa'': array of taxon_extended (tnuid is not a number) with the below extensions
 
* ''taxa'': array of taxon_extended (tnuid is not a number) with the below extensions
Line 422: Line 462:
 
===== Parameters =====
 
===== Parameters =====
 
* ''place_id'': number
 
* ''place_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''coll_trips'': array of loc_basic with below extension
 
* ''coll_trips'': array of loc_basic with below extension
Line 435: Line 477:
 
===== Parameters =====
 
===== Parameters =====
 
* ''place_id'': number
 
* ''place_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''coll_trips'': array of taxon_basic with below extensions
 
* ''coll_trips'': array of taxon_basic with below extensions
Line 449: Line 493:
 
===== Parameters =====
 
===== Parameters =====
 
* ''place_id'': number
 
* ''place_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''collections'': array of institution (not yet added)
 
* ''collections'': array of institution (not yet added)
Line 462: Line 508:
 
===== Parameters =====
 
===== Parameters =====
 
* ''pub_id'': number
 
* ''pub_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''pub_ref'': array of literature_basic (extended?)
 
* ''pub_ref'': array of literature_basic (extended?)
Line 474: Line 522:
 
===== Parameters =====
 
===== Parameters =====
 
* ''pub_id'': number
 
* ''pub_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''pub_parts'': array of ..
 
* ''pub_parts'': array of ..
Line 485: Line 535:
 
===== Parameters =====
 
===== Parameters =====
 
* ''pub_id'': number
 
* ''pub_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''pub_cits'': array of ..
 
* ''pub_cits'': array of ..
Line 498: Line 550:
 
===== Parameters =====
 
===== Parameters =====
 
* ''pub_id'': number
 
* ''pub_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''assoc_cits'': array of ..
 
* ''assoc_cits'': array of ..
Line 510: Line 564:
 
===== Parameters =====
 
===== Parameters =====
 
* ''jrnl_id'': number
 
* ''jrnl_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''journal_info'': array of below elements
 
* ''journal_info'': array of below elements
Line 530: Line 586:
 
===== Parameters =====
 
===== Parameters =====
 
* ''jrnl_id'': number
 
* ''jrnl_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''pubs'': array of literature_basic (extended?)
 
* ''pubs'': array of literature_basic (extended?)
Line 542: Line 600:
 
===== Parameters =====
 
===== Parameters =====
 
* ''jrnl_id'': number
 
* ''jrnl_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''taxa'': array of taxon_basic
 
* ''taxa'': array of taxon_basic
Line 554: Line 614:
 
===== Parameters =====
 
===== Parameters =====
 
* ''inst_id'': number
 
* ''inst_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''collection_info'': array of below elements
 
* ''collection_info'': array of below elements
Line 577: Line 639:
 
===== Parameters =====
 
===== Parameters =====
 
* ''inst_id'': number
 
* ''inst_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''types'': array of taxon_basic with below extensions
 
* ''types'': array of taxon_basic with below extensions
Line 593: Line 657:
 
===== Parameters =====
 
===== Parameters =====
 
* ''inst_id'': number
 
* ''inst_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''types'': array of taxon_basic with below extensions
 
* ''types'': array of taxon_basic with below extensions
Line 609: Line 675:
 
===== Parameters =====
 
===== Parameters =====
 
* ''inst_id'': number
 
* ''inst_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''taxa'': array of taxon_extended with below extension
 
* ''taxa'': array of taxon_extended with below extension
Line 622: Line 690:
 
===== Parameters =====
 
===== Parameters =====
 
* ''inst_id'': number
 
* ''inst_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''coll_trips'': array of taxon_basic with below extensions
 
* ''coll_trips'': array of taxon_basic with below extensions
Line 636: Line 706:
 
===== Parameters =====
 
===== Parameters =====
 
* ''inst_id'': number
 
* ''inst_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''pubs'': array of literature_basic
 
* ''pubs'': array of literature_basic
Line 648: Line 720:
 
===== Parameters =====
 
===== Parameters =====
 
* ''unv_id'': number
 
* ''unv_id'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''unvoucheredRecord'': array of ..
 
* ''unvoucheredRecord'': array of ..
Line 661: Line 735:
 
* ''showChildren'': string
 
* ''showChildren'': string
 
* ''pnids'': array of number
 
* ''pnids'': array of number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''unvoucheredRecords'': array of ..
 
* ''unvoucheredRecords'': array of ..
Line 673: Line 749:
 
* ''tnuid'': number
 
* ''tnuid'': number
 
* ''pnids'': array of number
 
* ''pnids'': array of number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
*  
 
*  
Line 688: Line 766:
 
* ''pnid'': number
 
* ''pnid'': number
 
* ''showChildren'': string
 
* ''showChildren'': string
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''locInfo'': array of ..
 
* ''locInfo'': array of ..
Line 702: Line 782:
 
* ''limit'': number
 
* ''limit'': number
 
* ''categoryLimit'': string
 
* ''categoryLimit'': string
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''taxon_results'':
 
* ''taxon_results'':
Line 720: Line 802:
 
* ''limit'': number
 
* ''limit'': number
 
* ''nameOnly'': string
 
* ''nameOnly'': string
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''taxa'': array of taxon_extended with below extensions
 
* ''taxa'': array of taxon_extended with below extensions
Line 735: Line 819:
 
* ''name'': string
 
* ''name'': string
 
* ''limit'': number
 
* ''limit'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''cuids'': array of cuid
 
* ''cuids'': array of cuid
Line 750: Line 836:
 
* ''limit'': number
 
* ''limit'': number
 
* ''includeParty'': string
 
* ''includeParty'': string
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''agents'':
 
* ''agents'':
Line 763: Line 851:
 
* ''name'': string
 
* ''name'': string
 
* ''limit'': number
 
* ''limit'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''inst'':
 
* ''inst'':
Line 776: Line 866:
 
* ''name'': string
 
* ''name'': string
 
* ''limit'': number
 
* ''limit'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''journals'':
 
* ''journals'':
Line 789: Line 881:
 
* ''name'': string
 
* ''name'': string
 
* ''limit'': number
 
* ''limit'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''orgs'':
 
* ''orgs'':
Line 802: Line 896:
 
* ''name'': string
 
* ''name'': string
 
* ''limit'': number
 
* ''limit'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''places'':  
 
* ''places'':  
Line 815: Line 911:
 
* ''name'': string
 
* ''name'': string
 
* ''limit'': number
 
* ''limit'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''locs'':
 
* ''locs'':
Line 828: Line 926:
 
* ''name'': string
 
* ''name'': string
 
* ''limit'': number
 
* ''limit'': number
−
* ''callback'': string
+
* ''format'': string
 +
* ''key'': string
 +
 
 
===== Return =====
 
===== Return =====
 
* ''coll_methods'':
 
* ''coll_methods'':

Revision as of 14:14, 1 July 2014

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.


Contents

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

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

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: boolean_flag
  • format: string
  • key: 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: boolean_flag
  • format: string
  • key: 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: boolean_flag
  • format: string
  • key: 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: boolean_flag
  • inst_id: number
  • pnids: array of pnid
  • format: string
  • key: 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
  • format: string
  • key: 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

Description
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 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=434&showSyns=F&inst_id=1&primary_only=Y&taxon_author_search=&offset=1&limit=10&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getInsts

Description
Parameters
  • tnuid: number
  • format: string
  • key: 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
  • format: string
  • key: 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: boolean_flag
  • format: string
  • key: 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

Description
Parameters
  • tnuid: number
  • rank_grouping: string
  • format: string
  • key: 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

Description
Parameters
  • tnuid: number
  • format: string
  • key: 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

Description
Parameters
  • tnuid: number
  • format: string
  • key: string
Return
  • media: array of media_basic (not yet added)
Example

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

getTaxonBreakdown

Description
Parameters
  • tnuid: number
  • format: string
  • key: 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

Description
Parameters
  • tnuid: number
  • format: string
  • key: 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

Description
Parameters
  • tnuid: number
  • validOnly: boolean_flag
  • format: string
  • key: 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

Description
Parameters
  • tnuid: number
  • validOnly: string
  • format: string
  • key: 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

Description
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

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

Occurrence / Specimen

getSpmInfo

Description
Parameters
  • cuid: string
  • format: string
  • key: string
Return
  • spmInfo: array of ..
Example

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

getSpmsInfo

Description
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

Description
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_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

Description
Parameters
  • place_id: number
  • format: string
  • key: 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

Description
Parameters
  • place_id: number
  • format: string
  • key: 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

Description
Parameters
  • place_id: number
  • format: string
  • key: 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

Description
Parameters
  • place_id: number
  • format: string
  • key: string
Return
  • coll_trips: array of loc_basic with below extension
    • collector class (not yet added)
Example

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

getGeoCollTrips2

Description
Parameters
  • place_id: number
  • format: string
  • key: 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

Description
Parameters
  • place_id: number
  • format: string
  • key: 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

Description
Parameters
  • pub_id: number
  • format: string
  • key: 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

Description
Parameters
  • pub_id: number
  • format: string
  • key: string
Return
  • pub_parts: array of ..
Example

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

getPubTaxonCitation

Description
Parameters
  • pub_id: number
  • format: string
  • key: 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

Description
Parameters
  • pub_id: number
  • format: string
  • key: string
Return
  • assoc_cits: array of ..
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getPubAssocCitation?pub_id=&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

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

getJournalPubs

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

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

Description
Parameters
  • inst_id: number
  • format: string
  • key: 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

Description
Parameters
  • inst_id: number
  • format: string
  • key: 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

Description
Parameters
  • inst_id: number
  • format: string
  • key: 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

Description
Parameters
  • inst_id: number
  • format: string
  • key: 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

Description
Parameters
  • inst_id: number
  • format: string
  • key: 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

Description
Parameters
  • inst_id: number
  • format: string
  • key: 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

Description
Parameters
  • unv_id: number
  • format: string
  • key: string
Return
  • unvoucheredRecord: array of ..
Example

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

getUnvoucheredRecords

Description
Parameters
  • tnuid: number
  • showChildren: string
  • pnids: array of number
  • format: string
  • key: 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

Description
Parameters
  • tnuid: number
  • pnids: array of number
  • format: string
  • key: string
Return
Example

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

getUnvLocalityInfo

Description
Parameters
  • loc_id: number
  • tnuid: number
  • per_id: number
  • pnid: number
  • showChildren: string
  • format: string
  • key: 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

Description
Parameters
  • name: string
  • limit: number
  • categoryLimit: string
  • format: string
  • key: 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

Description
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

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

getCuidsFromText

Description
Parameters
  • name: string
  • limit: number
  • format: string
  • key: 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

Description
Parameters
  • name: string
  • limit: number
  • includeParty: string
  • format: string
  • key: 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

Description
Parameters
  • name: string
  • limit: number
  • format: string
  • key: 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

Description
Parameters
  • name: string
  • limit: number
  • format: string
  • key: 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

Description
Parameters
  • name: string
  • limit: number
  • format: string
  • key: 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

Description
Parameters
  • name: string
  • limit: number
  • format: string
  • key: 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

Description
Parameters
  • name: string
  • limit: number
  • format: string
  • key: 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

Description
Parameters
  • name: string
  • limit: number
  • format: string
  • key: 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

Retrieved from "https://xbiod.osu.edu/index.php?title=OJ_Break_API_Reference&oldid=947"