update api

Author: jason1122g

README.md

@@ -27,31 +27,31 @@ All strings are encoded in UTF-8.
 ## Endpoints
 
 ##### [Activity-Service]
-> /activity/v3
-- [/activities](activity-service/v3/activities.md)
-- [/announces](activity-service/v3/announces.md)
-- [/clubs](activity-service/v3/clubs.md)
+> /activity/v1
+- [/activities](activity-service/v1/activities.md)
+- [/announces](activity-service/v1/announces.md)
+- [/clubs](activity-service/v1/clubs.md)
 
 ##### [Location-Service]
-> /location/v3
-- [/search](location-service/v3/search.md)
-- [/places](location-service/v3/places.md)
-- [/units](location-service/v3/units.md)
-- [/faculties](location-service/v3/faculties.md)
-- [/buildings](location-service/v3/buildings.md)
+> /location/v1
+- [/search](location-service/v1/search.md)
+- [/places](location-service/v1/places.md)
+- [/units](location-service/v1/units.md)
+- [/faculties](location-service/v1/faculties.md)
+- [/buildings](location-service/v1/buildings.md)
 
 ##### [Course-Service]
 > /course/v1
 - [/status](course-service/v1/status.md)
-- [/unit/college](course-service/v1/unit/college.md)
-- [/unit/college/{collegeId}/department](course-service/v1/unit/college_department.md)
-- [/unit/department/{departmentId}/target](course-service/v1/unit/department_target.md)
-- [/course/{serialNo}](course-service/v1/course/course.md)
-- [/course/{serialNo}/limit](course-service/v1/course/limit.md)
-- [/search](course-service/v1/search/search.md)
-- [/search/department/{departmentId}](course-service/v1/search/department.md)
-- [/search/target/{targetId}](course-service/v1/search/target.md)
-- [/search/summer/{stage}](course-service/v1/search/summer.md)
+- [/colleges](course-service/v1/unit/college.md)
+- [/colleges/{collegeId}/departments](course-service/v1/unit/college_department.md)
+- [/departments/{departmentId}/targets](course-service/v1/search/departments_targets.md)
+- [/departments/{departmentId}](course-service/v1/search/departments_courses.md)
+- [/courses/{serialNo}](course-service/v1/course/course.md)
+- [/courses/{serialNo}/limit](course-service/v1/course/limit.md)
+- [/courses](course-service/v1/course/search.md)
+- [/targets/{targetId}/courses](course-service/v1/search/target.md)
+- [/summer/{stage}/courses](course-service/v1/search/summer.md)
 - [/student/selected](course-service/v1/student/selected.md)
 - [/student/rejected](course-service/v1/student/rejected.md)
 - [/student/tracking](course-service/v1/student/tracking.md)
@@ -66,8 +66,10 @@ All strings are encoded in UTF-8.
 HTTP Status Code | Description       
 ---------------- | -----------------
 400              | invalid body or parameter.
-403              | access a protected resource with an invalid access token.
+401              | access a protected resource with an invalid token.
+403              | access a protected resource with an token from invalid client.
 404              | resource not found.
+405              | invalid request method 
 500              | internal server error.
 
 ## Problems?

activity-service/v3/activities.md activity-service/v1/activities.md

@@ -1,7 +1,7 @@
 # Find Course Information
 
 ```
-GET /course/{serialNo}
+GET /courses/{serialNo}
 ```
 
 ## Description
@@ -24,7 +24,7 @@ GET /course/{serialNo}
 
 ## Example
 ```
-GET /course/12034
+GET /courses/12034
 ```
 
 # Response
@@ -60,7 +60,7 @@ GET /course/12034
         <td>course name</td>
     </tr>
     <tr>
-        <td>isCanceled</td>
+        <td>isClosed</td>
         <td>Boolean</td>
         <td>is canceled or not.</td>
     </tr>
@@ -119,7 +119,7 @@ GET /course/12034
         </td>
     </tr>
     <tr>
-        <td>usePasswordCard</td>
+        <td>passwordCard</td>
         <td>Enum</td>
         <td>
             Password Card
@@ -151,8 +151,8 @@ GET /course/12034
     </tr>
     <tr>
         <td>teachers</td>
-        <td>String</td>
-        <td>separated by ","</td>
+        <td>String Array</td>
+        <td>teacher names</td>
     </tr>
     <tr>
         <td>credit</td>
@@ -161,11 +161,11 @@ GET /course/12034
     </tr>
     <tr>
         <td>classRooms</td>
-        <td>String</td>
-        <td>{building}-{classroom}, separated by ","</td>
+        <td>String[]</td>
+        <td>class room number with building code</td>
     </tr>
     <tr>
-        <td>time</td>
+        <td>times</td>
         <td>Object</td>
         <td>Key : Day of Week
             <table>
@@ -240,7 +240,7 @@ GET /course/12034
         </td>					
     </tr>
     <tr>
-        <td>limit</td>
+        <td>maxStudents</td>
         <td>Number</td>
         <td>maximum amount of students, 0 means infinity.</td>
     </tr>
