proof documentation
authorGreg Gay <info@atutor.ca>
Thu, 12 Aug 2010 15:00:21 +0000 (15:00 -0000)
committerGreg Gay <info@atutor.ca>
Thu, 12 Aug 2010 15:00:21 +0000 (15:00 -0000)
docs/documentation/oauth_server_api.php

index 946804e..6419c7d 100644 (file)
@@ -19,7 +19,7 @@ include(TR_INCLUDE_PATH.'header.inc.php');
 \r
 <h1>OAuth Server API</h1>\r
 <p>AContent implements the OAuth Core 1.0 specification.</p>\r
-<p>The <a href="http://oauth.net/documentation/getting-started" target="_blank">OAuth</a> protocol enables web services consumers to access protected resources via an API without requiring users to supply the service credentials to the consumers. It's a generic methodology for unobtrusive, wire protocol level authenticated data access over HTTP.</p>\r
+<p>The <a href="http://oauth.net/documentation/getting-started" target="new">OAuth</a> protocol enables web service consumers to access protected resources via an API without requiring users to supply the service credentials to the consumers. It's a generic methodology for unobtrusive, wire protocol level authenticated data access over HTTP.</p>\r
 \r
 <p>AContent exposes the following API endpoints:</p>\r
 \r
@@ -53,7 +53,7 @@ include(TR_INCLUDE_PATH.'header.inc.php');
 \r
 <tr>\r
   <th>expire</th>\r
-  <td>Optional. The seconds that the access token is valid. The access token expires after this number of seconds since it is assigned. When "expire" is set to 0, the access token never expires.</td>\r
+  <td>Optional. The length of time in seconds that the access token is valid. The access token expires after this number of seconds since being assigned. When "expire" is set to 0, the access token never expires.</td>\r
   <td>0</td>\r
 </tr>\r
 \r
@@ -77,13 +77,13 @@ consumer_key=8862a51faa12c1b1&consumer_secret=79d591810c803167&expire=300<br />
 <pre style="background-color:#F7F3ED;"> \r
 error=Empty+parameter+%22consumer%22<br />\r
 </pre>\r
-<p>A fail response returns error message.</p> \r
+<p>A fail response returns an error message.</p> \r
 \r
 <h2 id="request_token">Request token</h2>\r
 \r
 <h3>Endpoint: </h3><p>http://server-cname/oauth/request_token.php</p>\r
 <h3>Parameters</h3><br />\r
-<p>Both GET or POST method are supported.</p>\r
+<p>Both GET or POST methods are supported.</p>\r
 \r
 <table class="data" rules="all">\r
 <tbody><tr>\r
@@ -145,7 +145,7 @@ oauth_token=086cbfe90b41a7fdf9&oauth_token_secret=55e2bd8454b2f75a21<br />
 <pre style="background-color:#F7F3ED;"> \r
 error=Consumer+is+not+registered<br />\r
 </pre>\r
-<p>A fail response returns error message.</p> \r
+<p>A fail response returns an error message.</p> \r
 \r
 <h2 id="authorization">Authorization</h2>\r
 \r
@@ -168,8 +168,8 @@ error=Consumer+is+not+registered<br />
   <td>Optional. The Consumer MAY specify a URL the Service Provider will use to redirect the User \r
   back to the Consumer along with the request token when \r
   <a href="http://oauth.net/core/1.0#auth_step2">Obtaining User Authorization</a> \r
-  is complete. If this parameter was not given or empty, the message "User is authenticated successfully" \r
-  will be returned as success response.</td>\r
+  is complete. If this parameter was not given or empty, the message "User was authenticated successfully" \r
+  will be returned as success response.</td>\r
   <td>0</td>\r
 </tr>\r
 \r
@@ -184,13 +184,13 @@ error=Consumer+is+not+registered<br />
 \r
 <span style="font-weight:bold">Success response</span>\r
 <p>Redirect the User back to the URL specified in oauth_callback along with the send-in request token "oauth_token". \r
-If oauth_callback is not given or empty, the message "User is authenticated successfully" will be returned.</p> \r
+If oauth_callback is not given or empty, the message "User was authenticated successfully" will be returned.</p> \r
 \r
 <span style="font-weight:bold">Fail response</span>\r
 <pre style="background-color:#F7F3ED;"> \r
 error=Empty+oauth+token<br />\r
 </pre>\r
-<p>A fail response returns error message.</p> \r
+<p>A fail response returns an error message.</p> \r
 \r
 <h2 id="access_token">Access token</h2>\r
 \r
@@ -217,7 +217,7 @@ error=Empty+oauth+token<br />
 <tr>\r
   <th>oauth_signature_method</th>\r
   <td>Required. The signature method the Consumer used to sign the request.</td>\r
-  <td>None. <br /> Or, One of these values: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.</td>\r
+  <td>None. <br /> Or, one of these values: HMAC-SHA1, RSA-SHA1, and PLAINTEXT.</td>\r
 </tr>\r
 \r
 <tr>\r
@@ -265,13 +265,13 @@ oauth_token=086cbfe90b41a7fdf9&oauth_token_secret=55e2bd8454b2f75a21<br />
 <pre style="background-color:#F7F3ED;"> \r
 error=Invalid+oauth+request+token<br />\r
 </pre>\r
-<p>A fail response returns error message.</p> \r
+<p>A fail response returns an error message.</p> \r
 <p>Note that the access token can be reused during the expire threshold is reached. Expire threshold is defined in the \r
 <a href="<?php echo TR_BASE_HREF;?>documentation/oauth_server_api.php#register_consumer">register consumer request</a>.</p>\r
 \r
 <h2 id="import">Import Common Cartridge or Content Package into AContent</h2>\r
-<p>Till here, with a set of token credentials, the client is now able to import common cartridge or content package into\r
-AContent as a new course. The generated course ID is returned at success. Or, an error message is returned at fail.</p>\r
+<p>Until here, with a set of token credentials, the client is now able to import common cartridges or content packages into\r
+AContent as a new lesson. The generated course ID is returned at success. Or, an error message is returned at fail.</p>\r
 <h3>Endpoint: </h3><p>http://server-cname/home/ims/ims_import.php</p>\r
 <h3>Parameters</h3><br />\r
 \r
@@ -305,7 +305,7 @@ url=http%3A%2F%2Fatutor.ca%2Fdemo%2Fmods%2F_core%2Fimscp%2Fims_export.php%3Fcid%
 <pre style="background-color:#F7F3ED;"> \r
 course_id=20<br />\r
 </pre>\r
-<p>course_id is the number ID of the newly-imported course. This ID can be used to view and download the imported course\r
+<p>course_id is the number ID of the newly-imported lesson. This ID can be used to view and download the imported lesson\r
 Refer to <a href="<?php echo TR_BASE_HREF;?>documentation/web_service_api.php">Web Service API</a> for details.</p> \r
 \r
 <span style="font-weight:bold">Fail response</span>\r
@@ -319,6 +319,6 @@ error=Cannot+create+import+directory<br />
 error=IMS+manifest+file+does+not+appear+to+be+valid<br />\r
 error=Error+at+parsing+IMS+manifest+file<br />\r
 </pre>\r
-<p>A fail response returns error message. Could be any of the above.</p> \r
+<p>A fail response returns an error message. Could be any of the above.</p> \r
 \r
 <?php include(TR_INCLUDE_PATH.'footer.inc.php'); ?>\r