Difference between revisions of "OJ Break v2 Locality Reference"

From xBio:D Wiki
Jump to navigation Jump to search
Line 19: Line 19:
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''loc_id'': ''loc_id''
+
* ''loc_id'': ''[[#loc_id|loc_id]]''
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
Line 25: Line 25:
  
 
===== Return =====
 
===== Return =====
−
* ''LocalityExtended''
+
* [[#LocalityExtended_.28extends_LocalityBasic.29|LocalityExtended]]
  
 
===== Example =====
 
===== Example =====
Line 33: Line 33:
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''loc_id'': ''loc_id''
+
* ''loc_id'': ''[[#loc_id|loc_id]]''
−
* ''offset'': number (optional)
+
* ''*offset'': number
−
* ''limit'': number (optional)
+
* ''*limit'': number
−
* ''show_children'': Boolean_flag (optional)
+
* ''*show_children'': Boolean_flag
−
* ''tnuid'': ''tnuid'' (optional)
+
* ''*tnuid'': ''tnuid''
−
* ''inst_id'': ''inst_id'' (optional)
+
* ''*inst_id'': ''inst_id''
−
* ''place_id'': ''place_id'' (optional)
+
* ''*place_id'': ''place_id''
−
* ''agent_id'': ''agent_id'' (optional)
+
* ''*agent_id'': ''agent_id''
−
* ''vouchered'': Boolean_flag (optional)
+
* ''*basic_only'': Boolean_flag
−
* ''basic_only'': Boolean_flag (optional)
 
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''LocalityReturnOccurrences''
+
* [[#LocalityReturnOccurrences_.28extends_LocalityReturn.29|LocalityReturnOccurrences]]
  
 
===== Example =====
 
===== 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 ==
 +
=== 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 ===
 +
==== loc_id ====
 +
==== loc_name ====
 +
==== elev ====
 +
==== max_elev ====
 +
==== lat ====
 +
==== lng ====
 +
==== loc_source ====
 +
==== loc_comments ====
 +
==== degrees ====
 +
==== minutes ====
 +
==== seconds ====
 +
==== direction ====
 +
==== loc_type ====
  
 
== See also ==
 
== See also ==

Revision as of 23:01, 23 February 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 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 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=json&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.

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=json&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=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

Locality Data Type Glossary

Classes

LocalityBasic

LocalityCoordinateParts

LocalityCoordinates

LocalityExtended (extends LocalityBasic)

LocalityReturn

  • general: [#LocalityBasic|[LocalityBasic]]

LocalityReturnOccurrences (extends LocalityReturn)

Elements

loc_id

loc_name

elev

max_elev

lat

lng

loc_source

loc_comments

degrees

minutes

seconds

direction

loc_type

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=1829"