OJ Break v2 Agent Reference - Revision history

Jcora: /* Elements */

2015-06-29T19:18:11Z

‎Elements

Jcora: /* PersonComplete (realizes AgentComplete) */

2015-06-29T19:16:24Z

‎PersonComplete (realizes AgentComplete)

Jcora: /* API Information and Access */

2015-06-09T16:34:04Z

‎API Information and Access

Jcora: /* API Information and Access */

2015-06-09T16:28:02Z

‎API Information and Access

Tyler: /* API Information and Access */

2015-04-22T20:33:08Z

‎API Information and Access

Tyler at 20:23, 22 April 2015

2015-04-22T20:23:22Z

Tyler: /* Agent */

2015-04-20T19:54:10Z

‎Agent

Tyler at 19:27, 20 April 2015

2015-04-20T19:27:49Z

Tyler at 21:27, 16 April 2015

2015-04-16T21:27:53Z

Tyler at 20:25, 16 April 2015

2015-04-16T20:25:48Z

@@ Line 162: / Line 162: @@
 ==== first_name ====
 String - A agent's first name.
 ==== initials ====
 String - The initials for the given name of an agent.

@@ Line 131: / Line 131: @@
 * ''year_born'': Number
 * ''year_died'': Number
 * ''image'': URL
 * ''synonyms'': array of [[#PersonExtended (realizes AgentExtended)|PersonExtended]]

← Older revision		Revision as of 16:34, 9 June 2015
Line 13:		Line 13:

	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]].		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]].
		+

	[[File:OJ_Break Data Model - Agent.png\|none\|frame\|Agent Data Model]]		[[File:OJ_Break Data Model - Agent.png\|none\|frame\|Agent Data Model]]

← Older revision		Revision as of 16:28, 9 June 2015
Line 13:		Line 13:

	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]].		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]].
		+
		+	[[File:OJ_Break Data Model - Agent.png\|none\|frame\|Agent Data Model]]

	== Procedural Reference ==		== Procedural Reference ==

@@ Line 10: / Line 10: @@
 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
+     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]].

