OJ Break v2 Literature Reference - Revision history

Jcora: /* API Information and Access */

2015-06-09T16:37:05Z

‎API Information and Access

Tyler: /* Elements */

2015-04-27T17:23:01Z

‎Elements

Tyler at 20:27, 22 April 2015

2015-04-22T20:27:19Z

Tyler: /* Literature */

2015-04-20T19:57:27Z

‎Literature

Tyler at 19:41, 20 April 2015

2015-04-20T19:41:30Z

Tyler: /* See also */

2015-04-16T21:34:56Z

‎See also

Tyler: /* pub_month = */

2015-04-15T21:27:10Z

‎pub_month =

Tyler: /* Literature Data Type Glossary */

2015-04-15T19:48:32Z

‎Literature Data Type Glossary

Tyler at 19:46, 15 April 2015

2015-04-15T19:46:50Z

Tyler: /* doi */

2015-02-16T21:06:21Z

‎doi

← Older revision		Revision as of 16:37, 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 - Literature.png\|none\|frame\|Literature Data Model]]

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

@@ Line 178: / Line 178: @@
 === Elements ===
 ==== annotation ====
-String -
+String - Comments associated with the journal.
 ==== citation_id ====
-Number -
+Number - A unique identifier given to a citation.
 ==== doi ====
 DOI - The digital object identifier (DOI) assigned to a publication.
 ==== pub_id ====
 Number - The publication identifier which uniquely identifies a publication.