@@ -250,27 +250,27 @@ GET /course/12034
 ```json
 [
 	{
-		"serialNo" : 12034,
-		"no" : "EL5001",
-		"classNo" : "*",
-		"name" : "文學\/文化理論導讀",
-		"isCanceled" : false,
-		"memo" : "限三、四年級",
-		"isMasterDoctor" : false,
-		"language" : "Chinese",
-		"usePasswordCard" : "no",
-		"isFirstRun" : true,
-		"isPreSelect" : true,
-		"teachers" : "錢夫人,阿土伯",
-		"credit" : 2,
-		"classRooms" : "C2-209,C2-209",
-		"time" : { 
-		  "0": ["5"], 
-		  "2": ["3", "4"]
-		},
-		"type" : "required",
-		"fullHalf" : "half",
-		"maxStudents" : 0
-	}
+        "serialNo" : 12034,
+        "no" : "EL5001",
+        "classNo" : "*",
+        "name" : "文學/文化理論導讀",
+        "isClosed" : false,
+        "memo": "限三、四年級",
+        "isMasterDoctor": false,
+        "language": "國語",
+        "passwordCard": "不使用",
+        "isFirstRun": true,
+        "isPreSelect": true,
+        "teachers": [  "錢夫人", "阿土伯" ],
+        "credit": 2,
+        "classRooms": [ "C2-209", "C2-209" ],
+        "times": {
+                  "0": ["5"],
+                  "2": ["3", "4"]
+                },
+        "type": "必修",
+        "fullHalf": "全",
+        "maxStudents": 0
+    }
 ]
 ```

activity-service/v3/announces.md activity-service/v1/announces.md

@@ -1,7 +1,7 @@
 # Find Course Limitation
 
 ```
-GET /course/{serialNo}/limit
+GET /courses/{serialNo}/limit
 ```
 
 ## Description
@@ -49,7 +49,7 @@ GET /course/{serialNo}/limit
 
 ## Example
 ```
-GET /course/12034/limit?semester=1031
+GET /courses/12034/limit?semester=1031
 ```
 
 # Response

activity-service/v3/clubs.md activity-service/v1/clubs.md

@@ -1,7 +1,7 @@
 # Search Course Information
 
 ```
-GET /search
+GET /courses
 ```
 
 ## Description
@@ -89,7 +89,7 @@ GET /search
 
 ## Example
 ```
-GET /search?period=2&week=3
+GET /courses?period=2&week=3
 ```
 
 # Response

course-service/v1/course/course.md

@@ -1,7 +1,7 @@
 # Search Course Information By Department
 
 ```
-GET /search/department/{departmentId}
+GET /departments/{departmentId}/courses
 ```
 
 ## Description
@@ -24,7 +24,7 @@ GET /search/department/{departmentId}
 
 ## Example
 ```
-GET /search/department/deptI1I1000I0
+GET /departments/deptI1I1000I0/courses
 ```
 
 # Response

course-service/v1/course/limit.md

@@ -1,7 +1,7 @@
 # Find Targets.
 
 ```
-GET /unit/department/{departmentId}/target
+GET /departments/{departmentId}/targets
 ```
 
 ## Description
@@ -24,7 +24,7 @@ GET /unit/department/{departmentId}/target
 
 ## Example
 ```
-GET /unit/department/deptI1I1000I0/target
+GET /departments/deptI1I1000I0/targets
 ```
 
 # Response

course-service/v1/search/search.md course-service/v1/course/search.md

@@ -1,7 +1,7 @@
 # Search Summer Course Information
 
 ```
-GET /search/summer/{stage}
+GET /summer/{stage}/courses
 ```
 
 ## Description
@@ -24,7 +24,7 @@ GET /search/summer/{stage}
 
 ## Example
 ```
-GET /search/summer/1
+GET /summer/1/courses
 ```
 
 # Response

course-service/v1/search/department.md course-service/v1/search/departments_courses.md

@@ -1,7 +1,7 @@
 # Search Course Information By Target
 
 ```
-GET /search/target/{targetId}
+GET /targets/{targetId}/courses
 ```
 
 ## Description
@@ -24,7 +24,7 @@ GET /search/target/{targetId}
 
 ## Example
 ```
-GET /search/target/cofuZdeptI1I1001I0ZcofgI0
+GET /targets/cofuZdeptI1I1001I0ZcofgI0/courses
 ```
 
 # Response

course-service/v1/unit/department_target.md course-service/v1/search/departments_targets.md

@@ -1,7 +1,7 @@
 # Find All Colleges.
 
 ```
-GET /unit/college
+GET /colleges
 ```
 
 ## Description
@@ -24,7 +24,7 @@ GET /unit/college
 
 ## Example
 ```
-GET /unit/college
+GET /colleges
 ```
 
 # Response

course-service/v1/search/summer.md

@@ -1,7 +1,7 @@
 # Find Departments By College.
 
 ```
-GET /unit/college/{collegeId}/department
+GET /colleges/{collegeId}/departments
 ```
 
 ## Description
@@ -24,7 +24,7 @@ GET /unit/college/{collegeId}/department
 
 ## Example
 ```
-GET /unit/college/deptI1I1000I0/department
+GET /colleges/deptI1I1000I0/departments
 ```
 
 # Response