Difference between revisions of "OJ Break v2 Institution Reference"

From xBio:D Wiki
Jump to navigation Jump to search
(→‎Classes)
(→‎Institution Data Type Glossary)
Line 111: Line 111:
 
=== Classes ===
 
=== Classes ===
 
==== InstitutionBasic ====
 
==== InstitutionBasic ====
−
* ''inst_id'': ''[[#inst_id|inst_id]]'' element
+
* ''inst_id'': ''[[#inst_id|inst_id]]''
 
* ''guid'': ''guid''
 
* ''guid'': ''guid''
−
* ''inst_name'': ''[[#inst_name|inst_name]]'' element
+
* ''inst_name'': ''[[#inst_name|inst_name]]''
−
* ''inst_code'': ''[[#inst_code|inst_code]]'' element
+
* ''inst_code'': ''[[#inst_code|inst_code]]''
−
* ''vouchered'': ''[[#vouchered|vouchered]]'' element
+
* ''vouchered'': ''[[#vouchered|vouchered]]''
  
 
==== InstitutionExtended (extends [[#InstitutionBasic|InstitutionBasic]])====
 
==== InstitutionExtended (extends [[#InstitutionBasic|InstitutionBasic]])====
−
* ''stats'': [[#InstitutionStats|InstitutionStats]] class
+
* ''stats'': [[#InstitutionStats|InstitutionStats]]
  
 
==== InstitutionReturnLiterature (extends [[#InstitutionReturn|InstitutionReturn]]) ====
 
==== InstitutionReturnLiterature (extends [[#InstitutionReturn|InstitutionReturn]]) ====
−
* ''literature'': array of [[OJ_Break v2 Literature Reference#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]] class
+
* ''literature'': array of [[OJ_Break v2 Literature Reference#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]
  
 
==== InstitutionReturnOccurrences (extends [[#InstitutionReturn|InstitutionReturn]]) ====
 
==== InstitutionReturnOccurrences (extends [[#InstitutionReturn|InstitutionReturn]]) ====
−
* ''occurrences'': array of [[OJ_Break v2 Occurrence Reference#OccurrenceExtended_.28extends_OccurrenceBasic.29|OccurrenceExtended]] class
+
* ''occurrences'': array of [[OJ_Break v2 Occurrence Reference#OccurrenceExtended_.28extends_OccurrenceBasic.29|OccurrenceExtended]]
  
 
==== InstitutionReturnTaxa (extends [[#InstitutionReturn|InstitutionReturn]]) ====
 
==== InstitutionReturnTaxa (extends [[#InstitutionReturn|InstitutionReturn]]) ====
−
* ''taxa'': array of [[#TaxonRelationship_.28extends_TaxonExtended.29|TaxonRelationship]] class
+
* ''taxa'': array of [[#TaxonRelationship_.28extends_TaxonExtended.29|TaxonRelationship]]
  
 
==== InstitutionReturn ====
 
==== InstitutionReturn ====
−
* ''general'': [[#InstitutionBasic|InstitutionBasic]] class
+
* ''general'': [[#InstitutionBasic|InstitutionBasic]]
  
 
==== InstitutionStats ====
 
==== InstitutionStats ====
Line 137: Line 137:
 
* ''num_primary_types'': Number
 
* ''num_primary_types'': Number
 
* ''num_secondary_types'': Number
 
* ''num_secondary_types'': Number
−
* ''oldest_spm'': [[OJ_Break v2 Occurrence Reference#OccurrenceExtended|OccurrenceExtended]] class
+
* ''oldest_spm'': [[OJ_Break v2 Occurrence Reference#OccurrenceExtended|OccurrenceExtended]]
−
* ''last_spm_time'': Datetime class
+
* ''last_spm_time'': Datetime
  
 
=== Elements ===
 
=== Elements ===

Revision as of 21:33, 16 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.

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

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=json&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=json&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=json&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=json&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=json&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=json&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

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