Labs/Joey/CommunicationProtocol: Difference between revisions

Labs/Joey/CommunicationProtocol (view source)

Revision as of 07:05, 12 April 2007

918 bytes added , 12 April 2007

no edit summary

Juntao

10

edits

@@ Line 13: / Line 13: @@
 Response (one of the following in text format):
    * Success: Integer user ID (>0)
-   * Fail: -1 (not activated)
+   * Fail: -2 (not activated)
-   * Fail: -2 (generic error e.g., wrong password)
+   * Fail: -3 (generic error e.g., wrong password)
+  * Numeric code "-1" is reserved for "user not logged in" error
 ----
@@ Line 26: / Line 27: @@
-Response (iterate i from 1 to n):
+Response: The first line is always a numeric return code. Value "-1" indicates the user session has expired. You need to re-login and then load the /uploads/index again. A positive (or zero) integer "n" indicates the number of items in this index. The items are organized as follows (i iterates from 1 to n):
-  total=<number of entries in this batch>
    title.i=<the title>
    referrer.i=<referrer URL>
@@ Line 45: / Line 45: @@
 Response:
    * Success: 0
-   * Fail: -1
+   * User not logged in: -1
+  * Generic failure (e.g., wrong user): -2
 ----
@@ Line 63: / Line 64: @@
    * MIME type in HTTP header
    * Binary content in body
-   * Returns the default "no preview" PNG image is there is anything wrong
+Error cases (both for MIME type text/HTML):
+   * code "-1" for "user not logged in"
+  * code "-2" for other errors
+----
+/files/view/id/preview
+Request (all required):
+  * The "id" in the URL
+Response:
+  * MIME type in HTTP header
+  * Binary content in body
+Error cases (both for MIME type text/HTML):
+  * code "-1" for "user not logged in"
+  * code "-2" for other errors
+----
+/files/view/id/original
+Request (all required):
+  * The "id" in the URL
+Response:
+  * MIME type in HTTP header
+  * Binary content in body
+Error cases (both for MIME type text/HTML):
+  * code "-1" for "user not logged in"
+  * code "-2" for other errors