---
# System prepended metadata

title: 愛博思Hipass API

---


## 愛博思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**

![截圖 2024-05-16 中午12.00.15](https://hackmd.io/_uploads/By_JHW7QA.png)



### 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**

![截圖 2024-05-16 中午12.00.55](https://hackmd.io/_uploads/SkifBb7XR.png)



## 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**

![截圖 2024-05-16 中午12.03.05](https://hackmd.io/_uploads/Hk9cBbQQC.png)


### 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**

![截圖 2024-05-16 中午12.04.16](https://hackmd.io/_uploads/ByK0SZQ7A.png)



### 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**

![截圖 2024-05-16 中午12.05.15](https://hackmd.io/_uploads/SynfUW77A.png)


## 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**

![截圖 2024-05-16 中午12.07.25](https://hackmd.io/_uploads/Syhq8-XQA.png)


### 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**

![截圖 2024-05-16 中午12.08.40](https://hackmd.io/_uploads/rkcevZQm0.png)


## 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**

![截圖 2024-05-16 中午12.11.00](https://hackmd.io/_uploads/r1ltDZ7QC.png)


### 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**

![截圖 2024-05-16 中午12.12.36](https://hackmd.io/_uploads/SyLAwWQmC.png)


### 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**

![截圖 2024-05-16 中午12.57.06](https://hackmd.io/_uploads/rJgSMM7m0.png)

### 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**

![截圖 2024-05-16 中午12.14.16](https://hackmd.io/_uploads/r1H4dZmXC.png)


## 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**

![截圖 2024-05-16 中午12.14.57](https://hackmd.io/_uploads/SkCUdZXmA.png)

### 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**

![截圖 2024-05-16 中午12.15.47](https://hackmd.io/_uploads/rJut_b770.png)


## Question (未完成剩三支)