# 健康守護手杖計畫
# 使用者註冊
##### 簡單描述
- 使用者註冊
##### 請求URL
- `https://www.vigorshine.com/crutch/api/RegisterU`
##### 請求方式
- POST
##### 請求範例
```js
{
"tel": "string",
"password": "string",
"nickname": "string",
"age": 0,
"gender": "string",
"height": 0,
"weight": 0,
"fireBaseToken": "string"
}
```
##### 參數
| 參數名稱 | 必填 | 型別 | 說明 |
|---|
| tel | 是 | string | 電話號碼 |
| password | 是 | string | 密碼 |
| nickname | 是 | string | 暱稱 |
| age | 否 | int | 年齡 |
| gender | 否 | int | 性別 `M:男` `F:女` |
| height | 否 | decimal | 身高 |
| weight | 否 | decimal | 體重 |
| fireBaseToken | 否 | string | FireBase Token |
##### 傳回範例
```js
{
"success": true,
"errorCode": 0,
"message": "string"
}
```
##### 傳回參數說明
| 參數名稱 | 型別 | 說明 |
|---|
| success | bool | 是否成功 |
| errorCode | int | 錯誤代碼 (有錯誤時才有) |
| message | string | 錯誤訊息 (有錯誤時才有) |
##### 備註
| 錯誤代碼 | 錯誤說明 |
|---|
| 1001 | 電話不可空白！ |
| 1002 | 暱稱不可空白！ |
| 1003 | 密碼不可空白！ |
| 1004 | 電話已註冊！ |
| 9999 | 非預期的例外 |
# 關懷者註冊
##### 簡單描述
- 關懷者註冊
##### 請求URL
- `https://www.vigorshine.com/crutch/api/RegisterC`
##### 請求方式
- POST
##### 請求範例
```js
{
"tel": "string",
"name": "string",
"relation": "string",
"userTel": "string",
"password": "string",
"fireBaseToken": "string"
}
```
##### 參數
| 參數名稱 | 必填 | 型別 | 說明 |
|---|
| tel | 是 | string | 電話號碼 |
| password | 是 | string | 密碼 |
| name | 是 | string | 暱稱 |
| relation | 否 | string | 關係 |
| userTel | 否 | string | 被關懷者電話 |
| fireBaseToken | 否 | string | FireBase Token |
##### 傳回範例
```js
{
"success": true,
"errorCode": 0,
"message": "string"
}
```
##### 傳回參數說明
| 參數名稱 | 型別 | 說明 |
|---|
| success | bool | 是否成功 |
| errorCode | int | 錯誤代碼 (有錯誤時才有) |
| message | string | 錯誤訊息 (有錯誤時才有) |
##### 備註
| 錯誤代碼 | 錯誤說明 |
|---|
| 1001 | 電話不可空白！ |
| 1003 | 密碼不可空白！ |
| 1004 | 電話已註冊！ |
| 1011 | 姓名不可空白！ |
| 1012 | 關係不可空白！ |
| 1013 | 被關懷者電話不可空白！ |
| 1014 | 被關懷者電話錯誤！ |
| 9999 | 非預期的例外 |
# 登入
##### 簡單描述
- 登入
##### 請求URL
- `https://www.vigorshine.com/crutch/api/Login`
##### 請求方式
- POST
##### 請求範例
```js
{
"tel": "string",
"password": "string",
"userType": 0
}
```
##### 參數
| 參數名稱 | 必填 | 型別 | 說明 |
|---|
| tel | 是 | string | 電話號碼 |
| password | 是 | string | 密碼 |
| userType | 是 | int | 帳號類型
`1:使用者`
`2:關懷者` |
##### 傳回範例
```js
{
"success": true,
"errorCode": 0,
"message": "string",
"userType": 0,
"user": {
"tel": "string",
"nickname": "string",
"age": 0,
"gender": "string",
"height": 0,
"weight": 0
},
"carer": {
"tel": "string",
"name": "string",
"cared": [
{
"tel": "string",
"nickname": "string",
"relation": "string"
}
]
},
"token": "string"
}
```
##### 傳回參數說明
| 參數名稱 | 型別 | 說明 |
|---|
| success | bool | 是否成功 |
| errorCode | int | 錯誤代碼 (有錯誤時才有) |
| message | string | 錯誤訊息 (有錯誤時才有) |
| userType | int | 帳號類型
`1:使用者`
`2:關懷者` |
| token | string | Token |
| user | object | 使用者資訊 |
| carer | object | 關懷者資訊 |
- user 使用者資訊
| 參數名稱 | 型別 | 說明 |
|---|
| tel | string | 電話號碼 |
| nickname | string | 暱稱 |
| age | int | 年齡 |
| gender | int | 性別 `M:男` `F:女` |
| height | decimal | 身高 |
| weight | decimal | 體重 |
- carer 關懷者資訊
| 參數名稱 | 型別 | 說明 |
|---|
| tel | string | 電話號碼 |
| name | string | 暱稱 |
| cared | array | 被關懷者資訊 |
- carer.cared 被關懷者資訊
| 參數名稱 | 型別 | 說明 |
|---|
| tel | string | 電話號碼 |
| nickname | string | 暱稱 |
| relation | string | 與被關懷者關係 |
##### 備註
| 錯誤代碼 | 錯誤說明 |
|---|
| 1001 | 電話不可空白！ |
| 1003 | 密碼不可空白！ |
| 1021 | 帳號類型不可空白！ |
| 1022 | 帳號類型錯誤！ |
| 1023 | 帳號或密碼錯誤！ |
| 9999 | 非預期的例外 |
# 取得使用者資訊
##### 簡單描述
- 取得使用者資訊
##### 請求URL
- `https://www.vigorshine.com/crutch/api/GetUser`
##### 請求方式
- POST
##### 請求範例
```js
{
"tel": "string",
}
```
##### 參數
##### 傳回範例
```js
{
"success": true,
"errorCode": 0,
"message": "string",
"user": {
"tel": "string",
"nickname": "string"
}
}
```
##### 傳回參數說明
| 參數名稱 | 型別 | 說明 |
|---|
| success | bool | 是否成功 |
| errorCode | int | 錯誤代碼 (有錯誤時才有) |
| message | string | 錯誤訊息 (有錯誤時才有) |
| user | object | 使用者資訊 |
- user 使用者資訊
| 參數名稱 | 型別 | 說明 |
|---|
| tel | string | 電話號碼 |
| nickname | string | 暱稱 |
##### 備註
| 錯誤代碼 | 錯誤說明 |
|---|
| 1001 | 電話不可空白！ |
| 1014 | 被關懷者電話錯誤！ |
| 9999 | 非預期的例外 |
# 儲存關懷者關係
##### 簡單描述
- 儲存關懷者關係
##### 請求URL
- `https://www.vigorshine.com/crutch/api/SaveUserRel`
##### 請求方式
- POST
##### 請求範例
```js
{
"tel": "string",
"userTel": "string",
"relation": "string"
}
```
##### 參數
##### 傳回範例
```js
{
"success": true,
"errorCode": 0,
"message": "string"
}
```
##### 傳回參數說明
| 參數名稱 | 型別 | 說明 |
|---|
| success | bool | 是否成功 |
| errorCode | int | 錯誤代碼 (有錯誤時才有) |
| message | string | 錯誤訊息 (有錯誤時才有) |
##### 備註
| 錯誤代碼 | 錯誤說明 |
|---|
| 1001 | 電話不可空白！ |
| 1012 | 關係不可空白！ |
| 1013 | 被關懷者電話不可空白！ |
| 1014 | 被關懷者電話錯誤！ |
| 1041 | 關懷者電話錯誤！ |
| 9999 | 非預期的例外 |
# 通知
##### 簡單描述
- 通知
##### 請求URL
- `https://www.vigorshine.com/crutch/api/Notification`
##### 請求方式
- POST
##### 請求範例
```js
{
"tel": "string",
"title": "string",
"body": "string"
}
```
##### 參數
| 參數名稱 | 必填 | 型別 | 說明 |
|---|
| tel | 是 | string | 電話號碼 |
| title | 是 | string | 標題 |
| body | 是 | string | 內容 |
##### 傳回範例
```js
{
"success": true,
"errorCode": 0,
"message": "string"
}
```
##### 傳回參數說明
| 參數名稱 | 型別 | 說明 |
|---|
| success | bool | 是否成功 |
| errorCode | int | 錯誤代碼 (有錯誤時才有) |
| message | string | 錯誤訊息 (有錯誤時才有) |
##### 備註
| 錯誤代碼 | 錯誤說明 |
|---|
| 1001 | 電話不可空白！ |
| 1014 | 被關懷者電話錯誤！ |
| 1031 | 標題不可空白！ |
| 1032 | 內容不可空白！ |
| 1033 | 無關懷者資料！ |
| 1034 | 發送通知失敗！ |
| 9999 | 非預期的例外 |
# 取得通知內容
##### 簡單描述
- 取得通知內容
##### 請求URL
- `https://www.vigorshine.com/crutch/api/GetNotification`
##### 請求方式
- POST
##### 請求範例
```js
{
"tel": "string",
"time": "2024-10-21T05:46:01.573Z"
}
```
##### 參數
| 參數名稱 | 必填 | 型別 | 說明 |
|---|
| tel | 是 | string | 關懷者電話號碼 |
| time | 否 | datetime | 時間 `取得此時間後推播` |
##### 傳回範例
```js
{
"success": true,
"errorCode": 0,
"message": "string",
"": [
{
"time": "2024-10-21T05:46:01.577Z",
"title": "string",
"body": "string"
}
]
}
```
##### 傳回參數說明
| 參數名稱 | 型別 | 說明 |
|---|
| success | bool | 是否成功 |
| errorCode | int | 錯誤代碼 (有錯誤時才有) |
| message | string | 錯誤訊息 (有錯誤時才有) |
| results | array | 推播內容 |
- results
| 參數名稱 | 型別 | 說明 |
|---|
| time | datetime | 推播時間 |
| title | string | 標題 |
| body | string | 內容 |
##### 備註
| 錯誤代碼 | 錯誤說明 |
|---|
| 1001 | 電話不可空白！ |
| 1041 | 關懷者電話錯誤！ |
| 9999 | 非預期的例外 |