Difference between revisions of "OJ Break v2 Taxon Reference"

From xBio:D Wiki
Jump to navigation Jump to search
(Created page with "'''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 Obje...")
 
Line 10: Line 10:
 
Using the OJ_Break Version 2 API requires calling methods with corresponding, method specific parameters (found on this page) and a few other required parameters. These required parameters include specifying a return ''format'', an API access ''key'', and a ''version'' number.  
 
Using the OJ_Break Version 2 API requires calling methods with corresponding, method specific parameters (found on this page) and a few other required parameters. These required parameters include specifying a return ''format'', an API access ''key'', and a ''version'' number.  
  
−
     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentInfo?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+
     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInfo?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
Notice the specification of the ''version'' parameter at the end of the example method call. With the introduction of OJ_Break Version 2, the ''version'' parameter has a default value of ''2'' making the specification in the example unnecessary. To read more about using the OJ_Break Version 2 API, go to [[OJ_Break API Access]].
 
Notice the specification of the ''version'' parameter at the end of the example method call. With the introduction of OJ_Break Version 2, the ''version'' parameter has a default value of ''2'' making the specification in the example unnecessary. To read more about using the OJ_Break Version 2 API, go to [[OJ_Break API Access]].
Line 28: Line 28:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInfo?tnuid=30148&inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInfo?tnuid=30148&inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getTaxonHierarchy ====
 
==== getTaxonHierarchy ====
Line 41: Line 41:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonHierarchy?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonHierarchy?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getTaxonIncludedTaxa ====
 
==== getTaxonIncludedTaxa ====
Line 47: Line 47:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': ''tnuid''
 
* ''tnuid'': ''tnuid''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''inst_id'': ''inst_id'' (optional)
 
* ''inst_id'': ''inst_id'' (optional)
 
* ''show_syns'': Boolean_flag (optional)
 
* ''show_syns'': Boolean_flag (optional)
Line 59: Line 61:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonIncludedTaxa?tnuid=30148&inst_id=1&show_syns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonIncludedTaxa?tnuid=30148&inst_id=1&show_syns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getTaxonSynonyms ====
 
==== getTaxonSynonyms ====
Line 65: Line 67:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': ''tnuid''
 
* ''tnuid'': ''tnuid''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''show_fossils'': Boolean_flag (optional)
 
* ''show_fossils'': Boolean_flag (optional)
 
* ''format'': string
 
* ''format'': string
Line 73: Line 77:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonSynonyms?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonSynonyms?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getTaxonAssociations ====
 
==== getTaxonAssociations ====
Line 79: Line 83:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': ''tnuid''
 
* ''tnuid'': ''tnuid''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''rank_grouping'': ''rank'' (optional)
 
* ''rank_grouping'': ''rank'' (optional)
 
* ''format'': string
 
* ''format'': string
Line 87: Line 93:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonAssociations?tnuid=30148&rank=Genus&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonAssociations?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
−
==== getTaxonLiterature ====
+
==== getTaxonLiteratureCitations ====
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': ''tnuid''
 
* ''tnuid'': ''tnuid''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''show_syns'': Boolean_flag (optional)
 
* ''show_syns'': Boolean_flag (optional)
 
* ''format'': string
 
* ''format'': string
Line 98: Line 106:
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''TaxonReturnLiterature''
+
* ''TaxonReturnLiteratureCitations''
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLiterature?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLiteratureCitations?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getTaxonOccurrences ====
 
==== getTaxonOccurrences ====
Line 107: Line 115:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': ''tnuid''
 
* ''tnuid'': ''tnuid''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''show_children'': Boolean_flag (optional)
 
* ''show_children'': Boolean_flag (optional)
 
* ''inst_id'': ''inst_id'' (optional)
 
* ''inst_id'': ''inst_id'' (optional)
−
* ''place_ids'': array of ''place_id'' (optional)
+
* ''place_id'': ''place_id'' (optional)
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
Line 117: Line 127:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonOccurrences?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonOccurrences?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
−
 
 
−
==== getTaxonOccurrences ====
 
−
===== Description =====
 
−
===== Parameters =====
 
−
* ''tnuids'': array of ''tnuid''
 
−
* ''place_ids'': array of ''place_id'' (optional)
 
−
* ''format'': string
 
−
* ''key'': string
 
−
* ''version'': number
 
−
===== Return =====
 
−
* ''TaxonReturnOccurrences''
 
−
 
 
−
===== Example =====
 
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonOccurrences?tnuids=30148,491&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 
  
 
==== getTaxonTypes ====
 
==== getTaxonTypes ====
Line 137: Line 133:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': ''tnuid''
 
* ''tnuid'': ''tnuid''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''inst_id'': ''inst_id'' (optional)
 
* ''inst_id'': ''inst_id'' (optional)
 
* ''taxon_author_search'': string (optional)
 
* ''taxon_author_search'': string (optional)
Line 150: Line 148:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonTypes?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonTypes?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getTaxonLocalities ====
 
==== getTaxonLocalities ====
Line 156: Line 154:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': ''tnuid''
 
* ''tnuid'': ''tnuid''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''show_children'': Boolean_flag (optional)
 
* ''show_children'': Boolean_flag (optional)
 
* ''inst_id'': ''inst_id'' (optional)
 
* ''inst_id'': ''inst_id'' (optional)
Line 166: Line 166:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLocalities?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLocalities?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getTaxonDeterminers ====
 
==== getTaxonDeterminers ====
Line 172: Line 172:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': ''tnuid''
 
* ''tnuid'': ''tnuid''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 +
* ''inst_id'': ''inst_id'' (optional)
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
Line 179: Line 182:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonDeterminers?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonDeterminers?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getTaxonInstitutions ====
 
