OJ Break v2 Taxon Reference - Revision history

Tyler: /* TaxonReturnIncluded (extends TaxonReturn) */

2015-09-25T13:44:25Z

‎TaxonReturnIncluded (extends TaxonReturn)

Jcora: /* TaxonRelationship (extends TaxonExtended) */

2015-06-19T22:46:49Z

‎TaxonRelationship (extends TaxonExtended)

Jcora: /* Elements */

2015-06-19T15:22:44Z

‎Elements

Jcora: /* TaxonBasic */

2015-06-19T15:18:12Z

‎TaxonBasic

Jcora: /* API Information and Access */

2015-06-09T16:40:04Z

‎API Information and Access

Tyler at 20:32, 22 April 2015

2015-04-22T20:32:36Z

Tyler at 20:21, 22 April 2015

2015-04-22T20:21:52Z

Tyler at 19:53, 20 April 2015

2015-04-20T19:53:17Z

Show changes

Tyler: /* Procedural Reference */

2015-04-16T21:40:16Z

‎Procedural Reference

Tyler: /* Example */

2015-04-16T21:39:28Z

‎Example

@@ Line 374: / Line 374: @@
 ==== TaxonReturnIncluded (extends [[#TaxonReturn|TaxonReturn]]) ====
-* ''includedTaxa'': array of [[#TaxonExtended (extends TaxonBasic)|AgentExtended]]
+* ''includedTaxa'': array of [[#TaxonExtended (extends TaxonBasic)|TaxonExtended]]
 ==== TaxonReturnInstitutions (extends [[#TaxonReturn|TaxonReturn]]) ====

@@ Line 358: / Line 358: @@
 ==== TaxonRelationship (extends [[#TaxonExtended (extends TaxonBasic)|TaxonExtended]]) ====
 * ''rel_type'': ''[[#rel_type|rel_type]]''
-* ''parent_taxon'': [[#TaxonBasic|TaxonBasic]]
+* ''parent_taxon'': [[#TaxonExtended|TaxonBasic]]
 * ''hier'': [[#TaxonHierarchy|TaxonHierarchy]]

@@ Line 416: / Line 416: @@
 String - the describer(s) of a taxon.
 ==== fossil ====
 String - A modified boolean_flag, either Y, N or B, representing whether a taxon name is a extinct fossil, exclusively extant, or present today and in fossils.
 ==== habitat ====
 String - Description or identifier of the ecological or environmental area that a particular species is known to inhabit.
@@ Line 426: / Line 428: @@
 Number - A number representing the rank of a taxon with higher numbers representing higher positions in the taxonomic hierarchy.
 ==== rel_type ====
 String - The taxonomic (hierarchical) relationship between the taxonomic concept indicated by the taxon name and its parent taxonomic concept. Can be Member, Junior synonym, etc.
 ==== status ====
 String - The nomenclatural status of a taxon name using a formalized vocabulary.
 ==== taxon ====
 String - A taxon name string.
 ==== taxon_author ====
 String - The author(s) of a taxon with parenthesis surrounding the name of the author(s) if necessary.
 ==== tnuid ====
-Number - The taxon name use identifier which uniquely identifies a taxon.
+Number - The taxon name use identifier which uniquely identifies a taxon within xBio:D.
 ==== valid ====
 String - A ''Valid'' or ''Invalid'' string representing the validity of a taxon name using subjective interpretations if warranted.

@@ Line 244: / Line 244: @@
 ==== TaxonBasic ====
 * ''tnuid'': ''[[#tnuid|tnuid]]''
 * ''taxon'': ''[[#taxon|taxon]]''
 * ''taxon_author'': ''[[#taxon_author|taxon_author]]''

← Older revision		Revision as of 16:40, 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 - Taxon.png\|none\|frame\|Taxon 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/getTaxonInfo?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInfo?tnuid=30148&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 28: / Line 28: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInfo?tnuid=30148&inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInfo?tnuid=30148&inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getTaxonHierarchy ====
@@ Line 41: / Line 41: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonHierarchy?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonHierarchy?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getTaxonIncludedTaxa ====
@@ Line 61: / Line 61: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonIncludedTaxa?tnuid=30148&inst_id=1&show_syns=Y&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonIncludedTaxa?tnuid=30148&inst_id=1&show_syns=Y&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getTaxonSynonyms ====
@@ Line 77: / Line 77: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonSynonyms?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonSynonyms?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getTaxonAssociations ====
@@ Line 94: / Line 94: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonAssociations?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonAssociations?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getTaxonLiteratureCitations ====
@@ Line 110: / Line 110: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLiteratureCitations?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLiteratureCitations?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getTaxonOccurrences ====
@@ Line 129: / Line 129: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonOccurrences?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonOccurrences?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getTaxonTypes ====
@@ Line 148: / Line 148: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonTypes?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonTypes?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getTaxonLocalities ====
@@ Line 166: / Line 166: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLocalities?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonLocalities?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getTaxonDeterminers ====
@@ Line 182: / Line 182: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonDeterminers?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonDeterminers?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getTaxonInstitutions ====
@@ Line 197: / Line 197: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInstitutions?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonInstitutions?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getTaxonHabitats ====
@@ Line 212: / Line 212: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonHabitats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonHabitats?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getTaxonMedia ====
@@ Line 229: / Line 229: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonMedia?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonMedia?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 == Taxon Data Type Glossary ==