Changes between Version 7 and Version 8 of api_v1


Ignore:
Timestamp:
2012-09-24T19:40:42Z (12 years ago)
Author:
michael
Comment:

updated the Users api

Legend:

Unmodified
Added
Removed
Modified

  • api_v1

    v7 v8  
    1111
    1212||GET||/v1/users||get a list of users||
     13|| ||parameter||none||
     14|| ||input||none||
     15|| ||status (success)||HTTP/1.0 200 OK||
     16|| ||output (success)||[{"id":"USER0_ID","role_id":"ROLE_ID","username":"USERNAME0","last_name":"LAST_NAME","first_name":"FIRST_NAME"},{"id":"USER1_ID","role_id":"ROLE_ID","username":"USERNAME1","last_name":"LAST_NAME","first_name":"FIRST_NAME"}]||
     17|| ||status (failure)||HTTP/1.0 404 Not Found||
     18|| ||output (failure)||null||
    1319||GET||/v1/users/{id}||get a user with id||
    14 ||POST||/v1/users||create a user/users||
     20|| ||parameter||USER_ID||
     21|| ||input||none||
     22|| ||status (success)||HTTP/1.0 200 OK||
     23|| ||output (success)||[{"id":"USER0_ID","role_id":"ROLE_ID","username":"USERNAME0","last_name":"LAST_NAME","first_name":"FIRST_NAME"}]||
     24|| ||status (failure)||HTTP/1.0 404 Not Found||
     25|| ||output (failure)||null||
     26||POST||/v1/users||create a user||
     27|| ||parameter||none||
     28|| ||input||[{"role_id":"ROLE_ID","username":"USERNAME","last_name":"LAST_NAME","first_name":"FIRST_NAME"}]||
     29|| ||status (success)||HTTP/1.0 201 CREATED||
     30|| ||output (success)||[{"id":"USER_ID","role_id":"ROLE_ID","username":"USERNAME","last_name":"LAST_NAME","first_name":"FIRST_NAME"}]||
     31|| ||status (failure)||HTTP/1.0 500 Internal Server Error||
     32|| ||output (failure)||null||
     33||POST||/v1/users||create users||
     34|| ||parameter||none||
     35|| ||input||[{"role_id":"ROLE_ID","username":"USERNAME0","last_name":"LAST_NAME","first_name":"FIRST_NAME"},{"role_id":"ROLE_ID","username":"USERNAME1","last_name":"LAST_NAME","first_name":"FIRST_NAME"}]||
     36|| ||status (success)||HTTP/1.0 201 CREATED||
     37|| ||output (success)||[{"id":"USER0_ID","role_id":"ROLE_ID","username":"USERNAME0","last_name":"LAST_NAME","first_name":"FIRST_NAME"},{"id":"USER1_ID","role_id":"ROLE_ID","username":"USERNAME1","last_name":"LAST_NAME","first_name":"FIRST_NAME"}]||
     38|| ||status (failure)||HTTP/1.0 500 Internal Server Error||
     39|| ||output (failure)||null||
    1540||DELETE||/v1/users/{id}||remove a user with id||
     41|| ||parameter||USER_ID||
     42|| ||input||none||
     43|| ||status (success)||HTTP/1.0 204 No Content||
     44|| ||output (success)||null||
     45|| ||status (failure)||HTTP/1.0 500 Internal Server Error||
     46|| ||output (failure)||null||
    1647||PUT||/v1/users/{id}||update a user with id||
     48|| ||parameter||COURSE_ID||
     49|| ||input||[{"id":"USER_ID","username":"USERNAME","last_name":"LAST_NAME","first_name":"FIRST_NAME","role_id":"ROLE_ID"}]||
     50|| ||status (success)||HTTP/1.0 200 OK||
     51|| ||output (success)||[{"id":"USER_ID","username":"USERNAME","last_name":"LAST_NAME","first_name":"FIRST_NAME","role_id":"ROLE_ID"}]||
     52|| ||status (failure)||HTTP/1.0 500 Internal Server Error||
     53|| ||output (failure)||null||
    1754
    1855=== Courses ===