Difference between revisions of "OJ Break v2 Literature Reference"
(→getLiteratureAssocationCitation) |
|||
| Line 16: | Line 16: | ||
== Procedural Reference == | == Procedural Reference == | ||
=== Literature === | === Literature === | ||
| + | ==== getCitationInfo ==== | ||
| + | ===== Description ===== | ||
| + | ===== Parameters ===== | ||
| + | * ''citation_id'': ''[[#citation_id|citation_id]]'' | ||
| + | * ''format'': string | ||
| + | * ''key'': string | ||
| + | * ''version'': number | ||
| + | ===== Return ===== | ||
| + | * LiteratureCitationBasic | ||
| + | ===== Example ===== | ||
| + | http://osuc.biosci.ohio-state.edu/OJ_Break/getCitationInfo?citation_id=234&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2 | ||
==== getLiteratureInfo ==== | ==== getLiteratureInfo ==== | ||
===== Description ===== | ===== Description ===== | ||
| Line 24: | Line 35: | ||
* ''version'': number | * ''version'': number | ||
===== Return ===== | ===== Return ===== | ||
| − | * | + | * LiteratureExtended |
===== Example ===== | ===== Example ===== | ||
| Line 39: | Line 50: | ||
* ''version'': number | * ''version'': number | ||
===== Return ===== | ===== Return ===== | ||
| − | * | + | * LiteratureReturnParts |
===== Example ===== | ===== Example ===== | ||
| Line 54: | Line 65: | ||
* ''version'': number | * ''version'': number | ||
===== Return ===== | ===== Return ===== | ||
| − | * | + | * LiteratureReturnTaxonCitation |
===== Example ===== | ===== Example ===== | ||
| Line 69: | Line 80: | ||
* ''version'': number | * ''version'': number | ||
===== Return ===== | ===== Return ===== | ||
| − | * | + | * LiteratureReturnAssociations |
===== Example ===== | ===== Example ===== | ||
Revision as of 19:23, 11 February 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
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 Literature 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/getLiteratureInfo?pub_id=234&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
Literature
getCitationInfo
Description
Parameters
- citation_id: citation_id
- format: string
- key: string
- version: number
Return
- LiteratureCitationBasic
Example
getLiteratureInfo
Description
Parameters
- pub_id: pub_id
- format: string
- key: string
- version: number
Return
- LiteratureExtended
Example
getLiteratureParts
Description
Parameters
- pub_id: pub_id
- offset: number (optional)
- limit: number (optional)
- format: string
- key: string
- version: number
Return
- LiteratureReturnParts
Example
getLiteratureTaxonCitations
Description
Parameters
- pub_id: pub_id
- offset: number (optional)
- limit: number (optional)
- format: string
- key: string
- version: number
Return
- LiteratureReturnTaxonCitation
Example
getLiteratureAssocCitations
Description
Parameters
- pub_id: pub_id
- offset: number (optional)
- limit: number (optional)
- format: string
- key: string
- version: number
Return
- LiteratureReturnAssociations
Example
See also
Visit any of the below links to find information about the other data domains defined by OJ_Break Version 2.
