OJ Break v2 Media Reference

From xBio:D Wiki
Revision as of 16:38, 9 June 2015 by Jcora (talk | contribs) (API Information and Access)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to navigation Jump to search

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

Media Data Type Glossary

Classes

ImageExtended (extends MediaExtended)

  • thumb: URL
  • raw: URL

LocalityImageExtended (realizes ImageExtended)

MediaBasic

MediaExtended (extends MediaBasic)

OccurrenceImageExtended (realizes ImageExtended)

OccurrenceRecordingExtended (realizes MediaExtended)

TaxonImageExtended (realizes ImageExtended)

VideaExtended (realizes ImageExtended)

Elements

angle

String - A description of the angle the media was taken.

caption

String - A summary of the media.

copyright

String - Copyright information.

enterer

String - The media enterer's name.

license

String - Licensing information.

media_id

Number - A numeric identifier that uniquely identifies a media piece.

media_source

String - The name of the source of the media.

media_type

String - A description of the type of the media.

media_url

URL - The location to the media file.

part

String - A description of the body part of the specimen the image shows.

public

Boolean_flag - A flag that specifies whether or not the media is public.

technique

String - A description of the method by which the media was taken.

See also

Visit any of the below links to find information about the other data domains defined by OJ_Break Version 2.