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

From xBio:D Wiki
Jump to navigation Jump to search
(→‎Procedural Reference)
Line 32: Line 32:
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''place_id'': number
+
* ''place_id'': ''place_id''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''pol_level'': number (optional)
 
* ''pol_level'': number (optional)
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
−
* ''version'': number (optional)
+
* ''version'': number
 
===== Return =====
 
===== Return =====
 
* ''PlaceReturnSubdivisions''
 
* ''PlaceReturnSubdivisions''
Line 46: Line 48:
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''place_id'': number
+
* ''place_id'': ''place_id''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
Line 59: Line 63:
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''place_id'': number
+
* ''place_id'': ''place_id''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
Line 72: Line 78:
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''place_id'': number
+
* ''place_id'': ''place_id''
 +
* ''offset'': number (optional)
 +
* ''limit'': number (optional)
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string

Revision as of 21:29, 12 January 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 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=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

Geographic Place

getPlaceInfo

Description
Parameters
  • place_id: number
  • format: string
  • key: string
  • version: number
Return
  • PlaceExtended
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceInfo?place_id=54&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getPlaceSubdivisions

Description
Parameters
  • place_id: place_id
  • offset: number (optional)
  • limit: number (optional)
  • pol_level: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • PlaceReturnSubdivisions
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceSubdivisions?place_id=54&pol_level=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getPlaceTaxa

Description
Parameters
  • place_id: place_id
  • offset: number (optional)
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • PlaceReturnTaxa
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceTaxa?place_id=54&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getPlaceOccurrences

Description
Parameters
  • place_id: place_id
  • offset: number (optional)
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • PlaceReturnOccurrences
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceOccurrences?place_id=54&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getPlaceInstitutions

Description
Parameters
  • place_id: place_id
  • offset: number (optional)
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • PlaceReturnInstitutions
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getPlaceInstitutions?place_id=54&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

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