Difference between revisions of "OJ Break v2 Media Reference"
(Created page with "'''Introduction''' OJ_Break is the name of the xBio:D RESTful API service which enables the discovery of data within the xBio:D database. The API can respond with JavaScript ...") |
(→Media Data Type Glossary) |
||
| Line 25: | Line 25: | ||
* ''public'': ''[[#public|public]]'' element | * ''public'': ''[[#public|public]]'' element | ||
| − | ==== MediaExtended (extends [[#MediaBasic|MediaBasic]]) | + | ==== MediaExtended (extends [[#MediaBasic|MediaBasic]]) ==== |
* ''caption'': ''[[#caption|caption]]'' element | * ''caption'': ''[[#caption|caption]]'' element | ||
* ''copyright'': ''[[#copyright|copyright]]'' element | * ''copyright'': ''[[#copyright|copyright]]'' element | ||
| Line 48: | Line 48: | ||
=== Elements === | === Elements === | ||
| + | ==== angle ==== | ||
| + | String - | ||
| + | ==== caption ==== | ||
| + | String | ||
| + | ==== copyright ==== | ||
| + | String | ||
| + | ==== enterer ==== | ||
| + | String - | ||
| + | ==== license ==== | ||
| + | String - | ||
| + | ==== media_id ==== | ||
| + | Number - | ||
| + | ==== media_source ==== | ||
| + | String - | ||
| + | ==== media_type ==== | ||
| + | String - | ||
| + | ==== media_url ==== | ||
| + | URL - | ||
| + | ==== public ==== | ||
| + | Boolean_flag - | ||
== See also == | == See also == | ||
Revision as of 20:54, 16 April 2015
Introduction
OJ_Break is the name of the xBio:D RESTful API service which enables the 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 Media Data Type Glossary
- 2.1 Classes
- 2.1.1 ImageExtended (extends MediaExtended)
- 2.1.2 LocalityImageExtended (realizes ImageExtended)
- 2.1.3 MediaBasic
- 2.1.4 MediaExtended (extends MediaBasic)
- 2.1.5 OccurrenceImageExtended (realizes ImageExtended)
- 2.1.6 OccurrenceRecordingExtended (realizes MediaExtended)
- 2.1.7 TaxonImageExtended (realizes ImageExtended)
- 2.1.8 VideaExtended (realizes ImageExtended)
- 2.2 Elements
- 2.1 Classes
- 3 See also
API Information and Access
This page specifies the data defined by OJ_Break Version 2, more precisely those that are defined by the Media data domain. To get information on any of the other data domains defined in OJ_Break Version 2, visit the See also section.
Media Data Type Glossary
Classes
ImageExtended (extends MediaExtended)
- thumb: URL
- raw: URL
LocalityImageExtended (realizes ImageExtended)
- locality: LocalityBasic
MediaBasic
- media_id: media_id element
- media_type: media_type element
- media_url: media_url element
- media_source: media_source element
- public: public element
MediaExtended (extends MediaBasic)
- caption: caption element
- copyright: copyright element
- license: license element
- enterer: enterer element
OccurrenceImageExtended (realizes ImageExtended)
- occurrence: OccurrenceTrimmed
- parts: array of part element
- angle: angle
- technique: technique element
- notes: String
OccurrenceRecordingExtended (realizes MediaExtended)
- occurrence: OccurrenceTrimmed
TaxonImageExtended (realizes ImageExtended)
- taxon: TaxonBasic
VideaExtended (realizes ImageExtended)
- taxon: TaxonBasic
Elements
angle
String -
caption
String
copyright
String
enterer
String -
license
String -
media_id
Number -
media_source
String -
media_type
String -
media_url
URL -
public
Boolean_flag -
See also
Visit any of the below links to find information about the other data domains defined by OJ_Break Version 2.
