OJ Break v2 Locality Reference - Revision history

Jcora: /* API Information and Access */

2015-06-09T16:37:46Z

‎API Information and Access

Tyler: /* Elements */

2015-04-27T17:33:59Z

‎Elements

Tyler: /* Elements */

2015-04-27T17:30:44Z

‎Elements

Tyler at 20:28, 22 April 2015

2015-04-22T20:28:00Z

Tyler: /* Locality */

2015-04-20T19:58:17Z

‎Locality

Tyler at 19:43, 20 April 2015

2015-04-20T19:43:22Z

Tyler: /* See also */

2015-04-16T21:35:31Z

‎See also

Tyler at 22:43, 2 March 2015

2015-03-02T22:43:41Z

Tyler at 22:51, 26 February 2015

2015-02-26T22:51:55Z

Tyler at 22:45, 26 February 2015

2015-02-26T22:45:44Z

← 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 - Locality.png\|none\|frame\|Locality Data Model]]

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

@@ Line 81: / Line 81: @@
 === Elements ===
 ==== degrees ====
-Number - A measurement of latitude or longitude.
+Number - A numerical measurement of latitude or longitude.
 ==== direction ====
 String - A character signifying one of the cardinal directions.
@@ Line 103: / Line 103: @@
 String - maximum measurement of the elevation of the location (in meters)
 ==== minutes ====
-Number - A numerical fraction of a degree.
+Number - A numerical part of a coordinate as a fraction of a degree.
 ==== seconds ====
-Number - A numerical fraction of a minute.
+Number - A numerical part of a coordinate as a fraction of a minute.
 == See also ==

@@ Line 81: / Line 81: @@
 === Elements ===
 ==== degrees ====
-Number -
+Number - A measurement of latitude or longitude.
 ==== direction ====
-String -
+String - A character signifying one of the cardinal directions.
 ==== elev ====
 String - measurement of the elevation of the location (in meters)
@@ Line 103: / Line 103: @@
 String - maximum measurement of the elevation of the location (in meters)
 ==== minutes ====
-Number -
+Number - A numerical fraction of a degree.
 ==== seconds ====
-Number -
+Number - A numerical fraction of a minute.
 == See also ==

@@ 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/getLocalityInfo?loc_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityInfo?loc_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 28: / Line 28: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityInfo?loc_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityInfo?loc_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getLocalityOccurrences ====
@@ Line 49: / Line 49: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityOccurrences?loc_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityOccurrences?loc_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 == Locality Data Type Glossary ==

@@ Line 28: / Line 28: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityInfo?loc_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+ http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityInfo?loc_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getLocalityOccurrences ====
@@ Line 49: / Line 49: @@
 ===== Example =====
-http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityOccurrences?loc_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+ http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityOccurrences?loc_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 == Locality Data Type Glossary ==

@@ Line 25: / Line 25: @@
 ===== Return =====
-* [[#LocalityExtended_.28extends_LocalityBasic.29|LocalityExtended]]
+* [[#LocalityExtended (extends LocalityBasic)|LocalityExtended]]
 ===== Example =====
@@ Line 46: / Line 46: @@
 * ''version'': number
 ===== Return =====
-* [[#LocalityReturnOccurrences_.28extends_LocalityReturn.29|LocalityReturnOccurrences]]
+* [[#LocalityReturnOccurrences (extends LocalityReturn)|LocalityReturnOccurrences]]
 ===== Example =====

@@ Line 115: / Line 115: @@
 * [[OJ_Break v2 Journal Reference|Journal]]
 * [[OJ_Break v2 Literature Reference|Literature]]
 * [[OJ_Break v2 Occurrence Reference|Occurrence]]
 * [[OJ_Break v2 Search Reference|Search]]
 * [[OJ_Break v2 Taxon Reference|Taxon]]

@@ Line 76: / Line 76: @@
 * ''images'': array of LocalityImageExtended
 ==== LocalityReturn ====
-* ''general'': [#LocalityBasic|LocalityBasic]]
+* ''general'': [[#LocalityBasic|LocalityBasic]]
 ==== LocalityReturnOccurrences (extends [[#LocalityReturn|LocalityReturn]]) ====
 * ''occurrences'': array of [[#OccurrenceExtended|OccurrenceExtended]]