Advertisement
Guest User

Untitled

a guest
Jun 10th, 2017
521
0
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
text 3.06 KB | None | 0 0
  1. **Note: These are only sample API.**
  2. ----
  3.  
  4. **Authenticating The User**
  5. ----
  6. Returns status of the authentication. If successfull, token will be attached to the response.
  7.  
  8. * **URL**
  9.  
  10. /users/login
  11.  
  12. * **Method:**
  13.  
  14. `POST`
  15.  
  16. * **URL Params**
  17.  
  18. None
  19.  
  20. * **Data Params**
  21.  
  22. **Required:**
  23.  
  24. `username=[string]` <br />
  25. `password=[string]`
  26.  
  27. * **Success Response:**
  28.  
  29. * **Code:** 200 <br />
  30. **Content:** `{ status: success, token: 'sdasacgsgd' }`
  31.  
  32. * **Error Response:**
  33.  
  34. * **Code:** 404 NOT FOUND <br />
  35. **Content:** `{ error : "User doesn't exist" }`
  36.  
  37. OR
  38.  
  39. * **Code:** 401 UNAUTHORIZED <br />
  40. **Content:** `{ error : "User validation failed." }`
  41.  
  42. ----
  43.  
  44. **GET User**
  45. ----
  46. Returns JSON object for user.
  47.  
  48. * **URL**
  49.  
  50. /users/:id
  51.  
  52. * **Method:**
  53.  
  54. `GET`
  55.  
  56. * **URL Params**
  57.  
  58. **Required:**
  59.  
  60. `username=[string]`
  61.  
  62. * **Data Params**
  63.  
  64. None
  65.  
  66. * **Success Response:**
  67.  
  68. * **Code:** 200 <br />
  69. **Content:**
  70. `{` <br />
  71. `'first_name': 'abc',` <br />
  72. `'middle_name': 'abc',` <br />
  73. `'last_name': 'abc',` <br />
  74. `'email_id': 'abc@example.com',` <br /> `'contact_number': 123456789` <br />
  75. `}`
  76.  
  77. * **Error Response:**
  78.  
  79. * **Code:** 404 NOT FOUND <br />
  80. **Content:** `{ error : "User doesn't exist" }`
  81.  
  82. OR
  83.  
  84. * **Code:** 401 UNAUTHORIZED <br />
  85. **Content:** `{ error : "You are unauthorized to make this request.." }`
  86.  
  87. ----
  88.  
  89. **Create User**
  90. ----
  91. Returns status.
  92.  
  93. * **URL**
  94.  
  95. /users/
  96.  
  97. * **Method:**
  98.  
  99. `POST`
  100.  
  101. * **URL Params**
  102.  
  103. None
  104.  
  105. * **Data Params**
  106.  
  107. **Required:**
  108.  
  109. `{` <br />
  110. `'username': 'abc'` <br />
  111. `'first_name': 'abc',` <br />
  112. `'middle_name': 'abc',` <br />
  113. `'last_name': 'abc',` <br />
  114. `'password': 123456789` <br />
  115. `'email_id': 'abc@example.com',` <br /> `'contact_number': 123456789` <br />
  116. `}`
  117.  
  118. * **Success Response:**
  119.  
  120. * **Code:** 200 <br />
  121. **Content:** `{ 'status': 'success'}`
  122.  
  123. * **Error Response:**
  124.  
  125. * **Code:** 500 INTERNAL SERVER ERROR <br />
  126. **Content:** `{ error : "error creating new user" }`
  127.  
  128. ----
  129.  
  130. **Update User**
  131. ----
  132. Returns JSON object for user.
  133.  
  134. * **URL**
  135.  
  136. /users/:id
  137.  
  138. * **Method:**
  139.  
  140. `PUT`
  141.  
  142. * **URL Params**
  143.  
  144. **Required:**
  145.  
  146. `username=[string]`
  147.  
  148. * **Data Params**
  149.  
  150. **Required:**
  151.  
  152. `email_id=[string]` <br />
  153. `contact_number=[string]`
  154.  
  155. * **Success Response:**
  156.  
  157. * **Code:** 200 <br />
  158. **Content:** `{ 'status': 'success'}`
  159.  
  160. * **Error Response:**
  161.  
  162. * **Code:** 404 NOT FOUND <br />
  163. **Content:** `{ error : "User doesn't exist" }`
  164.  
  165. OR
  166.  
  167. * **Code:** 401 UNAUTHORIZED <br />
  168. **Content:** `{ error : "You are unauthorized to make this request.." }`
  169.  
  170. ----
  171.  
  172. **Delete User**
  173. ----
  174. Returns JSON object for user.
  175.  
  176. * **URL**
  177.  
  178. /users/:id
  179.  
  180. * **Method:**
  181.  
  182. `DELETE`
  183.  
  184. * **URL Params**
  185.  
  186. **Required:**
  187.  
  188. `username=[string]`
  189.  
  190. * **Data Params**
  191.  
  192. None
  193.  
  194. * **Success Response:**
  195.  
  196. * **Code:** 200 <br />
  197. **Content:** `{ 'status': 'success'}`
  198.  
  199. * **Error Response:**
  200.  
  201. * **Code:** 404 NOT FOUND <br />
  202. **Content:** `{ error : "User doesn't exist" }`
  203.  
  204. OR
  205.  
  206. * **Code:** 401 UNAUTHORIZED <br />
  207. **Content:** `{ error : "You are unauthorized to make this request.." }`
Advertisement
Add Comment
Please, Sign In to add comment
Advertisement