View source for OJ Break v2 Search Reference

'''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|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|domain]]''
* ''*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
* ''key'': string
* ''version'': number

===== Return =====
* [[#SearchReturnComplete_.28extends_SearchReturn.29|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
* ''*limit'': number
* ''*offset'': number
* ''*case_sensative'': Boolean_flag
* ''*inst_id'': [[OJ_Break v2 Institution Reference#inst_id|inst_id]]
* ''format'': string
* ''key'': string
* ''version'': number
===== Return =====
* [[#SearchReturnTaxa_.28extends_SearchReturn.29|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
* ''*limit'': number
* ''*offset'': number
* ''*case_sensative'': Boolean_flag
* ''*inst_id'': [[OJ_Break v2 Institution Reference#inst_id|inst_id]]
* ''format'': string
* ''key'': string
* ''version'': number
===== Return =====
* [[#SearchReturnOccurrences_.28extends_SearchReturn.29|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
* ''*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
* ''key'': string
* ''version'': number
===== Return =====
* [[#SearchReturnAgents_.28extends_SearchReturn.29|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
* ''*basic_only'': Boolean_flag
* ''*limit'': number
* ''*offset'': number
* ''*case_sensative'': Boolean_flag
* ''format'': string
* ''key'': string
* ''version'': number
===== Return =====
* [[#SearchReturnInstitutions_.28extends_SearchReturn.29|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
* ''*basic_only'': Boolean_flag
* ''*limit'': number
* ''*offset'': number
* ''*case_sensative'': Boolean_flag
* ''format'': string
* ''key'': string
* ''version'': number
===== Return =====
* [[#SearchReturnJournal_.28extends_SearchReturn.29|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
* ''*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
* ''key'': string
* ''version'': number
===== Return =====
* [[#SearchReturnPlaces_.28extends_SearchReturn.29|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
* ''*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
* ''key'': string
* ''version'': number
===== Return =====
* [[#SearchReturnLocalities_.28extends_SearchReturn.29|SearchReturnLocalities]]

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

== Search Data Type Glossary ==
=== Classes ===
==== SearchReturn ====
* ''count'': Number

==== SearchReturnComplete (extends [[#SearchReturn|SearchReturn]]) ====
* ''taxon_results'': [[#SearchReturnTaxa_.28extends_SearchReturn.29|SearchReturnTaxa]] [0..1]
* ''occurrence_results'': [[#SearchReturnOccurrences_.28extends_SearchReturn.29|SearchReturnOccurrences]] [0..1]
* ''agent_results'': [[#SearchReturnAgents_.28extends_SearchReturn.29|SearchReturnAgents]] [0..1]
* ''institution_results'': [[#SearchReturnInstitutions_.28extends_SearchReturn.29|SearchReturnInstitutions]] [0..1]
* ''journal_results'': [[#SearchReturnJournals_.28extends_SearchReturn.29|SearchReturnJournals]] [0..1]
* ''locality_results'': [[#SearchReturnLocalities_.28extends_SearchReturn.29|SearchReturnLocalities]] [0..1]
* ''place_results'': [[#SearchReturnPlaces_.28extends_SearchReturn.29|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 ==
Visit any of the below links to find information about the other data domains defined by OJ_Break Version 2.

* [[OJ_Break v2 Agent Reference|Agent]]
* [[OJ_Break v2 Geographic Place Reference|Geographic Place]]
* [[OJ_Break v2 Institution Reference|Institution]]
* [[OJ_Break v2 Journal Reference|Journal]]
* [[OJ_Break v2 Literature Reference|Literature]]
* [[OJ_Break v2 Locality Reference|Locality]]
* [[OJ_Break v2 Media Reference|Media]]
* [[OJ_Break v2 Occurrence Reference|Occurrence]]
* [[OJ_Break v2 Taxon Reference|Taxon]]