Difference between revisions of "OJ Break v2 Locality Reference"

From xBio:D Wiki
Jump to navigation Jump to search
(Created page with "'''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 Obje...")
 
(→‎API Information and Access)
 
(14 intermediate revisions by one other user not shown)
Line 1: Line 1:
 
'''Introduction'''
 
'''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.
 
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.  
 
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/getAgentInfo?agent_id=2&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]].
 
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 19: Line 22:
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''loc_id'': number
+
* ''loc_id'': ''[[#loc_id|loc_id]]''
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 +
 
===== Return =====
 
===== Return =====
−
* ''LocalityExtended''
+
* [[#LocalityExtended (extends LocalityBasic)|LocalityExtended]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityInfo?loc_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityInfo?loc_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getLocalityOccurrences ====
 
==== getLocalityOccurrences ====
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''loc_id'': number
+
* ''loc_id'': ''[[#loc_id|loc_id]]''
−
* ''show_children'': Boolean_flag (optional)
+
* ''*offset'': number
−
* ''tnuid'': ''tnuid'' (optional)
+
* ''*limit'': number
−
* ''inst_id'': ''inst_id'' (optional)
+
* ''*show_children'': Boolean_flag
−
* ''place_id'': ''place_id'' (optional)
+
* ''*tnuid'': ''tnuid''
−
* ''agent_id'': ''agent_id'' (optional)
+
* ''*inst_id'': ''inst_id''
−
* ''vouchered'': Boolean_flag (optional)
+
* ''*place_id'': ''place_id''
−
* ''basic_only'': Boolean_flag (optional)
+
* ''*agent_id'': ''agent_id''
 +
* ''*basic_only'': Boolean_flag
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''LocalityReturnOccurrences''
+
* [[#LocalityReturnOccurrences (extends LocalityReturn)|LocalityReturnOccurrences]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityOccurrences?loc_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityOccurrences?loc_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 +
== Locality Data Type Glossary ==
 +
=== Classes ===
 +
==== LocalityBasic ====
 +
* ''loc_id'': [[#loc_id|loc_id]]''
 +
* ''loc_name'': [[#loc_name|loc_name]]
 +
* ''loc_type'': [[#loc_type|loc_type]]
 +
==== LocalityCoordinateParts ====
 +
* ''degrees'': [[#degrees|degrees]]
 +
* ''minutes'': [[#minutes|minutes]]
 +
* ''seconds'': [[#seconds|seconds]]
 +
* ''direction'': [[#direction|direction]]
 +
==== LocalityCoordinates ====
 +
* ''lat'': [[#lat|lat]]
 +
* ''lng'': [[#lng|lng]]
 +
* ''lat_parts'': [[#LocalityCoordinateParts|LocalityCoordinateParts]]
 +
* ''lng_parts'': [[#LocalityCoordinateParts|LocalityCoordinateParts]]
 +
* ''loc_source'': [[#loc_source|loc_source]]
 +
==== LocalityExtended (extends [[#LocalityExtended|LocalityBasic]]) ====
 +
* ''coords'': [[#LocalityCoordinates|LocalityCoordinates]]
 +
* ''hier'': array of [[OJ_Break v2 Geographic Place Reference#PlaceHierarchy|PlaceHierarchy]]
 +
* ''elev'': [[#elev|elev]]
 +
* ''max_elev'': [[#max_elev|max_elev]]
 +
* ''loc_comments'': [[#loc_comments|loc_comments]]
 +
* ''images'': array of LocalityImageExtended
 +
==== LocalityReturn ====
 +
* ''general'': [[#LocalityBasic|LocalityBasic]]
 +
==== LocalityReturnOccurrences (extends [[#LocalityReturn|LocalityReturn]]) ====
 +
* ''occurrences'': array of [[#OccurrenceExtended|OccurrenceExtended]]
 +
=== Elements ===
 +
==== degrees ====
 +
Number - A numerical measurement of latitude or longitude.
 +
==== direction ====
 +
String - A character signifying one of the cardinal directions.
 +
==== elev ====
 +
String - measurement of the elevation of the location (in meters)
 +
==== lat ====
 +
Number - The signed decimal coordinates for a latitude.
 +
==== lng ====
 +
Number - The signed decimal coordinates for a longitude.
 +
==== loc_comments ====
 +
String - miscellaneous descriptions or statements about the locality
 +
==== loc_id ====
 +
Number - The locality identifier which uniquely identifies a locality.
 +
==== loc_name ====
 +
String - the name of the locality.
 +
==== loc_source ====
 +
String - The data source used to obtain the coordinates for the locality.
 +
==== loc_type ====
 +
String - A measure of confidence in the accuracy of the coordinates for the locality in either POINT (confident) or POLYGON (unconfident).
 +
==== max_elev ====
 +
String - maximum measurement of the elevation of the location (in meters)
 +
==== minutes ====
 +
Number - A numerical part of a coordinate as a fraction of a degree.
 +
==== seconds ====
 +
Number - A numerical part of a coordinate as a fraction of a minute.
  
 
== See also ==
 
== See also ==

Latest revision as of 16:37, 9 June 2015

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 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.

API Information and Access

This page specifies the methods and data defined by OJ_Break Version 2, more precisely those that are defined by the Locality data domain. To get information on any of the other data domains defined in OJ_Break Version 2, visit the See also section.

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=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.


Locality Data Model

Procedural Reference

Locality

getLocalityInfo

Description
Parameters
  • loc_id: loc_id
  • format: string
  • key: string
  • version: number
Return
Example
http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityInfo?loc_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getLocalityOccurrences

Description
Parameters
  • loc_id: loc_id
  • *offset: number
  • *limit: number
  • *show_children: Boolean_flag
  • *tnuid: tnuid
  • *inst_id: inst_id
  • *place_id: place_id
  • *agent_id: agent_id
  • *basic_only: Boolean_flag
  • format: string
  • key: string
  • version: number
Return
Example
http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalityOccurrences?loc_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

Locality Data Type Glossary

Classes

LocalityBasic

LocalityCoordinateParts

LocalityCoordinates

LocalityExtended (extends LocalityBasic)

LocalityReturn

LocalityReturnOccurrences (extends LocalityReturn)

Elements

degrees

Number - A numerical measurement of latitude or longitude.

direction

String - A character signifying one of the cardinal directions.

elev

String - measurement of the elevation of the location (in meters)

lat

Number - The signed decimal coordinates for a latitude.

lng

Number - The signed decimal coordinates for a longitude.

loc_comments

String - miscellaneous descriptions or statements about the locality

loc_id

Number - The locality identifier which uniquely identifies a locality.

loc_name

String - the name of the locality.

loc_source

String - The data source used to obtain the coordinates for the locality.

loc_type

String - A measure of confidence in the accuracy of the coordinates for the locality in either POINT (confident) or POLYGON (unconfident).

max_elev

String - maximum measurement of the elevation of the location (in meters)

minutes

Number - A numerical part of a coordinate as a fraction of a degree.

seconds

Number - A numerical part of a coordinate as a fraction of a minute.

See also

Visit any of the below links to find information about the other data domains defined by OJ_Break Version 2.

Retrieved from "https://xbiod.osu.edu/index.php?title=OJ_Break_v2_Locality_Reference&oldid=2060"