@@ 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/getLiteratureInfo?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureInfo?pub_id=234&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: @@
 * [[#LiteratureCitationBasic|LiteratureCitationBasic]]
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getCitationInfo?citation_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getCitationInfo?citation_id=234&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getLiteratureInfo ====
 ===== Description =====
@@ Line 38: / Line 38: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureInfo?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureInfo?pub_id=234&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getLiteratureParts ====
@@ Line 53: / Line 53: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureParts?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureParts?pub_id=234&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getLiteratureTaxonCitations ====
@@ Line 68: / Line 68: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureTaxonCitations?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureTaxonCitations?pub_id=234&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getLiteratureAssocCitations ====
@@ Line 84: / Line 84: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureAssocCitations?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureAssocCitations?pub_id=234&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 == Literature Data Type Glossary ==

@@ Line 26: / Line 26: @@
 * [[#LiteratureCitationBasic|LiteratureCitationBasic]]
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getCitationInfo?citation_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+ http://osuc.biosci.ohio-state.edu/OJ_Break/getCitationInfo?citation_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getLiteratureInfo ====
 ===== Description =====
@@ Line 38: / Line 38: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureInfo?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+ http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureInfo?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getLiteratureParts ====
@@ Line 53: / Line 53: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureParts?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+ http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureParts?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getLiteratureTaxonCitations ====
@@ Line 68: / Line 68: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureTaxonCitations?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+ http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureTaxonCitations?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getLiteratureAssocCitations ====
@@ Line 84: / Line 84: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureAssocCitations?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+ http://osuc.biosci.ohio-state.edu/OJ_Break/getLiteratureAssocCitations?pub_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 == Literature Data Type Glossary ==

@@ Line 35: / Line 35: @@
 * ''version'': number
 ===== Return =====
-* [[#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]
+* [[#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]
 ===== Example =====
@@ Line 50: / Line 50: @@
 * ''version'': number
 ===== Return =====
-* [[#LiteratureReturnParts_.28extends_LiteratureReturn.29|LiteratureReturnParts]]
+* [[#LiteratureReturnParts (extends LiteratureReturn)|LiteratureReturnParts]]
 ===== Example =====
@@ Line 65: / Line 65: @@
 * ''version'': number
 ===== Return =====
-* [[#LiteratureReturnTaxonCitation_.28extends_LiteratureReturn.29|LiteratureReturnTaxonCitation]]
+* [[#LiteratureReturnTaxonCitation (extends LiteratureReturn)|LiteratureReturnTaxonCitation]]
 ===== Example =====
@@ Line 81: / Line 81: @@
 ===== Return =====
-* [[#LiteratureReturnAssociations_.28extends_LiteratureReturn.29|LiteratureReturnAssociations]]
+* [[#LiteratureReturnAssociations (extends LiteratureReturn)|LiteratureReturnAssociations]]
 ===== Example =====
@@ Line 88: / Line 88: @@
 == Literature Data Type Glossary ==
 === Classes ===
-==== LiteratureArticle (realizes [[#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]) ====
+==== LiteratureArticle (realizes [[#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]) ====
 * ''journal_id'': ''[[OJ_Break v2 Journal Reference#journal_id|journal_id]]''
 * ''journal'': ''[[OJ_Break v2 Journal Reference#journal_name|journal_name]]''
@@ Line 97: / Line 97: @@
 * ''end_page'': String
-==== LiteratureAssociationCitation (extends [[#LiteratureOccurrenceCitation_.28extends_LiteratureCitationBasic.29|LiteratureOccurrenceCitation]]) ====
+==== LiteratureAssociationCitation (extends [[#LiteratureOccurrenceCitation (extends LiteratureCitationBasic)|LiteratureOccurrenceCitation]]) ====
 * ''assoc_type'': ''[[OJ_Break v2 Taxon Reference#assoc_type|assoc_type]]''
 * ''assoc_type_full'': ''[[OJ_Break v2 Taxon Reference#assoc_type_full|assoc_type_full]]''
@@ Line 108: / Line 108: @@
 * ''pub_month'': ''[[#pub_month|pub_month]]''
-==== LiteratureBook (realizes [[#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]) ====
+==== LiteratureBook (realizes [[#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]) ====
 * ''publisher'': String
 * ''city'': String
 * ''num_pages'': String
-==== LiteratureBulletin (realizes [[#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]) ====
+==== LiteratureBulletin (realizes [[#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]) ====
 * ''journal_id'': ''[[OJ_Break v2 Journal Reference#journal_id|journal_id]]''
 * ''journal'': ''[[OJ_Break v2 Journal Reference#journal_name|journal_name]]''
@@ Line 122: / Line 122: @@
 * ''end_page'': String
-==== LiteratureChapter (realizes [[#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]) ====
+==== LiteratureChapter (realizes [[#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]) ====
-* ''book'': [[#LiteratureBook_.28realizes_LiteratureExtended.29|LiteratureBook]]
+* ''book'': [[#LiteratureBook (realizes LiteratureExtended)|LiteratureBook]]
 * ''chap_num'': String
 * ''start_page'': String
 * ''end_page'': String
-==== LiteratureContribution (realizes [[#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]) ====
+==== LiteratureContribution (realizes [[#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]) ====
-* ''source'': [[#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]
+* ''source'': [[#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]
 ==== LiteratureCitationBasic ====
@@ Line 136: / Line 136: @@
 ==== LiteratureCitationExtended (extends [[#LiteratureCitationBasic|LiteratureCitationBasic]]) ====
-* ''pub'': [[#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]
+* ''pub'': [[#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]
 ==== LiteratureExtended (extends [[#LiteratureBasic|LiteratureBasic]]) ====
-* ''pub_author'': [[OJ_Break v2 Agent Reference#AgentExtended_.28extends_AgentBasic.29|AgentExtended]]
+* ''pub_author'': [[OJ_Break v2 Agent Reference#AgentExtended (extends AgentBasic)|AgentExtended]]
 * ''pub_title'': ''[[#pub_title|pub_title]]''
 * ''doi'': ''[[#doi|doi]]''
@@ Line 145: / Line 145: @@
 ==== LiteratureOccurrenceCitation (extends [[#LiteratureCitationBasic|LiteratureCitationBasic]]) ====
-* ''occurrence'': [[OJ_Break v2 Occurrence Reference#OccurrenceExtended_.28extends_OccurrenceBasic.29|OccurrenceExtended]]
+* ''occurrence'': [[OJ_Break v2 Occurrence Reference#OccurrenceExtended (extends OccurrenceBasic)|OccurrenceExtended]]
 ==== LiteraturePDF ====
@@ Line 161: / Line 161: @@
 ==== LiteratureReturnAssociations (extends [[#LiteratureReturn|LiteratureReturn]]) ====
-* ''assoc_citations'': array of [[#LiteratureAssociationCitation_.28extends_LiteratureOccurrenceCitation.29|LiteratureAssociationCitation]]
+* ''assoc_citations'': array of [[#LiteratureAssociationCitation (extends LiteratureOccurrenceCitation)|LiteratureAssociationCitation]]
 ==== LiteratureReturnParts (extends [[#LiteratureReturn|LiteratureReturn]]) ====
-* ''pub_parts'': array of [[#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]
+* ''pub_parts'': array of [[#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]
 ==== LiteratureReturnTaxonCitation (extends [[#LiteratureReturn|LiteratureReturn]]) ====
-* ''pub_citations'': array of [[#LiteratureTaxonCitation_.28extends_LiteratureCitationBasic.29|LiteratureTaxonCitation]]
+* ''pub_citations'': array of [[#LiteratureTaxonCitation (extends LiteratureCitationBasic)|LiteratureTaxonCitation]]
 ==== LiteratureTaxonCitation (extends [[#LiteratureCitationBasic|LiteratureCitationBasic]]) ====
-* ''taxon'': [[OJ_Break v2 Taxon Reference#TaxonRelationship_.28extends_TaxonExtended.29|TaxonRelationship]]
+* ''taxon'': [[OJ_Break v2 Taxon Reference#TaxonRelationship (extends TaxonExtended)|TaxonRelationship]]
 * ''annotation'': ''[[#annotation|annotation]]''
-==== LiteratureTaxonCitationExtended (extends [[#LiteratureTaxonCitation_.28extends_LiteratureCitationBasic.29|LiteratureTaxonCitation]]) ====
+==== LiteratureTaxonCitationExtended (extends [[#LiteratureTaxonCitation (extends LiteratureCitationBasic)|LiteratureTaxonCitation]]) ====
-* ''pub'': [[#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]
+* ''pub'': [[#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]
 === Elements ===

@@ Line 203: / Line 203: @@
 * [[OJ_Break v2 Journal Reference|Journal]]
 * [[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 189: / Line 189: @@
 ==== pub_year ====
 Number - The year the publication was published.
-==== pub_month =====
+==== pub_month ====
 Number - The month the publication was published.
 ==== public ====
 Boolean_flag - A Y or N indicator that signifies whether a journal is made public or not.

@@ Line 90: / Line 90: @@
 ==== LiteratureArticle (realizes [[#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]) ====
 * ''journal_id'': ''[[OJ_Break v2 Journal Reference#journal_id|journal_id]]''
-* ''journal'': ''journal''
+* ''journal'': ''[[OJ_Break v2 Journal Reference#journal_name|journal_name]]''
 * ''series'': String
 * ''volume'': String