## 愛博思Hipass API

## CourseCategory

### GET Courses

**GET**
http://{server_ip_hostname}/api/course_categories?{education}&{subject_id}&{version_id}

**Provide example parameters：**

http://210.61.12.55:3000/course_categories?subject_id=CE&education=0&version_id=ZZ

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| subject_id | no | string |
| version_id | no | string |
| education | no | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


### Get Class Name

**GET**
http://{server_ip_hostname}/api/course_categories/fetch_course_category?{education}&{class_id}

**Provide example parameters：**

http://210.61.12.55:3000/course_categories/fetch_course_category?class_id=1&education=0

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| class_id | yes | integer |
| education | yes | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


## Version

### Get All Versions

**GET**
http://{server_ip_hostname}/api/versions?{education}

**Provide example parameters：**

http://210.61.12.55:3000/versions?education=0

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| education | no | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


### Get Version Name

**GET**
http://{server_ip_hostname}/api/versions/fetch_version_name?{education}&{version_id}

**Provide example parameters：**

http://210.61.12.55:3000/versions/fetch_version_name?education=0&version_id=KH

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| version_id | yes | string |
| education | yes | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


### Get Avaiable Versions

**GET**
http://{server_ip_hostname}/api/versions/fetch_unique_version_ids?{education}&{subject_id}&{entrance}

**Provide example parameters：**

http://210.61.12.55:3000/versions/fetch_unique_version_ids?education=1&subject_id=CE&entrance=110

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| subject_id | no | string |
| entrance | no | string |
| education | no | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


## Unit

### Get Units

**GET**
http://{server_ip_hostname}/api/units?{education}&{course_category_id}

**Provide example parameters：**

http://210.61.12.55:3000/units?education=0&course_category_id=1

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| course_category_id | no | integer |
| education | no | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


### Get Unit Name

**GET**
http://{server_ip_hostname}/api/units/fetch_unit_name?{education}&{course_category_id}&{unit_id}

**Provide example parameters：**

http://210.61.12.55:3000/versions/fetch_version_name?education=0&version_id=KH

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| course_category_id | yes | integer |
| unit_id | yes | string |
| education | yes | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


## Course

### Get 萬事通版 Courses

**GET**
http://{server_ip_hostname}/api/courses?{education}&{sub_unit_id}

**Provide example parameters：**

http://210.61.12.55:3000/courses?education=0&sub_unit_id=2

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| sub_unit_id | no | integer |
| education | no | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


### Get Version Courses

**GET** http://{server_ip_hostname}/api/courses/fetch_version_courses?{sub_unit_id}&{version_id}&{topic_ids}&{education}

**Provide example parameters：**

http://210.61.12.55:3000/courses/fetch_version_courses?topic_ids=&version_id=ZZ&education=0&sub_unit_id=2

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| sub_unit_id | no | integer |
| version_id | yes | string |
| topic_ids | no | string |
| education | no | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


### Get Subunit

**GET**
http://{server_ip_hostname}/api/sub_units/fetch_sub_unit?{education}/{course_category_id}/{unit_id}

**Provide example parameters：**

http://210.61.12.55:3000/sub_units/fetch_sub_unit?course_category_id=1&education=0&unit_id=101

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| course_category_id | yes | integer |
| unit_id | yes | string |
| education | yes | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


### Get SubUnit ID

**GET** http://{server_ip_hostname}/api/sub_units/fetch_sub_unit_id?{sub_unit_id}&{education}

**Provide example parameters：**

http://210.61.12.55:3000/sub_units/fetch_sub_unit_id?sub_unit_id=1&education=0

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| sub_unit_id | yes | integer |
| education | yes | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


## Topic

### Get Topics by classid and unitid

##GET##
http://{server_ip_hostname}/api/topics?{education}&{course_category_id}&{unit_id}

**Provide example parameters：**

http://210.61.12.55:3000/topics?education=0&course_category_id=1&unit_id=101

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| unit_id | no | string |
| course_category_id | no | integer |
| education | no | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


### Get Topic Name

**GET**
http://{server_ip_hostname}/api/topics/fetch_topic_name?{education}&{topic_id}

**Provide example parameters：**

http://210.61.12.55:3000/topics/fetch_topic_name?education=0&topic_id=1

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| topic_id | yes | integer |
| education | yes | integer | 0: elementary_school 國小 (StudyExcellentII108)
| | | | 1: junior_high_school 國中 (StudyExpertII108)
| | | | 2: CAP_for_junior_high_school</br> &nbsp;&nbsp;&nbsp;&nbsp;會考 (StudyMasterII108)
| | | | 3: high_school 高中 (GrandExpertII108)

**Response HTTP 200**


## Question (未完成剩三支)