Difference between revisions of "OJ Break v2 Institution Reference"

From xBio:D Wiki
Jump to navigation Jump to search
(→‎See also)
(→‎API Information and Access)
 
(17 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/getInstitutionInfo?inst_id=1&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 - Institution.png|none|frame|Institution Data Model]]
  
 
== Procedural Reference ==
 
== Procedural Reference ==
Line 19: Line 22:
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''inst_id'': number
+
* ''inst_id'': ''[[#inst_id|inst_id]]''
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''InstitutionExtended''
+
* [[#LiteratureExtended (extends InstitutionBasic)|InstitutionExtended]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionInfo?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionInfo?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getInstitutionLiterature ====
 
==== getInstitutionLiterature ====
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''inst_id'': number
+
* ''inst_id'': ''[[#inst_id|inst_id]]''
 +
* ''*offset'': number
 +
* ''*limit'': number
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''InstitutionReturnLiterature''
+
* [[#InstitutionReturnLiterature (extends InstitutionReturn)|InstitutionReturnLiterature]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionLiterature?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionLiterature?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
−
 
 
  
 
==== getInstitutionTaxa ====
 
==== getInstitutionTaxa ====
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''inst_id'': number
+
* ''inst_id'': ''[[#inst_id|inst_id]]''
 +
* ''*offset'': number
 +
* ''*limit'': number
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''InstitutionReturnTaxa''
+
* [[#InstitutionReturnTaxa (extends InstitutionReturn)|InstitutionReturnTaxa]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionTaxa?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionTaxa?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
−
 
 
  
 
==== getInstitutionOccurrences ====
 
==== getInstitutionOccurrences ====
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''inst_id'': number
+
* ''inst_id'': ''[[#inst_id|inst_id]]''
 +
* ''*offset'': number
 +
* ''*limit'': number
 +
* ''*basic_only'': Boolean_flag
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''InstitutionReturnOccurrences''
+
* [[#InstitutionReturnOccurrences (extends InstitutionReturn)|InstitutionReturnOccurrences]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionOccurrences?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionOccurrences?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getInstitutionPrimaryTypes ====
 
==== getInstitutionPrimaryTypes ====
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''inst_id'': number
+
* ''inst_id'': ''[[#inst_id|inst_id]]''
 +
* ''*offset'': number
 +
* ''*limit'': number
 +
* ''*basic_only'': Boolean_flag
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''InstitutionReturnOccurrences''
+
* [[#InstitutionReturnOccurrences extends InstitutionReturn)|InstitutionReturnOccurrences]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionPrimaryTypes?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionPrimaryTypes?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
  
 
==== getInstitutionSecondaryTypes ====
 
==== getInstitutionSecondaryTypes ====
 
===== Description =====
 
===== Description =====
 
===== Parameters =====
 
===== Parameters =====
−
* ''inst_id'': number
+
* ''inst_id'': ''[[#inst_id|inst_id]]''
 +
* ''*offset'': number
 +
* ''*limit'': number
 +
* ''*basic_only'': Boolean_flag
 
* ''format'': string
 
* ''format'': string
 
* ''key'': string
 
* ''key'': string
 
* ''version'': number
 
* ''version'': number
 
===== Return =====
 
===== Return =====
−
* ''InstitutionReturnOccurrences''
+
* [[#InstitutionReturnOccurrences (extends InstitutionReturn)|InstitutionReturnOccurrences]]
  
 
===== Example =====
 
===== Example =====
−
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionSecondaryTypes?inst_id=1&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionSecondaryTypes?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 +
 
 +
== Institution Data Type Glossary ==
 +
=== Classes ===
 +
==== InstitutionBasic ====
 +
* ''inst_id'': ''[[#inst_id|inst_id]]''
 +
* ''guid'': ''[[#guid|guid]]''
 +
* ''inst_name'': ''[[#inst_name|inst_name]]''
 +
* ''inst_code'': ''[[#inst_code|inst_code]]''
 +
* ''vouchered'': ''[[#vouchered|vouchered]]''
 +
 
 +
==== InstitutionExtended (extends [[#InstitutionBasic|InstitutionBasic]])====
 +
* ''stats'': [[#InstitutionStats|InstitutionStats]]
 +
 
 +
==== InstitutionReturnLiterature (extends [[#InstitutionReturn|InstitutionReturn]]) ====
 +
* ''literature'': array of [[OJ_Break v2 Literature Reference#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]
 +
 
 +
==== InstitutionReturnOccurrences (extends [[#InstitutionReturn|InstitutionReturn]]) ====
 +
* ''occurrences'': array of [[OJ_Break v2 Occurrence Reference#OccurrenceExtended (extends OccurrenceBasic)|OccurrenceExtended]]
 +
 
 +
==== InstitutionReturnTaxa (extends [[#InstitutionReturn|InstitutionReturn]]) ====
 +
* ''taxa'': array of [[#TaxonRelationship (extends TaxonExtended)|TaxonRelationship]]
 +
 
 +
==== InstitutionReturn ====
 +
* ''general'': [[#InstitutionBasic|InstitutionBasic]]
 +
 
 +
==== InstitutionStats ====
 +
* ''num_spms'': Number
 +
* ''num_species'': Number
 +
* ''num_primary_types'': Number
 +
* ''num_secondary_types'': Number
 +
* ''oldest_spm'': [[OJ_Break v2 Occurrence Reference#OccurrenceExtended (extends OccurrenceBasic)|OccurrenceExtended]]
 +
* ''last_spm_time'': Datetime
 +
 
 +
=== Elements ===
 +
==== guid ====
 +
GUID - Globablly Unique Identifier which uniquely identifies a resource.
 +
==== inst_code ====
 +
String - the unique identifier of a particular institution, usually present for specimen cataloguing.
 +
==== inst_id ====
 +
Number - The collection (or institution) identifier which uniquely identifies a collection, vouchered or unvouchered.
 +
==== inst_name ====
 +
String - name of the institution.
 +
==== vouchered ====
 +
Boolean_flag - value representing whether the occurrence record is vouchered or not.
  
 
== See also ==
 
== See also ==
Line 104: Line 162:
 
* [[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 Search Reference|Search]]
 
* [[OJ_Break v2 Search Reference|Search]]
 
* [[OJ_Break v2 Taxon Reference|Taxon]]
 
* [[OJ_Break v2 Taxon Reference|Taxon]]

Latest revision as of 16:35, 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 Institution 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/getInstitutionInfo?inst_id=1&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.


Institution Data Model

Procedural Reference

Institution

getInstitutionInfo

Description
Parameters
  • inst_id: inst_id
  • format: string
  • key: string
  • version: number
Return
Example
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionInfo?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getInstitutionLiterature

Description
Parameters
  • inst_id: inst_id
  • *offset: number
  • *limit: number
  • format: string
  • key: string
  • version: number
Return
Example
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionLiterature?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getInstitutionTaxa

Description
Parameters
  • inst_id: inst_id
  • *offset: number
  • *limit: number
  • format: string
  • key: string
  • version: number
Return
Example
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionTaxa?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getInstitutionOccurrences

Description
Parameters
  • inst_id: inst_id
  • *offset: number
  • *limit: number
  • *basic_only: Boolean_flag
  • format: string
  • key: string
  • version: number
Return
Example
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionOccurrences?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getInstitutionPrimaryTypes

Description
Parameters
  • inst_id: inst_id
  • *offset: number
  • *limit: number
  • *basic_only: Boolean_flag
  • format: string
  • key: string
  • version: number
Return
Example
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionPrimaryTypes?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getInstitutionSecondaryTypes

Description
Parameters
  • inst_id: inst_id
  • *offset: number
  • *limit: number
  • *basic_only: Boolean_flag
  • format: string
  • key: string
  • version: number
Return
Example
http://osuc.biosci.ohio-state.edu/OJ_Break/getInstitutionSecondaryTypes?inst_id=1&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

Institution Data Type Glossary

Classes

InstitutionBasic

InstitutionExtended (extends InstitutionBasic)

InstitutionReturnLiterature (extends InstitutionReturn)

InstitutionReturnOccurrences (extends InstitutionReturn)

InstitutionReturnTaxa (extends InstitutionReturn)

InstitutionReturn

InstitutionStats

  • num_spms: Number
  • num_species: Number
  • num_primary_types: Number
  • num_secondary_types: Number
  • oldest_spm: OccurrenceExtended
  • last_spm_time: Datetime

Elements

guid

GUID - Globablly Unique Identifier which uniquely identifies a resource.

inst_code

String - the unique identifier of a particular institution, usually present for specimen cataloguing.

inst_id

Number - The collection (or institution) identifier which uniquely identifies a collection, vouchered or unvouchered.

inst_name

String - name of the institution.

vouchered

Boolean_flag - value representing whether the occurrence record is vouchered or not.

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_Institution_Reference&oldid=2052"