@@ Line 1: / Line 1: @@
 '''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 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.
@@ Line 27: / Line 27: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentInfo?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentInfo?agent_id=2&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getAgentLiterature ====
@@ Line 42: / Line 42: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentLiterature?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentLiterature?agent_id=2&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getAgentTaxa ====
@@ Line 57: / Line 57: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentTaxa?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentTaxa?agent_id=2&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 ==== getAgentOccurrences ====
@@ Line 73: / Line 73: @@
 ===== Example =====
-  http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentOccurrences?agent_id=2&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
+  http://osuc.biosci.ohio-state.edu/OJ_Break/getAgentOccurrences?agent_id=2&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 == Agent Data Type Glossary ==

@@ Line 24: / Line 24: @@
 * ''version'': number
 ===== Return =====
-* [[#AgentComplete_.28extends_AgentExtended.29|AgentComplete]]
+* [[#AgentComplete (extends AgentExtended)|AgentComplete]]
 ===== Example =====
@@ Line 39: / Line 39: @@
 * ''version'': number
 ===== Return =====
-* [[#AgentReturnLiterature_.28extends_AgentReturn.29|AgentReturnLiterature]]
+* [[#AgentReturnLiterature (extends AgentReturn)|AgentReturnLiterature]]
 ===== Example =====
@@ Line 54: / Line 54: @@
 * ''version'': number
 ===== Return =====
-* [[#AgentReturnTaxa_.28extends_AgentReturn.29|AgentReturnTaxa]]
+* [[#AgentReturnTaxa (extends AgentReturn)|AgentReturnTaxa]]
 ===== Example =====
@@ Line 70: / Line 70: @@
 * ''version'': number
 ===== Return =====
-* [[#AgentReturnOccurrences_.28extends_AgentReturn.29|AgentReturnOccurrences]]
+* [[#AgentReturnOccurrences (extends AgentReturn)|AgentReturnOccurrences]]
 ===== Example =====
@@ Line 83: / Line 83: @@
 * ''agent_name'': ''[[#agent_name|agent_name]]''
-==== AgentComplete (extends [[#AgentExtended_.28extends_AgentBasic.29|AgentExtended]]) ====
+==== AgentComplete (extends [[#AgentExtended (extends AgentBasic)|AgentExtended]]) ====
 * ''stats'': [[#AgentStats|AgentStats]]
@@ Line 92: / Line 92: @@
 ==== AgentReturnLiterature (extends [[#AgentReturn|AgentReturn]]) ====
-* ''literature'': array of [[OJ_Break v2 Literature Reference#LiteratureExtended_.28extends_LiteratureBasic.29|LiteratureExtended]]
+* ''literature'': array of [[OJ_Break v2 Literature Reference#LiteratureExtended (extends LiteratureBasic)|LiteratureExtended]]
 ==== AgentReturnOccurrences (extends [[#AgentReturn|AgentReturn]]) ====
-* ''occurrences'': array of [[OJ_Break v2 Occurrence Reference#OccurrenceExtended_.28extends_OccurrenceBasic.29|OccurrenceExtended]]
+* ''occurrences'': array of [[OJ_Break v2 Occurrence Reference#OccurrenceExtended (extends OccurrenceBasic)|OccurrenceExtended]]
 ==== AgentReturnTaxa (extends [[#AgentReturn|AgentReturn]]) ====
-* ''taxa'': array of [[OJ_Break v2 Taxon Reference#TaxonRelationship_.28extends_TaxonExtended.29|TaxonRelationship]]
+* ''taxa'': array of [[OJ_Break v2 Taxon Reference#TaxonRelationship (extends TaxonExtended)|TaxonRelationship]]
 ==== AgentStats ====
@@ Line 105: / Line 105: @@
 * ''num_pubs'': Number
-==== PartyComplete (realizes [[#AgentComplete_.28extends_AgentExtended.29|AgentComplete]]) ====
+==== PartyComplete (realizes [[#AgentComplete (extends AgentExtended)|AgentComplete]]) ====
-* ''people'': array of [[#PersonComplete_.28realizes_AgentComplete.29|PersonComplete]]
+* ''people'': array of [[#PersonComplete (realizes AgentComplete)|PersonComplete]]
-==== PartyExtended (realizes [[#AgentExtended_.28extends_AgentBasic.29|AgentExtended]]) ====
+==== PartyExtended (realizes [[#AgentExtended (extends AgentBasic)|AgentExtended]]) ====
-* ''people'': array of [[#PersonExtended_.28realizes_AgentExtended.29|PersonExtended]]
+* ''people'': array of [[#PersonExtended (realizes AgentExtended)|PersonExtended]]
 ==== PersonAddress ====
@@ Line 122: / Line 122: @@
 * ''country'': String
-==== PersonComplete (realizes [[#AgentComplete_.28extends_AgentExtended.29|AgentComplete]]) ====
+==== PersonComplete (realizes [[#AgentComplete (extends AgentExtended)|AgentComplete]]) ====
 * ''title'': String
 * ''institution'': [[OJ_Break v2 Institution Reference#InstitutionBasic|InstitutionBasic]]
@@ Line 130: / Line 130: @@
 * ''year_died'': Number
 * ''image'': URL
-* ''synonyms'': array of [[#PersonExtended_.28realizes_AgentExtended.29|PersonExtended]]
+* ''synonyms'': array of [[#PersonExtended (realizes AgentExtended)|PersonExtended]]
 ==== PersonContact ====
@@ Line 139: / Line 139: @@
 * ''web'': URL
-==== PersonExtended (realizes [[#AgentExtended_.28extends_AgentBasic.29|AgentExtended]]) ====
+==== PersonExtended (realizes [[#AgentExtended (extends AgentBasic)|AgentExtended]]) ====
 * ''last_name'': ''[[#last_name|last_name]]'' element
 * ''first_name'': ''[[#first_name|first_name]]'' element

@@ Line 19: / Line 19: @@
 ===== Description =====
 ===== Parameters =====
-* ''agent_id'': ''agent_id''
+* ''agent_id'': ''[[#agent_id|agent_id]]''
 * ''format'': string
 * ''key'': string
@@ Line 32: / Line 32: @@
 ===== Description =====
 ===== Parameters =====
-* ''agent_id'': ''agent_id''
+* ''agent_id'': ''[[#agent_id|agent_id]]''
 * ''*offset'': number
 * ''*limit'': number
@@ Line 47: / Line 47: @@
 ===== Description =====
 ===== Parameters =====
-* ''agent_id'': ''agent_id''
+* ''agent_id'': ''[[#agent_id|agent_id]]''
 * ''*offset'': number
 * ''*limit'': number
@@ Line 62: / Line 62: @@
 ===== Description =====
 ===== Parameters =====
-* ''agent_id'': ''agent_id''
+* ''agent_id'': ''[[#agent_id|agent_id]]''
 * ''*offset'': number
 * ''*limit'': number
@@ Line 79: / Line 79: @@
 === Classes===
 ==== AgentBasic ====
-* ''agent_id'': ''[[#agent_id|agent_id]]'' element
+* ''agent_id'': ''[[#agent_id|agent_id]]''
-* ''agent_type'': ''[[#agent_type|agent_type]]'' element
+* ''agent_type'': ''[[#agent_type|agent_type]]''
-* ''agent_name'': ''[[#agent_name|agent_name]]'' element
+* ''agent_name'': ''[[#agent_name|agent_name]]''
 ==== AgentComplete (extends [[#AgentExtended_.28extends_AgentBasic.29|AgentExtended]]) ====
@@ Line 178: / Line 178: @@
 * [[OJ_Break v2 Literature Reference|Literature]]
 * [[OJ_Break v2 Locality Reference|Locality]]
 * [[OJ_Break v2 Occurrence Reference|Occurrence]]
 * [[OJ_Break v2 Search Reference|Search]]
 * [[OJ_Break v2 Taxon Reference|Taxon]]

@@ Line 84: / Line 84: @@
 ==== AgentComplete (extends [[#AgentExtended_.28extends_AgentBasic.29|AgentExtended]]) ====
-* ''stats'': [[#AgentStats|AgentStats]] class
+* ''stats'': [[#AgentStats|AgentStats]]
 ==== AgentExtended (extends [[#AgentBasic|AgentBasic]]) ====
@@ Line 140: / Line 140: @@
 ==== PersonExtended (realizes [[#AgentExtended_.28extends_AgentBasic.29|AgentExtended]]) ====
-* ''last_name'': ''[[#last_name|last_name]]''
+* ''last_name'': ''[[#last_name|last_name]]'' element
-* ''first_name'': ''[[#first_name|first_name]]''
+* ''first_name'': ''[[#first_name|first_name]]'' element
-* ''initials'': ''[[#initials|initials]]''
+* ''initials'': ''[[#initials|initials]]'' element
-* ''generation'': ''[[#generation|generation]]''
+* ''generation'': ''[[#generation|generation]]'' element
-* ''name_order'': ''[[#name_order|name_order]]''
+* ''name_order'': ''[[#name_order|name_order]]'' element
-* ''person_icon'': ''[[#person_icon|person_icon]]''
+* ''person_icon'': ''[[#person_icon|person_icon]]'' element
-* ''preferred_name'': ''[[#preferred_name|preferred_name]]''
+* ''preferred_name'': ''[[#preferred_name|preferred_name]]'' element
 === Elements ===