OJ Break v2 Occurrence Reference - Revision history

Jcora: /* API Information and Access */

2015-06-09T16:39:04Z

‎API Information and Access

Tyler: /* Elements */

2015-04-27T17:58:57Z

‎Elements

Tyler: /* Elements */

2015-04-27T17:56:05Z

‎Elements

Tyler at 20:29, 22 April 2015

2015-04-22T20:29:29Z

Tyler at 14:42, 21 April 2015

2015-04-21T14:42:10Z

Tyler: /* Occurrence */

2015-04-20T19:59:08Z

‎Occurrence

Tyler: /* DeterminationBasic */

2015-04-20T19:19:41Z

‎DeterminationBasic

Tyler: /* OccurrenceTrimmed (extends OccurrenceBasic) */

2015-04-20T19:18:02Z

‎OccurrenceTrimmed (extends OccurrenceBasic)

Tyler: /* Occurrence Data Type Glossary */

2015-04-20T19:17:14Z

‎Occurrence Data Type Glossary

Tyler: /* CollectionOccurrence (realizes OccurrenceExtended) */

2015-04-20T19:13:59Z

‎CollectionOccurrence (realizes OccurrenceExtended)

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

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

@@ Line 137: / Line 137: @@
 String - An alternate identifier for the specimen.
 ==== assoc_type ====
-String - A description of the biological relationship between two organisms.
+String - A description of the biological relationship between a specified taxon and another organism.
 ==== assoc_type_full ====
-String - A full description of the biological relationship between two organisms.
+String - A complete description of the biological relationship between a specified taxon and another organism.
 ==== ceid ====
 Number -

@@ Line 135: / Line 135: @@
 === Elements ===
 ==== alt_id ====
-Number
+String - An alternate identifier for the specimen.
 ==== assoc_type ====
-String
+String - A description of the biological relationship between two organisms.
 ==== assoc_type_full ====
-String
+String - A full description of the biological relationship between two organisms.
 ==== ceid ====
-Number
+Number -
 ==== coll_date ====
-String
+String -
 ==== coll_date_sortable ====
-String
+String -
 ==== coll_id ====
-Number
+Number -
 ==== coll_method ====
 String
 ==== comments ====
-String
+String -
 ==== date_recorded ====
 String
@@ Line 173: / Line 173: @@
 String
 ==== guid ====
-String
+GUID - Globally Unique Identifier that uniquely identifies a resource.
 ==== habitat ====
 String

@@ 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/getOccurrenceInfo?occurrence_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getOccurrenceInfo?occurrence_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 27: / Line 27: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getOccurrenceInfo?occurrence_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getOccurrenceInfo?occurrence_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getOccurrencesInfo ====
@@ Line 40: / Line 40: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getOccurrencesInfo?occurrence_ids=1,2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getOccurrencesInfo?occurrence_ids=1,2&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 == Occurrence Data Type Glossary ==

@@ Line 171: / Line 171: @@
 String
 ==== field_code ====
 String
 ==== habitat ====

@@ Line 72: / Line 72: @@
 ==== DeterminationBasic ====
