Difference between revisions of "OJ Break v2 Agent 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 6: Line 6:
  
 
== API Information and Access ==
 
== 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 '''Agent''' data domain. 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.  
+
This page specifies the methods and data defined by OJ_Break Version 2, more precisely those that are defined by the '''Agent''' data domain. To get information on any of the other data domains defined in OJ_Break Version 2, visit the [[OJ_Break v2 Agent Reference#See_Also 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/getAgentInfo?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 
     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentInfo?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
Line 67: Line 67:
 
===== Example =====
 
===== Example =====
 
http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentOccurrences?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 
http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentOccurrences?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 +
 +
== See also ==
 +
Visit any of the below links to find information about the other data domains defined by OJ_Break Version 2.
 +
 +
* [[OJ_Break v2 Geographic Place Reference|Geographic Place]]
 +
* [[OJ_Break v2 Institution Reference|Institution]]
 +
* [[OJ_Break v2 Journal Reference|Journal]]
 +
* [[OJ_Break v2 Literature Reference|Literature]]
 +
* [[OJ_Break v2 Locality Reference|Locality]]
 +
* [[OJ_Break v2 Media Reference|Media]]
 +
* [[OJ_Break v2 Occurrence Reference|Occurrence]]
 +
* [[OJ_Break v2 Search Reference|Search]]
 +
* [[OJ_Break v2 Taxon Reference|Taxon]]

Revision as of 16:35, 5 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 Agent data domain. To get information on any of the other data domains defined in OJ_Break Version 2, visit the OJ_Break v2 Agent Reference#See_Also 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/getAgentInfo?agent_id=2&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

Agent

getAgentInfo

Description
Parameters
  • agent_id: number
  • format: string
  • key: string
  • version: number
Return
  • AgentComplete
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentInfo?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

getAgentLiterature

Description
Parameters
  • agent_id: number
  • format: string
  • key: string
  • version: number
Return
  • AgentReturnLiterature
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentLiterature?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC


getAgentTaxa

Description
Parameters
  • agent_id: number
  • format: string
  • key: string
  • version: number
Return
  • AgentReturnTaxa
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentTaxa?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC


getAgentOccurrences

Description
Parameters
  • agent_id: number
  • format: string
  • key: string
  • version: number
Return
  • AgentReturnOccurrences
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentOccurrences?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

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_Agent_Reference&oldid=1645"