OJ Break v2 Journal Reference - Revision history

Jcora: /* API Information and Access */

2015-06-09T16:36:31Z

‎API Information and Access

Tyler at 20:26, 22 April 2015

2015-04-22T20:26:31Z

Tyler: /* Journal */

2015-04-20T19:56:28Z

‎Journal

Tyler at 19:36, 20 April 2015

2015-04-20T19:36:50Z

Tyler: /* See also */

2015-04-16T21:34:09Z

‎See also

Tyler: /* Elements */

2015-02-11T20:26:37Z

‎Elements

Tyler: /* JournalReturnTaxa (JournalReturn) */

2015-02-11T20:12:16Z

‎JournalReturnTaxa (JournalReturn)

Tyler: /* Return */

2015-02-11T20:11:25Z

‎Return

Tyler: /* JournalComplete (extends JournalExtended) */

2015-02-11T20:09:48Z

‎JournalComplete (extends JournalExtended)

Tyler at 20:09, 11 February 2015

2015-02-11T20:09:00Z

← Older revision		Revision as of 16:36, 9 June 2015
Line 13:		Line 13:

	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]].
		+
		+
		+	[[File:OJ_Break Data Model - Journal.png\|none\|frame\|Journal Data Model]]

	== Procedural Reference ==		== Procedural Reference ==

@@ 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 HTML, 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.
@@ 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.
-     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalInfo?journal_id=33&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalInfo?journal_id=33&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 27: / Line 27: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalInfo?journal_id=33&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalInfo?journal_id=33&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getJournalLiterature ====
@@ Line 42: / Line 42: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalLiterature?journal_id=33&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalLiterature?journal_id=33&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getJournalTaxa ====
@@ Line 57: / Line 57: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalTaxa?journal_id=33&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalTaxa?journal_id=33&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 == Journal Data Type Glossary ==

@@ Line 27: / Line 27: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalInfo?journal_id=33&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+ http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalInfo?journal_id=33&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getJournalLiterature ====
@@ Line 42: / Line 42: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalLiterature?journal_id=33&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+ http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalLiterature?journal_id=33&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getJournalTaxa ====
@@ Line 57: / Line 57: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalTaxa?journal_id=33&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+ http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalTaxa?journal_id=33&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 == Journal Data Type Glossary ==

@@ Line 39: / Line 39: @@
 * ''version'': number
 ===== Return =====
-* [[#JournalReturnLiterature_.28extends_JournalReturn.29|JournalReturnLiterature]]
+* [[#JournalReturnLiterature (extends JournalReturn)|JournalReturnLiterature]]
 ===== Example =====
@@ Line 54: / Line 54: @@
 * ''version'': number
 ===== Return =====
-* [[#JournalReturnTaxa_.28extends_JournalReturn.29|JournalReturnTaxa]]
+* [[#JournalReturnTaxa (extends JournalReturn)|JournalReturnTaxa]]
 ===== Example =====
@@ Line 66: / Line 66: @@
 * ''journal_abbrev'': [[#journal_abbrev|journal_abbrev]]
-==== JournalComplete (extends [[#JournalExtended_.28extends_JournalBasic.29|JournalExtended]]) ====
+==== JournalComplete (extends [[#JournalExtended (extends JournalBasic)|JournalExtended]]) ====
 * ''stats'': [[#JournalStats|JournalStats]]
@@ Line 78: / Line 78: @@
 ==== JournalReturnLiterature (extends [[#JournalReturn|JournalReturn]]) ====
-* ''literature'': array of [[#OJ_Break v2 Literature Reference#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]
+* ''literature'': array of [[#OJ_Break v2 Literature Reference#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]
 ==== JournalReturnTaxa (extends [[#JournalReturn|JournalReturn]]) ====
-* ''taxa'': array of [[OJ_Break v2 Taxon Reference#TaxonRelationship_.28extends_TaxonExtended.29|TaxonRelationship]]
+* ''taxa'': array of [[OJ_Break v2 Taxon Reference#TaxonRelationship (extends TaxonExtended)|TaxonRelationship]]
 ==== JournalStats ====

@@ Line 111: / Line 111: @@
 * [[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 91: / Line 91: @@
 === Elements ===
 ==== journal_id ====
-Number -
+Number - A numeric journal identifier that uniquely identifies a journal.
 ==== journal_name ====
-String -
+String - A journal name string.
 ==== journal_abbrev ====
-String -
+String - A abbreviated journal name string.
 ==== journal_url ====
-URL -
+URL - A URL to a journal.
 ==== journal_copyright ====
-String -
+String - Copyright details for a journal.
 ==== public ====
-Boolean_flag -
+Boolean_flag - A Y or N indicator that signifies whether a journal is made public or not.
 == See also ==

@@ Line 77: / Line 77: @@
 * ''general'': [[#JournalBasic|JournalBasic]]
-==== JournalReturnLiterature (extends [[#JournalReturn|JournalReturn]] ====
+==== JournalReturnLiterature (extends [[#JournalReturn|JournalReturn]]) ====
 * ''literature'': array of [[#OJ_Break v2 Literature Reference#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]
-==== JournalReturnTaxa [[#JournalReturn|JournalReturn]] ====
+==== JournalReturnTaxa ([[#JournalReturn|JournalReturn]]) ====
 * ''taxa'': array of [[OJ_Break v2 Taxon Reference#TaxonRelationship_.28extends_TaxonExtended.29|TaxonRelationship]]