OJ Break v2 Agent Reference

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 Agent 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/getAgentInfo?agent_id=2&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.

Agent Data Model

Procedural Reference

Agent

getAgentInfo

Parameters

• agent_id: agent_id
• format: string
• key: string
• version: number

Return

• AgentComplete

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentInfo?agent_id=2&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getAgentLiterature

Parameters

• agent_id: agent_id
• *offset: number
• *limit: number
• format: string
• key: string
• version: number

Return

• AgentReturnLiterature

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentLiterature?agent_id=2&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getAgentTaxa

Parameters

• agent_id: agent_id
• *offset: number
• *limit: number
• format: string
• key: string
• version: number

Return

• AgentReturnTaxa

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentTaxa?agent_id=2&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

getAgentOccurrences

Parameters

• agent_id: agent_id
• *offset: number
• *limit: number
• *basic_only: Boolean_flag
• format: string
• key: string
• version: number

Return

• AgentReturnOccurrences

Example

http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentOccurrences?agent_id=2&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2

Agent Data Type Glossary

Classes

AgentBasic

• agent_id: agent_id
• agent_type: agent_type
• agent_name: agent_name

AgentComplete (extends AgentExtended)

• stats: AgentStats

AgentReturn

• general: AgentBasic

AgentReturnLiterature (extends AgentReturn)

• literature: array of LiteratureExtended

AgentReturnOccurrences (extends AgentReturn)

• occurrences: array of OccurrenceExtended

AgentReturnTaxa (extends AgentReturn)

• taxa: array of TaxonRelationship

AgentStats

• num_spms: Number
• num_coll_events: Number
• num_pubs: Number

PartyComplete (realizes AgentComplete)

• people: array of PersonComplete

PartyExtended (realizes AgentExtended)

• people: array of PersonExtended

PersonAddress

• full_address: String
• address1: String
• address2: String
• address3: String
• address4: String
• city: String
• state: String
• zip_code: String
• country: String

PersonComplete (realizes AgentComplete)

• title: String
• institution: InstitutionBasic
• contact: PersonContact
• bio: String
• year_born: Number
• year_died: Number
• gender: gender
• image: URL
• synonyms: array of PersonExtended

PersonContact

• address: PersonAddress
• email: Email
• phone: Phone
• fax: Phone
• web: URL

PersonExtended (realizes AgentExtended)

• last_name: last_name element
• first_name: first_name element
• initials: initials element
• generation: generation element
• name_order: name_order element
• person_icon: person_icon element
• preferred_name: preferred_name element

Elements

agent_id

Number - An identifier which uniquely identifies an agent.

agent_type

String - a single word description of the agent. Can be either "PERSON" or "PARTY".

agent_name

String - An agent's full name. If the agent is a party, all names in the party are included and comma separated.

last_name

String - A agent's last name (surname).

first_name

String - A agent's first name.

gender

String - A one letter designation for the gender of the agent (F => Female, M => Male, U => Unknown / Unspecified).

initials

String - The initials for the given name of an agent.

generation

String - The generational designation (Jr., III, etc.) for an agent.

name_order

String - An indicator specifying whether an agent's name should be formatted according to western (W) or eastern (E) conventions.

person_icon

URL - URL location of thumbnail of an agent.

preferred_name

String - A agent's preferred name.

See also

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

• Geographic Place
• Institution
• Journal
• Literature
• Locality
• Media
• Occurrence
• Search
• Taxon