Changes between Version 6 and Version 7 of api_v1


Ignore:
Timestamp:
2012-08-29T16:50:23Z (12 years ago)
Author:
michael
Comment:

--

Legend:

Unmodified
Added
Removed
Modified

  • api_v1

    v6 v7  
    2121|| ||parameter||none||
    2222|| ||input||none||
    23 || ||response||success (200) or could not find (404)||
    24 || ||output||course list (json), or error message||
     23|| ||status (success)||HTTP/1.0 200 OK||
     24|| ||output (success)||[{"id":"COURSE0_ID","course":"COURSE0_CODE","title":"COURSE0_TITLE"},{"id":"COURSE1_ID","course":"COURSE1_CODE","title":"COURSE1_TITLE"}]||
     25|| ||status (failure)||HTTP/1.0 404 Not Found||
     26|| ||output (failure)||No courses can be found||
    2527||GET||/v1/courses/{id}||get a course with id||
    26 || ||parameter||course id||
     28|| ||parameter||COURSE_ID||
    2729|| ||input||none||
    28 || ||response||success (200) or could not find (404)||
    29 || ||output||course (json), or error message||
     30|| ||status (success)||HTTP/1.0 200 OK||
     31|| ||output (success)||{"id":"COURSE_ID","course":"COURSE_CODE","title":"COURSE_TITLE"}||
     32|| ||status (failure)||HTTP/1.0 404 Not Found||
     33|| ||status (failure)||No course with id COURSE_ID can be found||
    3034||POST||/v1/courses||create a course||
    3135|| ||parameter||none||
    3236|| ||input||{"Course":{"course":"COURSE_CODE","title":"COURSE_TITLE"},"Department":{"Department":[DEPARTMENT_ID]}}||
    33 || ||response||created (201) or error (500)||
    34 || ||output||id of created course, or error message||
     37|| ||status (success)||HTTP/1.0 201 Created||
     38|| ||output (success)||COURSE_ID||
     39|| ||status (failure)||HTTP/1.0 500 Internal Server Error||
     40|| ||output (failure)||Error: the course was not added||
    3541||DELETE||/v1/courses/{id}||remove a course with id||
    36 || ||parameter||course id||
     42|| ||parameter||COURSE_ID||
    3743|| ||input||none||
    38 || ||response||success (204) or error (500)||
    39 || ||output||id of deleted course, or error message||
     44|| ||status (success)||HTTP/1.0 204 No Content||
     45|| ||output (success)||COURSE_ID||
     46|| ||status (failure)||HTTP/1.0 500 Internal Server Error||
     47|| ||output (failure)||Error: the course was not deleted||
    4048||PUT||/v1/courses/{id}||update a course with id||
    4149|| ||parameter||none||
    4250|| ||input||{"Course":{"id":"COURSE_ID","course":"COURSE_CODE","title":"COURSE_TITLE"}}||
    43 || ||response||success (200) or error (500)||
    44 || ||output||id of updated course, or error message||
     51|| ||status (success)||HTTP/1.0 200 OK||
     52|| ||output (success)||COURSE_ID||
     53|| ||status (failure)||HTTP/1.0 500 Internal Server Error||
     54|| ||output (failure)||Error: the course was not edited||
    4555
    4656=== Groups ===