OJ Break API Access - Revision history

Tyler: /* Arguments */

2015-04-22T20:51:08Z

‎Arguments

Tyler at 20:49, 22 April 2015

2015-04-22T20:49:48Z

Jcora: /* format */

2015-04-13T16:21:08Z

‎format

Jcora at 16:20, 13 April 2015

2015-04-13T16:20:00Z

Jcora: /* format */

2015-04-13T16:12:52Z

‎format

Tyler: /* data */

2014-12-09T16:23:04Z

‎data

Tyler: /* code */

2014-12-09T16:21:35Z

‎code

Tyler: /* code */

2014-12-09T16:20:27Z

‎code

Tyler: /* Getting a Key */

2014-12-09T16:19:34Z

‎Getting a Key

Tyler: /* Getting a Key */

2014-12-09T16:18:07Z

‎Getting a Key

@@ Line 16: / Line 16: @@
 When calling a method, the corresponding parameters necessary must be included and have valid values. All methods and their parameters are included in the [[OJ_Break API Help]] page. In the example below, the method [[OJ Break API Help#getTaxonStats|getTaxonStats]] needs the parameter [[OJ Break API Data Type Glossary#tnuid_2|tnuid]] to return the desired data.
-     Example: http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonInfo?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 === ''format'' ===
@@ Line 22: / Line 22: @@
 *'''''json''''': JavaScript Object Notation is a lightweight data-interchange format made up of objects and arrays. Arrays can hold many elements of one data type, and objects can hold keys with associated values of many data types.
-     Example: http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonInfo?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 * '''''xml''''': Extensible Markup Language is a hierarchy based data-structure that is easy to read by humans. The language is made up of tags, similar to HTML, to display data. Instead of data types, the '''xml''' parameter assigns each tag a ''type'' attribute that signifies the type of the tag value.
-     Example: http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&format=xml&key=FBF57A9F7A666FC0E0430100007F0CDC
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonInfo?tnuid=30148&format=xml&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 * '''''html''''': Hypertext Markup Language is the foundational language for the world wide web. Since web browsers are designed to interpret and display HTML, this is the most human-readable format and should generally not be used for machine-to-machine transactions.
-     Example: http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonInfo?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 * '''''jsonp''''': JavaScript Object Notation with Padding returns the data in the JSON format but wrapped within a specified '''callback''' argument for procedural calls.
-     Example: http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&callback=api&format=jsonp&key=FBF57A9F7A666FC0E0430100007F0CDC
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonInfo?tnuid=30148&callback=api&format=jsonp&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 === ''callback'' ===
 The ''callback'' parameter is only necessary when ''format'' is specified as '''jsonp'''. This gives a procedural call to the value given by ''callback'' with the data retrieved.
-     Example: http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&callback=test&format=jsonp&key=FBF57A9F7A666FC0E0430100007F0CDC
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonInfo?tnuid=30148&callback=test&format=jsonp&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2
 === ''key'' ===

@@ Line 5: / Line 5: @@
 == Overview ==
-All API requests must be formatted by first selecting the OJ_Break library then specifying the API method. Also, each method must include a ''format'' and ''key'' argument.
+All API requests must be formatted by first selecting the OJ_Break library then specifying the API method. Also, each method must include a ''format'', ''key'', and ''version'' argument.
 The format for API calls is: '''''<nowiki>http://xbiod.osu.edu/OJ_Break/[method]?[argument1]=[value1]&...</nowiki>'''''
-     Example: '''''<nowiki>http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC</nowiki>'''''
+     Example: '''''<nowiki>http://xbiod.osu.edu/OJ_Break/getTaxonInfo?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC&version=2</nowiki>'''''
 The response for an API call will include a success or error code, a corresponding response message, and the included data returned by the method call displayed according to the value of the ''format'' parameter.
@@ Line 19: / Line 19: @@
 === ''format'' ===
-The ''format'' parameter specifies the structure of the data being received by an API call. The value for the parameter can be either '''json''', '''jsonp''', '''html''', or '''xml'''.
+The ''format'' parameter specifies the structure of the data being received by an API call. The value for the parameter can be either '''json''' (default), '''jsonp''', '''html''', or '''xml'''.
 *'''''json''''': JavaScript Object Notation is a lightweight data-interchange format made up of objects and arrays. Arrays can hold many elements of one data type, and objects can hold keys with associated values of many data types.

@@ Line 19: / Line 19: @@
 === ''format'' ===
-The ''format'' parameter specifies the structure of the data being received by an API call. The value for the parameter can be either '''json''', '''jsonp''', or '''xml'''.
+The ''format'' parameter specifies the structure of the data being received by an API call. The value for the parameter can be either '''json''', '''jsonp''', '''html''', or '''xml'''.
 *'''''json''''': JavaScript Object Notation is a lightweight data-interchange format made up of objects and arrays. Arrays can hold many elements of one data type, and objects can hold keys with associated values of many data types.

@@ Line 6: / Line 6: @@
 == Overview ==
 All API requests must be formatted by first selecting the OJ_Break library then specifying the API method. Also, each method must include a ''format'' and ''key'' argument.
-The format for API calls is: '''''<nowiki>http://osuc.biosci.ohio-state.edu/OJ_Break/[method]?[argument1]=[value1]&...</nowiki>'''''
+The format for API calls is: '''''<nowiki>http://xbiod.osu.edu/OJ_Break/[method]?[argument1]=[value1]&...</nowiki>'''''
-     Example: '''''<nowiki>http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC</nowiki>'''''
+     Example: '''''<nowiki>http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC</nowiki>'''''
 The response for an API call will include a success or error code, a corresponding response message, and the included data returned by the method call displayed according to the value of the ''format'' parameter.
@@ Line 16: / Line 16: @@
 When calling a method, the corresponding parameters necessary must be included and have valid values. All methods and their parameters are included in the [[OJ_Break API Help]] page. In the example below, the method [[OJ Break API Help#getTaxonStats|getTaxonStats]] needs the parameter [[OJ Break API Data Type Glossary#tnuid_2|tnuid]] to return the desired data.
-     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 === ''format'' ===
@@ Line 22: / Line 22: @@
 *'''''json''''': JavaScript Object Notation is a lightweight data-interchange format made up of objects and arrays. Arrays can hold many elements of one data type, and objects can hold keys with associated values of many data types.
-     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&format=json&key=FBF57A9F7A666FC0E0430100007F0CDC
 * '''''xml''''': Extensible Markup Language is a hierarchy based data-structure that is easy to read by humans. The language is made up of tags, similar to HTML, to display data. Instead of data types, the '''xml''' parameter assigns each tag a ''type'' attribute that signifies the type of the tag value.
-     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStats?tnuid=30148&format=xml&key=FBF57A9F7A666FC0E0430100007F0CDC
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&format=xml&key=FBF57A9F7A666FC0E0430100007F0CDC
 * '''''html''''': Hypertext Markup Language is the foundational language for the world wide web. Since web browsers are designed to interpret and display HTML, this is the most human-readable format and should generally not be used for machine-to-machine transactions.
-     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStats?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&format=html&key=FBF57A9F7A666FC0E0430100007F0CDC
 * '''''jsonp''''': JavaScript Object Notation with Padding returns the data in the JSON format but wrapped within a specified '''callback''' argument for procedural calls.
-     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStats?tnuid=30148&callback=api&format=jsonp&key=FBF57A9F7A666FC0E0430100007F0CDC
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&callback=api&format=jsonp&key=FBF57A9F7A666FC0E0430100007F0CDC
 === ''callback'' ===
 The ''callback'' parameter is only necessary when ''format'' is specified as '''jsonp'''. This gives a procedural call to the value given by ''callback'' with the data retrieved.
-     Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStats?tnuid=30148&callback=test&format=jsonp&key=FBF57A9F7A666FC0E0430100007F0CDC
+     Example: http://xbiod.osu.edu/OJ_Break/getTaxonStats?tnuid=30148&callback=test&format=jsonp&key=FBF57A9F7A666FC0E0430100007F0CDC
 === ''key'' ===

@@ Line 26: / Line 26: @@
 * '''''xml''''': Extensible Markup Language is a hierarchy based data-structure that is easy to read by humans. The language is made up of tags, similar to HTML, to display data. Instead of data types, the '''xml''' parameter assigns each tag a ''type'' attribute that signifies the type of the tag value.
      Example: http://osuc.biosci.ohio-state.edu/OJ_Break/getTaxonStats?tnuid=30148&format=xml&key=FBF57A9F7A666FC0E0430100007F0CDC
 * '''''jsonp''''': JavaScript Object Notation with Padding returns the data in the JSON format but wrapped within a specified '''callback''' argument for procedural calls.

@@ Line 79: / Line 79: @@
 === ''data'' ===
-All of the returned information from the method will be found organized in the ''data'' key/tag. This information will only be present with a successful API retrieval.
+All of the returned information from the API call will be found organized in the ''data'' key/tag. This information will only be present with a successful API retrieval.
 [[Category:OJ_Break API]]

@@ Line 59: / Line 59: @@
 '''code:[''code''], message:[''code message''], data:[''method return'']'''
 === ''code'' ===
-[[File:API_Access_tut_error.png|alt=A popup containing an error message stating that access is denied to the API.|frame|none|An example of an error alert.]]
+[[File:API_Access_tut_error.png|alt=A popup containing an error message stating that access is denied to the API.|frame|none|An example of an error alert. Error code 901 is shown to help describe possible causes.]]
 The ''code'' key/tag contains a three digit number whose value depends on the state of the API request. Below is a list of all possible codes and their significance.

@@ Line 41: / Line 41: @@
 To get an API access key, go to the [http://osuc-mgr.osu.edu/ Database Manager website] and sign up or sign in with a valid username and password.
-[[File:API_Access_tut_login.png|frame|none|The username and passwords fields to sign into Database Manager. If an account needs to be created, clicking the sign up button redirects to an account creation page.|link=http://osuc-mgr.osu.edu/]]
+[[File:API_Access_tut_login.png|frame|none|Shown are the username and passwords fields to sign into Database Manager. If an account needs to be created, clicking the sign up button redirects to an account creation page.|link=http://osuc-mgr.osu.edu/]]
 On the left side of the screen, click on '''Manage API Access'''.
-[[File:API_Access_tut_manage.png|frame|none|The Manage API Access link. This link will bring up the API Access page.|link=http://osuc-mgr.osu.edu/]]
+[[File:API_Access_tut_manage.png|frame|none|The Manage API Access link is shown. This link will bring up the API Access page.|link=http://osuc-mgr.osu.edu/]]
 Finally, click the '''Set Up Access''' button next to the 'API Key:' text. A unique access key will appear.
-[[File:API_Access_tut2.png|frame|none|The API Key button on the API Access page. Clicking the Set Up Access button will reveal a unique database key.|link=http://osuc-mgr.osu.edu/]]
+[[File:API_Access_tut2.png|frame|none|Shown here is the API Key button on the API Access page. Clicking the Set Up Access button will reveal a unique database key.|link=http://osuc-mgr.osu.edu/]]
 == Responses ==