## 愛博思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=1&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=(72)(181)(1567)(1676)(3364)(3505)(5753)(5862)(7190)(7299)&education=1&version_id=ZZ

| 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}&{sub_unit_name}

**Provide example parameters：**

http://210.61.12.55:3000/sub_units/fetch_sub_unit?education=1&course_category_id=1&unit_id=101&sub_unit_name=鑑古知今

文件稍後會再更新，再麻煩協助確認，謝謝

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| course_category_id | yes | integer |
| unit_id | yes | string |
| sub_unit_name | 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

### Get alone question

**GET**
http://{server_ip_hostname}/api/questions/fetch_alone_questions?{education}&{topic_ids}&{difficulty_id}&totalquestions={totalquestions}&excludedquestionids={excludedquestionids}

**Provide example parameters：**

http://210.61.12.55:3000/questions/fetch_alone_questions?education=1&topic_ids=(5)(128)(1623)&difficulty_id=3&totalquestions=10&excludedquestionids=1D82367D9310,1D822BF77D10,1D822B1FCA10

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| topic_ids | no | string |
| difficulty_id | no | string |
| totalquestions| no | integer | default: 20
| excludedquestionids | 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 a Suite Question

**GET**
http://{server_ip_hostname}/api/questions/fetch_suite_questions?{education}&{topic_ids}&maxchildexams={maxchildexams}&excludedquestionids={excludedquestionids}

**Provide example parameters：**

http://210.61.12.55:3000/questions/fetch_suite_questions?maxchildexams=2&excludedquestionids=16D9AF4EFA300,16D9AF4F04000&topic_ids=(699)(710)(721)(730)(2047)(2090)(2134)(4087)(4111)(4132)(5470)(5492)(5515)(7828)(7869)(7916)&education=1

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| topic_ids | no | string |
| difficulty_id | no | string |
| maxchildexams | no | integer |
| excludedquestionids | 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 a zip file of questions

**GET**
http://{server_ip_hostname}/api/questions/fetch_zip_file_of_questions?{education}&{subject_id}&{questionids}

**Provide example parameters：**
http://210.61.12.55:3000/questions/fetch_zip_file_of_questions?education=1&subject_id=BI&questionids=16D9AF4EFA300,16D9AF4F04000

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| subject_id | no | string |
| maxchildexams | no | integer |
| questionids | 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**


## Video on Demand

### Get a Video play token

**GET**
http://{server_ip_hostname}/api/vods/fetch_play_token?{name}

**Provide example parameters：**

http://210.61.12.55:3000/vods/fetch_play_token?name=ECE212035CK07

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| name | yes | string |

**Response HTTP 200**


### Return the DASH and HLS URLs along with the video play token

**POST**
http://{server_ip_hostname}/api/vods/fetch_player_options?{name}

**Provide example parameters：**

http://210.61.12.55:3000/vods/fetch_player_options?name=ECE212035CK07

| Parameter | Required | type | Comment
| ------------- | -------- | -------- | -------
| name | yes | string |

**Response HTTP 200**