-* ''taxon'': [[OJ_Break v2 Taxon Reference#TaxonRelationship|TaxonRelationship]]
+* ''taxon'': [[OJ_Break v2 Taxon Reference#TaxonRelationship (extends TaxonExtended)|TaxonRelationship]]
 * ''determiner'': [[#OJ_Break v2 Agent Reference#AgentExtended (extends_AgentBasic)|AgentExtended]]
 ==== DeterminationExtended (extends [[#DeterminationBasic|DeterminationBasic]]) ====
 * ''det_id'': ''[[#det_id|det_id]]''

@@ Line 106: / Line 106: @@
 ==== OccurrenceTrimmed (extends [[#OccurrenceBasic|OccurrenceBasic]]) ====
 * ''alt_ids'': array of ''alt_id''
-* ''institution'': [[InstitutionBasic]]
+* ''institution'': [[OJ_Break v2 Institution Reference#InstitutionBasic|InstitutionBasic]]
 * ''determination'': [[#DeterminationBasic|DeterminationBasic]]
 ==== Preparation ====
 * ''prep_type'': ''[[#prep_type|prep_type]]''

@@ Line 65: / Line 65: @@
 * ''coll_time'': ''[[#CollectingTime|CollectingTime]]
 * ''field_code'': ''[[#field_code|field_code]]''
-* ''determinations'': array of [[#DeterminationExtended_.28extends_DeterminationBasic.29|DeterminationExtended]]
+* ''determinations'': array of [[#DeterminationExtended (extends DeterminationBasic)|DeterminationExtended]]
 * ''media'': array of [[#MediaExtended|MediaExtended]]
 * ''sequences'': array of [[#Sequence|Sequence]]
@@ Line 73: / Line 73: @@
 ==== DeterminationBasic ====
 * ''taxon'': [[OJ_Break v2 Taxon Reference#TaxonRelationship|TaxonRelationship]]
-* ''determiner'': [[#OJ_Break v2 Agent Reference#AgentExtended_.28extends_AgentBasic.29|AgentExtended]]
+* ''determiner'': [[#OJ_Break v2 Agent Reference#AgentExtended (extends_AgentBasic)|AgentExtended]]
 ==== DeterminationExtended (extends [[#DeterminationBasic|DeterminationBasic]]) ====
 * ''det_id'': ''[[#det_id|det_id]]''
@@ Line 81: / Line 81: @@
 * ''occurrence_coll_id'': ''[[#occurrence_coll_id|occurrence_coll_id]]''
 * ''coll_id'': ''[[#coll_id|coll_id]]''
-==== NoncollectionOccurrence (realizes [[#OccurrenceExtended_.28extends_OccurrenceBasic.29|OccurrenceExtended]]) ====
+==== NoncollectionOccurrence (realizes [[#OccurrenceExtended (extends OccurrenceBasic)|OccurrenceExtended]]) ====
 * ''num_spms'': Number
 * ''determination'': [[#DeterminationBasic|DeterminationBasic]]
-==== OccurrenceAssociation (extends [[#OccurrenceTrimmed_.28extends_OccurrenceBasic.29|OccurrenceTrimmed]]) ====
+==== OccurrenceAssociation (extends [[#OccurrenceTrimmed (extends OccurrenceBasic)|OccurrenceTrimmed]]) ====
 * ''assoc_type'': ''[[#assoc_type|assoc_type]]''
 * ''assoc_type_full'': ''[[#assoc_type_full|assoc_type_full]]''
@@ Line 94: / Line 94: @@
 * ''unvouchered'': ''[[#unvouchered|unvouchered]]''
 ==== OccurrenceExtended (extends [[#OccurrenceBasic|OccurrenceBasic]]) ====
-* ''locality'': [[OJ_Break v2 Locality Reference#LocalityExtended_.28extends_LocalityBasic.29|LocalityExtended]]
+* ''locality'': [[OJ_Break v2 Locality Reference#LocalityExtended (extends LocalityBasic)|LocalityExtended]]
 * ''coll_date'': [[#CollectingDate|CollectingDate]]
 * ''coll_method'': [[#coll_method|coll_method]]
-* ''collector'': [[OJ_Break v2 Agent Reference#AgentExtended_.28extends_AgentBasic.29|AgentExtended]]
+* ''collector'': [[OJ_Break v2 Agent Reference#AgentExtended (extends AgentBasic)|AgentExtended]]
 * ''habitat'': ''[[#habitat|habitat]]''
 * ''associations'': array of [[#OccurrenceAssociation|OccurrenceAssociation]]
 * ''comments'': ''[[#comments|comments]]''
-* ''orig_citation'': [[OJ_Break v2 LiteratureCitationExtended_.28extends_LiteratureCitationBasic.29#LiteratureCitationExtended|LiteratureCitationExtended]]
+* ''orig_citation'': [[OJ_Break v2 Literature Reference#LiteratureCitationExtended (extends LiteratureCitationBasic)|LiteratureCitationExtended]]
 * ''enterer'': ''[[#enterer|enterer]]''
 * ''last_update'': ''[[#last_update|last_update]]''
@@ Line 206: / Line 206: @@
 ==== vouchered ====
 Boolean_flag
 == See also ==

@@ Line 57: / Line 57: @@
 * ''start_time'': ''[[#start_time|start_time]]''
 * ''end_time'': ''[[#end_time|end_time]]''
-==== CollectionOccurrence (realizes [[OccurrenceExtended_.28extends_OccurrenceBasic.29|OccurrenceExtended]]) ====
+==== CollectionOccurrence (realizes [[#OccurrenceExtended (extends OccurrenceBasic)|OccurrenceExtended]]) ====
 * ''occurrence_type'': ''[[#occurrence_type|occurrence_type]]''
 * ''alt_ids'': array of ''[[#alt_id|alt_id]]''