Difference between revisions of "OJ Break v2 Search 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...")
 
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/getSearchResults?search=Heptascelio&categories=taxon,occurrence&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]].
 
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 30: Line 30:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getSearchResults?search=Heptascelio&categories=taxon,occurrence&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getSearchResults?search=Heptascelio&categories=taxon,occurrence&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getTaxaFromText ====
 
==== getTaxaFromText ====
Line 45: Line 45:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxaFromText?search=Heptascelio&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxaFromText?search=Heptascelio&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
  
Line 61: Line 61:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getOccurrencesFromText?search=Heptascelio&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getOccurrencesFromText?search=Heptascelio&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
  
Line 78: Line 78:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentsFromText?search=Johnson&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentsFromText?search=Johnson&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
  
Line 93: Line 93:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionsFromText?search=OSUC&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionsFromText?search=OSUC&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
  
Line 108: Line 108:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalFromText?search=Insect&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalFromText?search=Insect&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
  
Line 123: Line 123:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlacesFromText?search=Sri Lanka&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getPlacesFromText?search=Sri Lanka&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
  
Line 138: Line 138:
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalitiesFromText?search=Sri Lanka&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalitiesFromText?search=Sri Lanka&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
== See also ==
 
== See also ==

Revision as of 21:55, 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 Search 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/getSearchResults?search=Heptascelio&categories=taxon,occurrence&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

Search

getSearchResults

Description
Parameters
  • search: string
  • categories: array of category (optional)
  • basic_only: Boolean_flag (optional)
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • SearchReturnComplete
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getSearchResults?search=Heptascelio&categories=taxon,occurrence&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxaFromText

Description
Parameters
  • search: string
  • basic_only: Boolean_flag (optional)
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • SearchReturnTaxa
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxaFromText?search=Heptascelio&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2


getOccurrencesFromText

Description
Parameters
  • search: string
  • basic_only: Boolean_flag (optional)
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • SearchReturnOccurrences
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getOccurrencesFromText?search=Heptascelio&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2


getAgentsFromText

Description
Parameters
  • search: string
  • include_party: Boolean_flag (optional)
  • basic_only: Boolean_flag (optional)
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • SearchReturnAgents
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentsFromText?search=Johnson&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2


getInstitutionsFromText

Description
Parameters
  • search: string
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • SearchReturnInstitutions
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionsFromText?search=OSUC&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2


getJournalsFromText

Description
Parameters
  • search: string
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • SearchReturnJournal
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getJournalFromText?search=Insect&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2


getPlacesFromText

Description
Parameters
  • search: string
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • SearchReturnPlaces
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getPlacesFromText?search=Sri Lanka&limit=30&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2


getLocalitiesFromText

Description
Parameters
  • search: string
  • limit: number (optional)
  • format: string
  • key: string
  • version: number
Return
  • SearchReturnLocalities
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getLocalitiesFromText?search=Sri Lanka&limit=30&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_Search_Reference&oldid=1698"