Difference between revisions of "OJ Break v2 Geographic Place Reference"

From xBio:D Wiki
Jump to navigation Jump to search
(→‎API Information and Access)
 
(15 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/getPlaceInfo?place_id=54&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+
     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceInfo?place_id=54&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 - Geographic Place.png|none|frame|Geographic Place Data Model]]
  
 
== Procedural Reference ==
 
== Procedural Reference ==
Line 19: Line 22:
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''place_id'': number
+
* ''place_id'': ''[[#place_id|place_id]]''
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 +
 
===== Return =====
 
===== Return =====
−
* ''PlaceExtended''
+
* [[#PlaceExtended (extends PlaceBasic)|PlaceExtended]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceInfo?place_id=54&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceInfo?place_id=54&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getPlaceSubdivisions ====
 
==== getPlaceSubdivisions ====
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''place_id'': number
+
* ''place_id'': ''[[#place_id|place_id]]''
−
* ''pol_level'': number (optional)
+
* ''*offset'': number
 +
* ''*limit'': number
 +
* ''*pol_level'': number
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
−
* ''version'': number (optional)
+
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''PlaceReturnSubdivisions''
+
* [[#PlaceReturnSubdivisions (extends PlaceReturn)|PlaceReturnSubdivisions]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceSubdivisions?place_id=54&pol_level=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceSubdivisions?place_id=54&pol_level=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getPlaceTaxa ====
 
==== getPlaceTaxa ====
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''place_id'': number
+
* ''place_id'': ''[[#place_id|place_id]]''
 +
* ''*offset'': number
 +
* ''*limit'': number
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''PlaceReturnTaxa''
+
* [[#PlaceReturnTaxa (extends PlaceReturn)|PlaceReturnTaxa]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceTaxa?place_id=54&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceTaxa?place_id=54&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getPlaceOccurrences ====
 
==== getPlaceOccurrences ====
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''place_id'': number
+
* ''place_id'': ''[[#place_id|place_id]]''
 +
* ''*offset'': number
 +
* ''*limit'': number
 +
* ''*basic_only'': Boolean_flag
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 +
 
===== Return =====
 
===== Return =====
−
* ''PlaceReturnOccurrences''
+
* [[#PlaceReturnOccurrences (extends PlaceReturn)|PlaceReturnOccurrences]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceOccurrences?place_id=54&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceOccurrences?place_id=54&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getPlaceInstitutions ====
 
==== getPlaceInstitutions ====
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''place_id'': number
+
* ''place_id'': ''[[#place_id|place_id]]''
 +
* ''*offset'': number
 +
* ''*limit'': number
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''PlaceReturnInstitutions''
+
* [[#PlaceReturnInstitutions (extends PlaceReturn)|PlaceReturnInstitutions]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceInstitutions?place_id=54&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceInstitutions?place_id=54&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 +
 
 +
== Geographic Place Data Type Glossary ==
 +
=== Classes ===
 +
==== PlaceBasic ====
 +
* ''place_id'': ''[[#place_id|place_id]]''
 +
* ''place_name'': ''[[#place_name|place_name]]''
 +
* ''place_type'': ''[[#place_type|place_type]]''
 +
* ''pol_level'': ''[[#pol_level|pol_level]]''
 +
 
 +
==== PlaceExtended (extends [[#PlaceBasic|PlaceBasic]]) ====
 +
* ''hier'': array of [[#PlaceHierarchy|PlaceHierarchy]]
 +
 
 +
==== PlaceHierarchy ====
 +
Aggregate of one or more of the following classes:
 +
* [[#PlaceHierarchyPol-4|PlaceHierarchyPol-4]] (1)
 +
* [[#PlaceHierarchyPol-3|PlaceHierarchyPol-3]] (0 or 1)
 +
* [[#PlaceHierarchyPol-2|PlaceHierarchyPol-2]] (0 or 1)
 +
* [[#PlaceHierarchyPol-1|PlaceHierarchyPol-1]] (0 or 1)
 +
* [[#PlaceHierarchyPol0|PlaceHierarchyPol0]] (0 or 1)
 +
* [[#PlaceHierarchyPol1|PlaceHierarchyPol1]] (0 or 1)
 +
* [[#PlaceHierarchyPol2|PlaceHierarchyPol2]] (0 or 1)
 +
* [[#PlaceHierarchyPol4|PlaceHierarchyPol4]] (0 or 1)
 +
 
 +
==== PlaceHierarchyPol-4 ====
 +
* ''pol-4'': [[#PlaceBasic|PlaceBasic]]
 +
==== PlaceHierarchyPol-3 ====
 +
* ''pol-3'': [[#PlaceBasic|PlaceBasic]]
 +
==== PlaceHierarchyPol-2 ====
 +
* ''pol-2'': [[#PlaceBasic|PlaceBasic]]
 +
==== PlaceHierarchyPol-1 ====
 +
* ''pol-1'': [[#PlaceBasic|PlaceBasic]]
 +
==== PlaceHierarchyPol0 ====
 +
* ''pol0'': [[#PlaceBasic|PlaceBasic]]
 +
==== PlaceHierarchyPol1 ====
 +
* ''pol1'': [[#PlaceBasic|PlaceBasic]]
 +
==== PlaceHierarchyPol2 ====
 +
* ''pol2'': [[#PlaceBasic|PlaceBasic]]
 +
==== PlaceHierarchyPol4 ====
 +
* ''pol4'': [[#PlaceBasic|PlaceBasic]]
 +
==== PlaceReturn ====
 +
* ''general'': [[#PlaceBasic|PlaceBasic]]
 +
==== PlaceReturnInstitutions (extends [[#PlaceReturn|PlaceReturn]]) ====
 +
* ''institutions'': array of [[OJ_Break v2 Institution Reference#InstitutionBasic|InstitutionBasic]]
 +
 
 +
==== PlaceReturnOccurrences (extends [[#PlaceReturn|PlaceReturn]]) ====
 +
* ''occurrences'': array of [[OJ_Break v2 Occurrence Reference#OccurrenceExtended (extends OccurrenceBasic)|OccurrenceExtended]]
 +
 
 +
==== PlaceReturnSubdivisions  (extends [[#PlaceReturn|PlaceReturn]]) ====
 +
* ''subdivisons'': array of [[#PlaceBasic|PlaceBasic]]
 +
 
 +
==== PlaceReturnTaxa (extends [[#PlaceReturn|PlaceReturn]]) ====
 +
* ''taxa'': array of [[OJ_Break v2 Taxon Reference#TaxonRelationship (extends TaxonExtended)|TaxonRelationship]]
 +
 
 +
=== Elements ===
 +
==== place_id ====
 +
Number - A unique, numeric place identifier.
 +
 
 +
==== place_name ====
 +
String - A place name string.
 +
 
 +
==== place_type ====
 +
String - Geographic description of place, e.g. "Earth", "Hemisphere", "Continent" etc.
 +
 
 +
==== pol_level ====
 +
Number - Numeric rank that is associated with a geographic description. Possible values are integers ranging from -4 to 4, excluding 3.
  
 
== See also ==
 
== See also ==
Line 90: Line 169:
 
* [[OJ_Break v2 Literature Reference|Literature]]
 
* [[OJ_Break v2 Literature Reference|Literature]]
 
* [[OJ_Break v2 Locality Reference|Locality]]
 
* [[OJ_Break v2 Locality Reference|Locality]]
 +
* [[OJ_Break v2 Media Reference|Media]]
 
* [[OJ_Break v2 Occurrence Reference|Occurrence]]
 
* [[OJ_Break v2 Occurrence Reference|Occurrence]]
 
* [[OJ_Break v2 Search Reference|Search]]
 
* [[OJ_Break v2 Search Reference|Search]]
 
* [[OJ_Break v2 Taxon Reference|Taxon]]
 
* [[OJ_Break v2 Taxon Reference|Taxon]]

Latest revision as of 16:34, 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 Geographic Place 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/getPlaceInfo?place_id=54&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.


Geographic Place Data Model

Procedural Reference

Geographic Place

getPlaceInfo

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

getPlaceSubdivisions

Description
Parameters
  • place_id: place_id
  • *offset: number
  • *limit: number
  • *pol_level: number
  • format: string
  • key: string
  • version: number
Return
Example
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceSubdivisions?place_id=54&pol_level=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getPlaceTaxa

Description
Parameters
  • place_id: place_id
  • *offset: number
  • *limit: number
  • format: string
  • key: string
  • version: number
Return
Example
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceTaxa?place_id=54&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getPlaceOccurrences

Description
Parameters
  • place_id: place_id
  • *offset: number
  • *limit: number
  • *basic_only: Boolean_flag
  • format: string
  • key: string
  • version: number
Return
Example
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceOccurrences?place_id=54&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getPlaceInstitutions

Description
Parameters
  • place_id: place_id
  • *offset: number
  • *limit: number
  • format: string
  • key: string
  • version: number
Return
Example
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceInstitutions?place_id=54&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

Geographic Place Data Type Glossary

Classes

PlaceBasic

PlaceExtended (extends PlaceBasic)

PlaceHierarchy

Aggregate of one or more of the following classes:

PlaceHierarchyPol-4

PlaceHierarchyPol-3

PlaceHierarchyPol-2

PlaceHierarchyPol-1

PlaceHierarchyPol0

PlaceHierarchyPol1

PlaceHierarchyPol2

PlaceHierarchyPol4

PlaceReturn

PlaceReturnInstitutions (extends PlaceReturn)

PlaceReturnOccurrences (extends PlaceReturn)

PlaceReturnSubdivisions (extends PlaceReturn)

PlaceReturnTaxa (extends PlaceReturn)

Elements

place_id

Number - A unique, numeric place identifier.

place_name

String - A place name string.

place_type

String - Geographic description of place, e.g. "Earth", "Hemisphere", "Continent" etc.

pol_level

Number - Numeric rank that is associated with a geographic description. Possible values are integers ranging from -4 to 4, excluding 3.

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_Geographic_Place_Reference&oldid=2051"