Changes between Version 32 and Version 33 of api_v1

Timestamp:

2012-11-06T21:34:28Z (11 years ago)

Author:

Pan Luo

Comment:

--

api_v1

@@ -21 +21 @@
   In JSON, it will be "[]".
 
+Whenever iPeer responses a result with successful status code 2xx, the response body will always one of the following:
+1. An JSON object that requested by client
+1. A collection (array) of JSON objects requested by client
+1. An empty array "[]"
+
+If there is an error occurred on the iPeer server side, an corresponding error status code will be returned along with the error message in the response body encoded in JSON.
+{{{
+{"code": 999, "message":"This is an error message"}
+}}}
 
 = Resources =
@@ -37 +46 @@
 
 === Create a User ===
-POST /v1/users
-||parameter||none||
-||input||{"role_id":"ROLE_ID","username":"USERNAME","last_name":"LAST_NAME","first_name":"FIRST_NAME"}||
-||status (success)||HTTP/1.1 201 CREATED||
+POST /v1/users\\
+POST Boby 
+{{{
+{"role_id":"ROLE_ID","username":"USERNAME","last_name":"LAST_NAME","first_name":"FIRST_NAME"}
+}}}
+||parameter||none||
 ||output (success)||{"id":"USER_ID","role_id":"ROLE_ID","username":"USERNAME","last_name":"LAST_NAME","first_name":"FIRST_NAME"}||
-||status (failure)||HTTP/1.1 500 Internal Server Error||
-||output (failure)||none||
 
 === Create Users ===