OJ Break v2 Institution Reference - Revision history

Jcora: /* API Information and Access */

2015-06-09T16:35:41Z

‎API Information and Access

Tyler at 17:07, 27 April 2015

2015-04-27T17:07:36Z

Tyler: /* API Information and Access */

2015-04-22T20:34:06Z

‎API Information and Access

Tyler at 20:25, 22 April 2015

2015-04-22T20:25:25Z

Tyler: /* Elements */

2015-04-21T14:45:28Z

‎Elements

Tyler: /* InstitutionBasic */

2015-04-21T14:44:09Z

‎InstitutionBasic

Tyler: /* Institution */

2015-04-20T19:55:25Z

‎Institution

Tyler: /* InstitutionStats */

2015-04-20T19:33:55Z

‎InstitutionStats

Tyler at 19:32, 20 April 2015

2015-04-20T19:32:46Z

Tyler: /* See also */

2015-04-16T21:33:37Z

‎See also

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

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

@@ Line 141: / Line 141: @@
 === Elements ===
 ==== guid ====
-String
+GUID - Globablly Unique Identifier which uniquely identifies a resource.
 ==== inst_code ====
 String - the unique identifier of a particular institution, usually present for specimen cataloguing.

@@ 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/getInstitutionInfo?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionInfo?inst_id=1&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 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 27: / Line 27: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionInfo?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionInfo?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getInstitutionLiterature ====
@@ Line 42: / Line 42: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionLiterature?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionLiterature?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getInstitutionTaxa ====
@@ Line 57: / Line 57: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionTaxa?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionTaxa?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getInstitutionOccurrences ====
@@ Line 73: / Line 73: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionOccurrences?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionOccurrences?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getInstitutionPrimaryTypes ====
@@ Line 89: / Line 89: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionPrimaryTypes?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionPrimaryTypes?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getInstitutionSecondaryTypes ====
@@ Line 105: / Line 105: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionSecondaryTypes?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionSecondaryTypes?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 == Institution Data Type Glossary ==

@@ Line 140: / Line 140: @@
 === Elements ===
 ==== inst_code ====
 String - the unique identifier of a particular institution, usually present for specimen cataloguing.

@@ Line 111: / Line 111: @@
 ==== InstitutionBasic ====
 * ''inst_id'': ''[[#inst_id|inst_id]]''
-* ''guid'': ''guid''
+* ''guid'': ''[[#guid|guid]]''
 * ''inst_name'': ''[[#inst_name|inst_name]]''
 * ''inst_code'': ''[[#inst_code|inst_code]]''

@@ Line 137: / Line 137: @@
 * ''num_primary_types'': Number
 * ''num_secondary_types'': Number
-* ''oldest_spm'': [[OJ_Break v2 Occurrence Reference#OccurrenceExtended|OccurrenceExtended]]
+* ''oldest_spm'': [[OJ_Break v2 Occurrence Reference#OccurrenceExtended (extends OccurrenceBasic)|OccurrenceExtended]]
 * ''last_spm_time'': Datetime

@@ Line 24: / Line 24: @@
 * ''version'': number
 ===== Return =====
-* [[#LiteratureExtended_.28extends_InstitutionBasic.29|InstitutionExtended]]
+* [[#LiteratureExtended (extends InstitutionBasic)|InstitutionExtended]]
 ===== Example =====
@@ Line 39: / Line 39: @@
 * ''version'': number
 ===== Return =====
-* [[#InstitutionReturnLiterature_.28extends_InstitutionReturn.29|InstitutionReturnLiterature]]
+* [[#InstitutionReturnLiterature (extends InstitutionReturn)|InstitutionReturnLiterature]]
 ===== Example =====
@@ Line 54: / Line 54: @@
 * ''version'': number
 ===== Return =====
-* [[#InstitutionReturnTaxa_.28extends_InstitutionReturn.29|InstitutionReturnTaxa]]
+* [[#InstitutionReturnTaxa (extends InstitutionReturn)|InstitutionReturnTaxa]]
 ===== Example =====
@@ Line 70: / Line 70: @@
 * ''version'': number
 ===== Return =====
-* [[#InstitutionReturnOccurrences_.28extends_InstitutionReturn.29|InstitutionReturnOccurrences]]
+* [[#InstitutionReturnOccurrences (extends InstitutionReturn)|InstitutionReturnOccurrences]]
 ===== Example =====
@@ Line 86: / Line 86: @@
 * ''version'': number
 ===== Return =====
-* [[#InstitutionReturnOccurrences_.28extends_InstitutionReturn.29|InstitutionReturnOccurrences]]
+* [[#InstitutionReturnOccurrences extends InstitutionReturn)|InstitutionReturnOccurrences]]
 ===== Example =====
@@ Line 102: / Line 102: @@
 * ''version'': number
 ===== Return =====
-* [[#InstitutionReturnOccurrences_.28extends_InstitutionReturn.29|InstitutionReturnOccurrences]]
+* [[#InstitutionReturnOccurrences (extends InstitutionReturn)|InstitutionReturnOccurrences]]
 ===== Example =====
@@ Line 121: / Line 121: @@
 ==== InstitutionReturnLiterature (extends [[#InstitutionReturn|InstitutionReturn]]) ====
-* ''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]]
 ==== InstitutionReturnOccurrences (extends [[#InstitutionReturn|InstitutionReturn]]) ====
-* ''occurrences'': array of [[OJ_Break v2 Occurrence Reference#OccurrenceExtended_.28extends_OccurrenceBasic.29|OccurrenceExtended]]
+* ''occurrences'': array of [[OJ_Break v2 Occurrence Reference#OccurrenceExtended (extends OccurrenceBasic)|OccurrenceExtended]]
 ==== InstitutionReturnTaxa (extends [[#InstitutionReturn|InstitutionReturn]]) ====
-* ''taxa'': array of [[#TaxonRelationship_.28extends_TaxonExtended.29|TaxonRelationship]]
+* ''taxa'': array of [[#TaxonRelationship (extends TaxonExtended)|TaxonRelationship]]
 ==== InstitutionReturn ====

@@ Line 158: / Line 158: @@
 * [[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]]