OJ Break API Reference - Revision history

Nfj: Updated the page to point to the new api urls.

2018-07-09T14:57:34Z

Updated the page to point to the new api urls.

2015-04-06T16:21:00Z

2015-04-06T16:20:40Z

2014-12-29T16:15:56Z

‎API Information and Access

2014-12-29T16:15:23Z

‎API Use and Access

2014-12-29T16:12:01Z

2014-12-18T16:34:28Z

‎Example

2014-11-24T21:44:53Z

‎Agent

2014-11-19T21:24:26Z

‎Parameters

2014-11-19T21:18:27Z

‎Return

← Older revision		Revision as of 16:21, 6 April 2015
Line 2:		Line 2:

	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, 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]]		The reference for version 2 of the API can be found here: [[OJ_Break_Version_2_API_Reference]]

← Older revision		Revision as of 16:20, 6 April 2015
Line 2:		Line 2:

	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, 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]]

@@ Line 5: / Line 5: @@
 == API Information and Access ==
-This page specifies the methods and data defined by OJ_Break Version 1.
+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: http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC

← Older revision		Revision as of 16:15, 29 December 2014
Line 4:		Line 4:


−	== API ~~Use~~ and 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''.		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''.

@@ Line 5: / Line 5: @@
 == API Use and 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''.
+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: 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]].
+To read more about using the OJ_Break Version 1 API, go to [[OJ_Break API Access]].
 == Procedural Reference ==

@@ Line 665: / Line 665: @@
 * ''assoc_cits'': array of ..
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getPubAssocCitation?pub_id=&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+http://osuc.biosci.ohio-state.edu/OJ_Break/getPubAssocCitation?pub_id=23683&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 === Journal ===

@@ Line 23: / Line 23: @@
 ===== Example =====
+http://osuc.biosci.ohio-state.edu/OJ_Break/getCollectorInfo?collector_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getAuthorPubs ====
@@ Line 35: / Line 35: @@
 ===== Example =====
+http://osuc.biosci.ohio-state.edu/OJ_Break/getAuthorPubs?author_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getCollTrips2 ====
@@ Line 47: / Line 47: @@
 ===== Example =====
+http://osuc.biosci.ohio-state.edu/OJ_Break/getCollTrips2?collector_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 ==== getAuthorTaxa ====
@@ Line 60: / Line 60: @@
 ===== Example =====
 === Taxon ===
 ==== getTaxonStats ====

@@ Line 52: / Line 52: @@
 ===== Description =====
 ===== Parameters =====
-''author_id'': number
+* ''author_id'': number
-''format'': string
+* ''format'': string
-''key'': string
+* ''key'': string
 ===== Return =====