OJ Break Version 2 API Reference - Revision history

Nfj: Updated the url to now point to the new server

2018-07-09T14:59:35Z

Updated the url to now point to the new server

2015-06-09T16:27:54Z

2015-06-09T16:27:38Z

2015-06-05T19:03:30Z

2015-04-16T20:30:34Z

‎Data Domains

2015-04-13T16:09:24Z

2015-04-06T16:30:47Z

2015-03-19T16:22:17Z

2015-01-14T22:38:28Z

2015-01-06T15:53:33Z

@@ Line 9: / Line 9: @@
 This page specifies the methods and data defined by OJ_Break Version 2. Using the OJ_Break Version 2 API requires calling methods with corresponding, method specific parameters (found in linked pages) and a few other required parameters. These include specifying a return ''format'', an API access ''key'', and a ''version'' number.
-     Example: http://xbiod.osu.edu/OJ_Break/getTaxonInfo?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+     Example: https://osuc.biosci.ohio-state.edu/cgi-bin/OJ_Break_API.py/getTaxonInfo?tnuid=30148&format=html&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]].

@@ Line 16: / Line 16: @@
 The API calls for version 2 of the OJ_Break API are listed in the diagram below. The calls are organized into their respective data domains and present the available parameters and return class for each call.
-[[File:OJ_Break Data Model - Agent.png|none|frame|Agent Data Model]]
+[[File:OJ Break API Calls.png|none|frame|Complete Set of API Calls]]
 == Data Domains ==

@@ Line 16: / Line 16: @@
 The API calls for version 2 of the OJ_Break API are listed in the diagram below. The calls are organized into their respective data domains and present the available parameters and return class for each call.
-[[File:OJ Break API Calls.png|none|frame|Complete Set of API Calls]]
+[[File:OJ_Break Data Model - Agent.png|none|frame|Agent Data Model]]
 == Data Domains ==

@@ Line 9: / Line 9: @@
 This page specifies the methods and data defined by OJ_Break Version 2. Using the OJ_Break Version 2 API requires calling methods with corresponding, method specific parameters (found in linked pages) and a few other required parameters. These include specifying a return ''format'', an API access ''key'', and a ''version'' number.
-     Example: http://xbiod.osu.edu/OJ_Break/getTaxonInfo?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonInfo?tnuid=30148&format=html&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]].

@@ Line 26: / Line 26: @@
 * [[OJ_Break v2 Literature Reference|Literature]]
 * [[OJ_Break v2 Locality Reference|Locality]]
 * [[OJ_Break v2 Occurrence Reference|Occurrence]]
 * [[OJ_Break v2 Search Reference|Search]]
 * [[OJ_Break v2 Taxon Reference|Taxon]]

@@ Line 1: / Line 1: @@
 '''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 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, simple HTML, 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.

← Older revision		Revision as of 16:30, 6 April 2015
Line 12:		Line 12:

	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]].
		+
		+	== API Calls ==
		+	The API calls for version 2 of the OJ_Break API are listed in the diagram below. The calls are organized into their respective data domains and present the available parameters and return class for each call.
		+
		+	[[File:OJ Break API Calls.png\|none\|frame\|Complete Set of API Calls]]

	== Data Domains ==		== Data Domains ==