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...")
 
(→‎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/getAgentInfo?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+
     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getSearchResults?search=%Heptascelio%&domains=TAXON+OCCURRENCES&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 - Search.png|none|frame|Search Data Model]]
  
 
== Procedural Reference ==
 
== Procedural Reference ==
Line 20: Line 23:
 
===== Parameters =====
 
===== Parameters =====
 
* ''search'': string
 
* ''search'': string
−
* ''categories'': array of ''category'' (optional)
+
* ''*domains'': array of ''[[#domain|domain]]''
−
* ''basic_only'': Boolean_flag (optional)
+
* ''*basic_only'': Boolean_flag
−
* ''limit'': number (optional)
+
* ''*limit'': number
 +
* ''*offset'': number
 +
* ''*case_sensative'': Boolean_flag
 +
* ''*inst_id'': [[OJ_Break v2 Institution Reference#inst_id|inst_id]]
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 +
 
===== Return =====
 
===== Return =====
−
* ''SearchReturnComplete''
+
* [[#SearchReturnComplete (extends SearchReturn)|SearchReturnComplete]]
  
 
===== 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%&domains=TAXON+OCCURRENCES&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getTaxaFromText ====
 
==== getTaxaFromText ====
Line 36: Line 43:
 
===== Parameters =====
 
===== Parameters =====
 
* ''search'': string
 
* ''search'': string
−
* ''basic_only'': Boolean_flag (optional)
+
* ''*basic_only'': Boolean_flag
−
* ''limit'': number (optional)
+
* ''*limit'': number
 +
* ''*offset'': number
 +
* ''*case_sensative'': Boolean_flag
 +
* ''*inst_id'': [[OJ_Break v2 Institution Reference#inst_id|inst_id]]
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''SearchReturnTaxa''
+
* [[#SearchReturnTaxa (extends SearchReturn)|SearchReturnTaxa]]
  
 
===== 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=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
−
 
 
  
 
==== getOccurrencesFromText ====
 
==== getOccurrencesFromText ====
Line 52: Line 61:
 
===== Parameters =====
 
===== Parameters =====
 
* ''search'': string
 
* ''search'': string
−
* ''basic_only'': Boolean_flag (optional)
+
* ''*basic_only'': Boolean_flag
−
* ''limit'': number (optional)
+
* ''*limit'': number
 +
* ''*offset'': number
 +
* ''*case_sensative'': Boolean_flag
 +
* ''*inst_id'': [[OJ_Break v2 Institution Reference#inst_id|inst_id]]
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''SearchReturnOccurrences''
+
* [[#SearchReturnOccurrences (extends SearchReturn)|SearchReturnOccurrences]]
  
 
===== 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=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
−
 
 
  
 
==== getAgentsFromText ====
 
==== getAgentsFromText ====
Line 68: Line 79:
 
===== Parameters =====
 
===== Parameters =====
 
* ''search'': string
 
* ''search'': string
−
* ''include_party'': Boolean_flag (optional)
+
* ''*include_party'': Boolean_flag
−
* ''basic_only'': Boolean_flag (optional)
+
* ''*basic_only'': Boolean_flag
−
* ''limit'': number (optional)
+
* ''*limit'': number
 +
* ''*offset'': number
 +
* ''*case_sensative'': Boolean_flag
 +
* ''*inst_id'': [[OJ_Break v2 Institution Reference#inst_id|inst_id]]
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''SearchReturnAgents''
+
* [[#SearchReturnAgents (extends SearchReturn)|SearchReturnAgents]]
  
 
===== 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=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
−
 
 
  
 
==== getInstitutionsFromText ====
 
==== getInstitutionsFromText ====
Line 85: Line 98:
 
===== Parameters =====
 
===== Parameters =====
 
* ''search'': string
 
* ''search'': string
−
* ''limit'': number (optional)
+
* ''*basic_only'': Boolean_flag
 +
* ''*limit'': number
 +
* ''*offset'': number
 +
* ''*case_sensative'': Boolean_flag
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''SearchReturnInstitutions''
+
* [[#SearchReturnInstitutions (extends SearchReturn)|SearchReturnInstitutions]]
  
 
===== 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=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
−
 
 
  
 
==== getJournalsFromText ====
 
==== getJournalsFromText ====
Line 100: Line 115:
 
===== Parameters =====
 
===== Parameters =====
 
* ''search'': string
 
* ''search'': string
−
* ''limit'': number (optional)
+
* ''*basic_only'': Boolean_flag
 +
* ''*limit'': number
 +
* ''*offset'': number
 +
* ''*case_sensative'': Boolean_flag
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''SearchReturnJournal''
+
* [[#SearchReturnJournal (extends SearchReturn)|SearchReturnJournal]]
  
 
===== 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=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
−
 
 
  
 
==== getPlacesFromText ====
 
==== getPlacesFromText ====
Line 115: Line 132:
 
===== Parameters =====
 
===== Parameters =====
 
* ''search'': string
 
* ''search'': string
−
* ''limit'': number (optional)
+
* ''*basic_only'': Boolean_flag
 +
* ''*limit'': number
 +
* ''*offset'': number
 +
* ''*case_sensative'': Boolean_flag
 +
* ''*inst_id'': [[OJ_Break v2 Institution Reference#inst_id|inst_id]]
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''SearchReturnPlaces''
+
* [[#SearchReturnPlaces (extends SearchReturn)|SearchReturnPlaces]]
−
 
 
 
===== 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=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
−
 
 
  
 
==== getLocalitiesFromText ====
 
==== getLocalitiesFromText ====
Line 130: Line 149:
 
===== Parameters =====
 
===== Parameters =====
 
* ''search'': string
 
* ''search'': string
−
* ''limit'': number (optional)
+
* ''*basic_only'': Boolean_flag
 +
* ''*limit'': number
 +
* ''*offset'': number
 +
* ''*case_sensative'': Boolean_flag
 +
* ''*inst_id'': [[OJ_Break v2 Institution Reference#inst_id|inst_id]]
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''SearchReturnLocalities''
+
* [[#SearchReturnLocalities (extends SearchReturn)|SearchReturnLocalities]]
  
 
===== 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=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 +
 
 +
== Search Data Type Glossary ==
 +
=== Classes ===
 +
==== SearchReturn ====
 +
* ''count'': Number
 +
 
 +
==== SearchReturnComplete (extends [[#SearchReturn|SearchReturn]]) ====
 +
* ''taxon_results'': [[#SearchReturnTaxa (extends SearchReturn)|SearchReturnTaxa]] [0..1]
 +
* ''occurrence_results'': [[#SearchReturnOccurrences (extends SearchReturn)|SearchReturnOccurrences]] [0..1]
 +
* ''agent_results'': [[#SearchReturnAgents (extends SearchReturn)|SearchReturnAgents]] [0..1]
 +
* ''institution_results'': [[#SearchReturnInstitutions (extends SearchReturn)|SearchReturnInstitutions]] [0..1]
 +
* ''journal_results'': [[#SearchReturnJournals (extends SearchReturn)|SearchReturnJournals]] [0..1]
 +
* ''locality_results'': [[#SearchReturnLocalities (extends SearchReturn)|SearchReturnLocalities]] [0..1]
 +
* ''place_results'': [[#SearchReturnPlaces (extends SearchReturn)|SearchReturnPlaces]] [0..1]
 +
 
 +
==== SearchReturnAgents (extends [[#SearchReturn|SearchReturn]]) ====
 +
* ''agents'': array of [[OJ_Break v2 Agent Reference#AgentBasic|AgentBasic]]
 +
 
 +
==== SearchReturnInstitutions (extends [[#SearchReturn|SearchReturn]]) ====
 +
* ''institutions'': array of [[OJ_Break v2 Institution Reference#InstitutionBasic|InstitutionBasic]]
 +
 
 +
==== SearchReturnJournals (extends [[#SearchReturn|SearchReturn]]) ====
 +
* ''journals'': array of [[OJ_Break v2 Journal Reference#JournalBasic|JournalBasic]]
 +
 
 +
==== SearchReturnLocalities (extends [[#SearchReturn|SearchReturn]]) ====
 +
* ''localities'': array of [[OJ_Break v2 Locality Reference#LocalityBasic|LocalityBasic]]
 +
 
 +
==== SearchReturnOccurrences (extends [[#SearchReturn|SearchReturn]]) ====
 +
* ''occurrences'': array of [[OJ_Break v2 Occurrence Reference#OccurrenceBasic|OccurrenceBasic]]
 +
 
 +
==== SearchReturnPlaces (extends [[#SearchReturn|SearchReturn]]) ====
 +
* ''places'': array of [[OJ_Break v2 Geographic Place Reference#PlaceBasic|PlaceBasic]]
 +
 
 +
==== SearchReturnTaxa (extends [[#SearchReturn|SearchReturn]]) ====
 +
* ''taxa'': array of [[OJ_Break v2 Taxon Reference#TaxonBasic|TaxonBasic]]
  
 
== See also ==
 
== See also ==
Line 149: Line 207:
 
* [[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 Taxon Reference|Taxon]]
 
* [[OJ_Break v2 Taxon Reference|Taxon]]

Latest revision as of 16:39, 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 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%&domains=TAXON+OCCURRENCES&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.


Search Data Model

Procedural Reference

Search

getSearchResults

Description
Parameters
  • search: string
  • *domains: array of domain
  • *basic_only: Boolean_flag
  • *limit: number
  • *offset: number
  • *case_sensative: Boolean_flag
  • *inst_id: inst_id
  • format: string
  • key: string
  • version: number
Return
Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getSearchResults?search=%Heptascelio%&domains=TAXON+OCCURRENCES&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getTaxaFromText

Description
Parameters
  • search: string
  • *basic_only: Boolean_flag
  • *limit: number
  • *offset: number
  • *case_sensative: Boolean_flag
  • *inst_id: inst_id
  • format: string
  • key: string
  • version: number
Return
Example

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

getOccurrencesFromText

Description
Parameters
  • search: string
  • *basic_only: Boolean_flag
  • *limit: number
  • *offset: number
  • *case_sensative: Boolean_flag
  • *inst_id: inst_id
  • format: string
  • key: string
  • version: number
Return
Example

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

getAgentsFromText

Description
Parameters
  • search: string
  • *include_party: Boolean_flag
  • *basic_only: Boolean_flag
  • *limit: number
  • *offset: number
  • *case_sensative: Boolean_flag
  • *inst_id: inst_id
  • format: string
  • key: string
  • version: number
Return
Example

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

getInstitutionsFromText

Description
Parameters
  • search: string
  • *basic_only: Boolean_flag
  • *limit: number
  • *offset: number
  • *case_sensative: Boolean_flag
  • format: string
  • key: string
  • version: number
Return
Example

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

getJournalsFromText

Description
Parameters
  • search: string
  • *basic_only: Boolean_flag
  • *limit: number
  • *offset: number
  • *case_sensative: Boolean_flag
  • format: string
  • key: string
  • version: number
Return
Example

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

getPlacesFromText

Description
Parameters
  • search: string
  • *basic_only: Boolean_flag
  • *limit: number
  • *offset: number
  • *case_sensative: Boolean_flag
  • *inst_id: inst_id
  • format: string
  • key: string
  • version: number
Return
Example

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

getLocalitiesFromText

Description
Parameters
  • search: string
  • *basic_only: Boolean_flag
  • *limit: number
  • *offset: number
  • *case_sensative: Boolean_flag
  • *inst_id: inst_id
  • format: string
  • key: string
  • version: number
Return
Example

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

Search Data Type Glossary

Classes

SearchReturn

  • count: Number

SearchReturnComplete (extends SearchReturn)

SearchReturnAgents (extends SearchReturn)

SearchReturnInstitutions (extends SearchReturn)

SearchReturnJournals (extends SearchReturn)

SearchReturnLocalities (extends SearchReturn)

SearchReturnOccurrences (extends SearchReturn)

SearchReturnPlaces (extends SearchReturn)

SearchReturnTaxa (extends SearchReturn)

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