Difference between revisions of "OJ Break v2 Agent Reference"
(→Elements) |
|||
| Line 150: | Line 150: | ||
=== Elements === | === Elements === | ||
==== agent_id ==== | ==== agent_id ==== | ||
| − | Number - | + | Number - An identifier which uniquely identifies an agent. |
==== agent_type ==== | ==== agent_type ==== | ||
| − | + | String - a single word description of the agent. Can be either "PERSON" or "PARTY". | |
==== agent_name ==== | ==== agent_name ==== | ||
| − | String - | + | String - An agent's full name. If the agent is a party, all names in the party are included and comma separated. |
==== last_name ==== | ==== last_name ==== | ||
| − | String - | + | String - A agent's last name (surname). |
==== first_name ==== | ==== first_name ==== | ||
| − | String - | + | String - A agent's first name. |
==== initials ==== | ==== initials ==== | ||
| − | String - | + | String - The initials for the given name of an agent. |
==== generation ==== | ==== generation ==== | ||
| − | String - | + | String - The generational designation (Jr., III, etc.) for an agent. |
==== name_order ==== | ==== name_order ==== | ||
| − | String - | + | String - An indicator specifying whether an agent's name should be formatted according to western (W) or eastern (E) conventions. |
==== person_icon ==== | ==== person_icon ==== | ||
| − | URL - | + | URL - URL location of thumbnail of an agent. |
==== preferred_name ==== | ==== preferred_name ==== | ||
| − | String - | + | String - A agent's preferred name. |
== See also == | == See also == | ||
Revision as of 19:31, 15 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.
Contents
- 1 API Information and Access
- 2 Procedural Reference
- 3 Agent Data Type Glossary
- 3.1 Classes
- 3.1.1 AgentBasic
- 3.1.2 AgentComplete (extends AgentExtended)
- 3.1.3 AgentExtended (extends AgentBasic)
- 3.1.4 AgentReturn
- 3.1.5 AgentReturnLiterature (extends AgentReturn)
- 3.1.6 AgentReturnOccurrences (extends AgentReturn)
- 3.1.7 AgentReturnTaxa (extends AgentReturn)
- 3.1.8 AgentStats
- 3.1.9 PartyComplete (realizes AgentComplete)
- 3.1.10 PartyExtended (realizes AgentExtended)
- 3.1.11 PersonAddress
- 3.1.12 PersonComplete (realizes AgentComplete)
- 3.1.13 PersonContact
- 3.1.14 PersonExtended (realizes AgentExtended)
- 3.2 Elements
- 3.1 Classes
- 4 See also
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=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
Agent
getAgentInfo
Description
Parameters
- agent_id: agent_id
- format: string
- key: string
- version: number
Return
Example
getAgentLiterature
Description
Parameters
- agent_id: agent_id
- *offset: number
- *limit: number
- format: string
- key: string
- version: number
Return
Example
getAgentTaxa
Description
Parameters
- agent_id: agent_id
- *offset: number
- *limit: number
- format: string
- key: string
- version: number
Return
Example
getAgentOccurrences
Description
Parameters
- agent_id: agent_id
- *offset: number
- *limit: number
- *basic_only: Boolean_flag
- format: string
- key: string
- version: number
Return
Example
Agent Data Type Glossary
Classes
AgentBasic
- agent_id: agent_id element
- agent_type: agent_type element
- agent_name: agent_name element
AgentComplete (extends AgentExtended)
- stats: AgentStats class
AgentExtended (extends AgentBasic)
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
- image: URL
- synonyms: array of PersonExtended
PersonContact
- address: PersonAddress
- email: Email
- phone: Phone
- fax: Phone
- web: URL
PersonExtended (realizes AgentExtended)
- last_name: last_name
- first_name: first_name
- initials: initials
- generation: generation
- name_order: name_order
- person_icon: person_icon
- preferred_name: preferred_name
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.
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.
