Difference between revisions of "OJ Break v2 Search Reference"
(→Parameters) |
(→SearchReturnPlaces (extends SearchReturn) |
||
| Line 190: | Line 190: | ||
==== SearchReturnPlaces (extends [[#SearchReturn|SearchReturn]] ==== | ==== SearchReturnPlaces (extends [[#SearchReturn|SearchReturn]] ==== | ||
| − | * ''places'': array of [[OJ_Break v2 Place Reference#PlaceBasic|PlaceBasic]] | + | * ''places'': array of [[OJ_Break v2 Geopolitical Place Reference#PlaceBasic|PlaceBasic]] |
| − | |||
==== SearchReturnTaxa (extends [[#SearchReturn|SearchReturn]] ==== | ==== SearchReturnTaxa (extends [[#SearchReturn|SearchReturn]] ==== | ||
Revision as of 21:25, 15 April 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.
Contents
- 1 API Information and Access
- 2 Procedural Reference
- 3 Search Data Type Glossary
- 3.1 Classes
- 3.1.1 SearchReturn
- 3.1.2 SearchReturnComplete (extends SearchReturn
- 3.1.3 SearchReturnAgents (extends SearchReturn
- 3.1.4 SearchReturnInstitutions (extends SearchReturn
- 3.1.5 SearchReturnJournals (extends SearchReturn
- 3.1.6 SearchReturnLocalities (extends SearchReturn
- 3.1.7 SearchReturnOccurrences (extends SearchReturn
- 3.1.8 SearchReturnPlaces (extends SearchReturn
- 3.1.9 SearchReturnTaxa (extends SearchReturn
- 3.1 Classes
- 4 See also
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
- *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
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
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
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
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
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
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
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
Search Data Type Glossary
Classes
SearchReturn
- count: Number
SearchReturnComplete (extends SearchReturn
- taxon_results: SearchReturnTaxa [0..1]
- occurrence_results: SearchReturnOccurrences [0..1]
- agent_results: SearchReturnAgents [0..1]
- institution_results: SearchReturnInstitutions [0..1]
- journal_results: SearchReturnJournals [0..1]
- locality_results: SearchReturnLocalities [0..1]
- place_results: SearchReturnPlaces [0..1]
SearchReturnAgents (extends SearchReturn
- agents: array of AgentBasic
SearchReturnInstitutions (extends SearchReturn
- institutions: array of InstitutionBasic
SearchReturnJournals (extends SearchReturn
- journals: array of JournalBasic
SearchReturnLocalities (extends SearchReturn
- localities: array of LocalityBasic
SearchReturnOccurrences (extends SearchReturn
- occurrences: array of OccurrenceBasic
SearchReturnPlaces (extends SearchReturn
- places: array of PlaceBasic
SearchReturnTaxa (extends SearchReturn
- taxa: array of TaxonBasic
See also
Visit any of the below links to find information about the other data domains defined by OJ_Break Version 2.