==== getTaxonInstitutions ====
Line 185: Line 188:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': ''tnuid''
 
* ''tnuid'': ''tnuid''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
Line 192: Line 197:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInstitutions?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInstitutions?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getTaxonHabitats ====
 
==== getTaxonHabitats ====
Line 198: Line 203:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': ''tnuid''
 
* ''tnuid'': ''tnuid''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
Line 205: Line 212:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonHabitats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonHabitats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getTaxonMedia ====
 
==== getTaxonMedia ====
Line 211: Line 218:
 
===== Parameters =====
 
===== Parameters =====
 
* ''tnuid'': ''tnuid''
 
* ''tnuid'': ''tnuid''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 +
* ''media_type'': ''media_type'' (optional)
 +
* ''inst_id'': ''inst_id'' (optional)
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
Line 218: Line 229:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonMedia?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonMedia?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
  

Revision as of 21:41, 15 January 2015

Introduction

OJ_Break is the name of the xBio:D RESTful API service to facilitate discovery of data within the xBio:D database. The API can respond with JavaScript Object Notation (JSON), XML, or JSON with padding (JSONP) and accepts HTTP GET and POST requests indiscriminately. The backend of the API is written in Oracle's PL/SQL database language, which is fast but often inflexible, while a Python presentation layer mitigates request handling and authentication.

OJ_Break Version 2 is a new and improved edition of the work started in Version 1. Version 2 introduces a completely restructured and standardized data model to further enhance the functionality of the xBio:D database.

API Information and Access

This page specifies the methods and data defined by OJ_Break Version 2, more precisely those that are defined by the Taxon data domain. To get information on any of the other data domains defined in OJ_Break Version 2, visit the See also section.

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

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

Notice the specification of the version parameter at the end of the example method call. With the introduction of OJ_Break Version 2, the version parameter has a default value of 2 making the specification in the example unnecessary. To read more about using the OJ_Break Version 2 API, go to OJ_Break API Access.

Procedural Reference

Taxon

getTaxonInfo

Description
Parameters
  • tnuid: tnuid
  • inst_id: inst_id (optional)
  • format: string
  • key: string
  • version: number
Return
  • TaxonComplete
Example

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

getTaxonHierarchy

Description
Parameters
  • tnuid: tnuid
  • format: string
  • key: string
  • version: number
Return
  • TaxonReturnHierarchy
Example

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

getTaxonIncludedTaxa

Description
Parameters
  • tnuid: tnuid
  • offset: number (optional)
  • limit: number (optional)
  • inst_id: inst_id (optional)
  • show_syns: Boolean_flag (optional)
  • show_fossils: Boolean_flag (optional)
  • types_only: Boolean_flag (optional)
  • show_num_spms: Boolean_flag (optional)
  • format: string
  • key: string
  • version: number
Return
  • TaxonReturnIncluded
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonIncludedTaxa?tnuid=30148&inst_id=1&show_syns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxonSynonyms

Description
Parameters
  • tnuid: tnuid
  • offset: number (optional)
  • limit: number (optional)
  • show_fossils: Boolean_flag (optional)
  • format: string
  • key: string
  • version: number
Return
  • TaxonReturnSynonyms
Example

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

getTaxonAssociations

Description
Parameters
  • tnuid: tnuid
  • offset: number (optional)
  • limit: number (optional)
  • rank_grouping: rank (optional)
  • format: string
  • key: string
  • version: number
Return
  • TaxonReturnAssociations
Example

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

getTaxonLiteratureCitations

Description
Parameters
  • tnuid: tnuid
  • offset: number (optional)
  • limit: number (optional)
  • show_syns: Boolean_flag (optional)
  • format: string
  • key: string
  • version: number
Return
  • TaxonReturnLiteratureCitations
Example

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

getTaxonOccurrences

Description
Parameters
  • tnuid: tnuid
  • offset: number (optional)
  • limit: number (optional)
  • show_children: Boolean_flag (optional)
  • inst_id: inst_id (optional)
  • place_id: place_id (optional)
  • format: string
  • key: string
  • version: number
Return
  • TaxonReturnOccurrences
Example

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

getTaxonTypes

Description
Parameters
  • tnuid: tnuid
  • offset: number (optional)
  • limit: number (optional)
  • inst_id: inst_id (optional)
  • taxon_author_search: string (optional)
  • show_syns: Boolean_flag (optional)
  • primary_only: Boolean_flag (optional)
  • limit: number (optional)
  • offset: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • TaxonReturnOccurrences
Example

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

getTaxonLocalities

Description
Parameters
  • tnuid: tnuid
  • offset: number (optional)
  • limit: number (optional)
  • show_children: Boolean_flag (optional)
  • inst_id: inst_id (optional)
  • place_ids: array of place_id (optional)
  • format: string
  • key: string
  • version: number
Return
  • TaxonReturnLocalities
Example

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

getTaxonDeterminers

Description
Parameters
  • tnuid: tnuid
  • offset: number (optional)
  • limit: number (optional)
  • inst_id: inst_id (optional)
  • format: string
  • key: string
  • version: number
Return
  • TaxonReturnDeterminers
Example

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

getTaxonInstitutions

Description
Parameters
  • tnuid: tnuid
  • offset: number (optional)
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • TaxonReturnInstitutions
Example

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

getTaxonHabitats

Description
Parameters
  • tnuid: tnuid
  • offset: number (optional)
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • TaxonReturnHabitats
Example

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

getTaxonMedia

Description
Parameters
  • tnuid: tnuid
  • offset: number (optional)
  • limit: number (optional)
  • media_type: media_type (optional)
  • inst_id: inst_id (optional)
  • format: string
  • key: string
  • version: number
Return
  • TaxonReturnMedia
Example

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


See also

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

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