---
# System prepended metadata

title: HouseholdMember API

---

1. **取得家戶成員資訊列表**  [POST /{contextPath}/householdMember/getHouseholdMemberInfos](#1-Get-Household-Member-Infos)
2. **新增家戶成員** [POST /{contextPath}/householdMember/add](#2-Add-Household-Member)
3. **更新家戶成員** [POST /{contextPath}/householdMember/update](#3-Update-Household-Member)
4. **刪除家戶成員** [POST /{contextPath}/householdMember/delete](#4-Delete-Household-Member)
5. **取得成員個人及監護人資訊** [GET /{contextPath}/householdMember/vaccDetail](#5-Household-Member-Vaccine-Detail)
6. **編輯成員監護人資訊** [POST /{contextPath}/householdMember/editGuardian](#6-Household-Member-Edit-Guardian)
7. **刪除成員監護人資訊** [GET /{contextPath}/householdMember/deleteGuardian](#7-Household-Member-Delete-Guardian)
8. **成員的小孩資訊列表** [GET /{contextPath}/householdMember/getChildren](#8-Household-Member-Get-Children)
9. **家戶成員轉戶** [POST /{contextPath}/householdMember/changeHousehold](#9-Change-Household)
10. **取得家戶成員資訊** [POST /{contextPath}/householdMember/getHouseholdMember](#10-Get-Household-Member)
11. **取得登入帳號該區域家戶成員資訊列表** [POST /{contextPath}/householdMember/getListByArea](#11-Get-List-By-Area)
12. **關鍵字搜尋取得家戶成員資訊列表** [POST /{contextPath}/householdMember/getListByKeyword](#12-Get-List-By-Keyword)
13. **取得租戶戶成員名字列表** [GET/ {contextPath}/householdMember/name/list](#13-Get-Name-List)


## 1. Get Household Member Infos
```url
POST /{contextPath}/householdMember/getHouseholdMemberInfos
```

取得家戶成員資訊列表

### Request Body:
* query

| Parameter     | Required |  format  |  desc             |
| ------------- | -------- | -------- |------------------ |
| householdId   | Y        | String   | 家戶代碼           |

* sorter

| Parameter | Required |  format  |  desc                      |
| --------- | -------- | -------- |--------------------------- |
| field     | N        | String   | 排序欄位，預設為 memberId    |
| order     | N        | String   | desc/asc，預設為 desc       |


### Request Body Example:

``` javascript
{
  "query": {
    "householdId":"3e554be940074ce89790f044cd82f282"
  },
  "pagination": {
    "current": "1",
    "pageSize": "10"
  },
  "sorter": {
    "field": "name",
    "order": "asc"
  }
}
```

### Response Body:

| Parameter        |  format  |  desc          | sort supported|
| ---------------- | -------- |----------------|-------------- |
| memberId         | String   | 成員ID         |               |
| visitStatus      | Integer  | 成員訪視狀態    |               |
| healthStatus     | Integer  | 健檢狀態        |               |
| name             | String   | 成員姓名        |               |
| title            | String   | 成員稱謂        |               |
| gender           | Integer  | 成員性別        |               |
| bodyHeight        | Float   | 成員身高        |               |
| idCardNo         | String   | 成員身分證號    |               |
| idCardNoUpdatable| Boolean  | 是否可以修改其身分證字號(已建立其一般民眾的帳號者不允許修改其idCardNo)  |           |
| registrationCode | Integer  | 成員在籍狀態代碼 (在籍:1,遷出:2,歿:3)) |   |
| registrationValue| String   | 成員在籍狀態值   |               |
| birthDate        | String   | 成員生日        |               |
| mobile           | String   | 成員手機號碼    |               |
| tribeCode        | Integer  | 成員原住民族碼   |               |
| tribeName        | String   | 成員原住民族名   |               |
| remark           | String   | 成員備註         |              |
| tags             | Array    | 成員帶有的標籤   |               |
| updateTime       | String   | 成員資料更新日期 |               |
| lastVisitDate    | String   | 上次訪視日期     |               |
| psychosis             | String   | 精神病狀態 |               |
| infectiousDisease     | String   | 傳染病狀態 |               |
| serviceType           | String   | 服務類型 |                 |
| aboriginalName        | String   | 原住民語姓名 |              |
| medicalStaffId        | String   | 衛生所負責人 |              |
| socialAffairsStaffId  | String   | 社政負責人 |               |
| medicalStaffName        | String   | 衛生所負責人姓名 |        |
| medicalStaffTel        | String   | 衛生所負責人電話 |          |
| socialAffairsStaffName  | String   | 社政負責人姓名 |           |
| socialAffairsStaffTel  | String   | 社政負責人聯絡電話 |        |
| isOwner  | Boolean   | 是否為負責人 |               |
| photoThumbnail  | String| 照片 base64 縮圖 |        |

### Response Body Example:
* response: 200 

``` javascript
{
    "httpCode": 200,
    "result": {
        "data": [
            {
                "memberId": "e5e8a1a1-8af2-4886-aae2-d901075bf022",
                "visitStatus": 2,
                "healthStatus": 0,
                "name": "哈哈哈哈哈",
                "title": "",
                "gender": 1,
                "bodyHeight": 180,
                "registrationCode": 1,
                "registrationValue": "在籍",
                "idCardNo": "A121337030",
                "idCardNoUpdatable": true,
                "birthDate": "2015-12-14",
                "mobile": "0988111203",
                "tribeCode": 17,
                "tribeName": "賽德克族",
                "tags": [],
                "psychosis": "HAS_PSYCHOSIS",
                "infectiousDisease": "NO_HAS_DISEASE",
                "serviceType": "12312312",
                "aboriginalName": "jjj",
                "medicalStaffId": "fbc9d26e-4cfc-4de1-85d2-bc9d560a1289",
                "medicalStaffName": "那瑪夏區衛生所醫師",
                "socialAffairsStaffId": "528ec6ba-c20a-445f-8e0a-4963e0255f2c",
                "socialAffairsStaffName": "miketest",
                "updateTime": "2019-05-20",
                "lastVisitDate": "2019-05-15",
                "initPassword": "20151214",
                "isOwner": false,
                "photoThumbnail": "data:image/png;base64,iVBORw0KGgoAAAANSUhEUgAAADIAAAAyCAYAAAAeP..."

            },
            ...
        ],
        "pagination": {
            "current": 1,
            "pageSize": 10,
            "total": 2
        },
        "sorter": {}
    }
}
```


## 2. Add Household Member
```url
POST /{contextPath}/householdMember/add
```

新增家戶成員

### Request Body:

| Parameter              | Required |  format  |  desc                     |
| ---------------------- | -------- | -------- |-------------------------- |
| householdId            | Y        | String   | 家戶代碼                   |
| registrationCode       | Y        | String   | 在籍代碼(在籍:1,遷出:2,歿:3)|
| name                   | Y        | String   | 成員名稱                   |
| title                  | Y        | String   | 成員稱謂                   |
| gender                 | Y        | String   | 成員性別                   |
| bodyHeight             | Y        | String   | 成員身高                   |
| idCardNo               | Y        | String   | 成員身分證號               |
| birthDate              | Y        | String   | 成員生日                   |
| mobile                 | Y        | String   | 成員手機號碼               |
| tribeCode              | Y        | String   | 成員原住民族碼             |
| remark                 | Y        | String   | 成員備註                   |
| tags                   | Y        | String   | 成員帶有的標籤             |
| lastVisitDate          | N        | String   | 上次訪視日期 (yyyy-mm-dd)  |
| psychosis              | N        | String   | 精神病狀態 |
| infectiousDisease      | N        | String   | 傳染病狀態 |
| serviceType            | N        | String   | 服務類型 |
| aboriginalName         | N        | String   | 原住民語姓名 |
| medicalStaffId         | N        | String   | 衛生所負責人 |
| socialAffairsStaffId   | N        | String   | 社政負責人 |

### Request Body Example:

``` javascript
{
 "householdId":"34a0f7abd803496b99551b2386b54ba6",
 "registrationCode":1,
 "name":"王大頭",
 "title":"長子",
 "gender":"1",
 "bodyHeight":"162.3",
 "idCardNo":"E123456999",
 "birthDate":"1980-01-01",
 "mobile":"0988123123",
 "tribeCode":"7",
 "remark":"test",
 "tags": [
   "6c4ce87e8b2542629aebefb6179af745",
   "de5f7c7042d842ad971536d0b2bc6e77"
 ],
 "lastVisitDate":"2018-07-01",
 "psychosis": "HAS_PSYCHOSIS",
 "infectiousDisease": "NO_HAS_DISEASE",
 "serviceType": "12312312",
 "aboriginalName": "jjj",
 "medicalStaffId": "fbc9d26e-4cfc-4de1-85d2-bc9d560a1289",
 "socialAffairsStaffId": "528ec6ba-c20a-445f-8e0a-4963e0255f2c"
}
```

### Response Body:

| Parameter          |  format  |  desc       |
| ------------------ | -------- |-------------|
| memberId           | String   | 新增成員ID   |

### Response Body Example:
* response: 200 

``` javascript
{
    "httpCode": 200,
    "result": {
        "data": {
            "memberId": "3fb4f8a708b94c2bb6362321975e8093"
        }
    }
}
```

* 400 傳入的身分證不合法
```
{
    "errorMsg": "API_ERROR.ID_CARD_NO_FORMAT_ERROR",
    "httpCode": 400
}
```
* 400 輸入的身分證已存在
```
{
    "errorMsg": "API_ERROR.EXIST_HOUSEHOLD_MEMBER",
    "httpCode": 400
}
```


## 3. Update Household Member
```url
POST /{contextPath}/householdMember/update
```

編輯家戶成員

### Request Body:

| Parameter              | Required |  format  |  desc                     |
| ---------------------- | -------- | -------- |-------------------------- |
| memberId               | Y        | String   | 成員ID                    |
| registrationCode       | Y        | String   | 在籍代碼(在籍:1,遷出:2,歿:3)|
| name                   | Y        | String   | 成員名稱                   |
| title                  | N        | String   | 成員稱謂                   |
| gender                 | Y        | String   | 成員性別                   |
| bodyHeight                 | Y        | String   | 成員身高                |
| idCardNo               | Y        | String   | 成員身分證號               |
| birthDate              | Y        | String   | 成員生日                   |
| mobile                 | Y        | String   | 成員手機號碼               |
| tribeCode              | Y        | String   | 成員原住民族碼             |
| remark                 | Y        | String   | 成員備註                   |
| tags                   | Y        | String   | 成員帶有的標籤             |
| lastVisitDate          | N        | String   | 上次訪視日期 (yyyy-mm-dd)  |
| psychosis              | N        | String   | 精神病狀態 |
| infectiousDisease      | N        | String   | 傳染病狀態 |
| serviceType            | N        | String   | 服務類型 |
| aboriginalName         | N        | String   | 原住民語姓名 |
| medicalStaffId         | N        | String   | 衛生所負責人 |
| socialAffairsStaffId   | N        | String   | 社政負責人 |

### Request Body Example:

``` javascript
{
 "memberId":"3fb4f8a708b94c2bb6362321975e8093",
 "registrationCode":1,
 "name":"王大陸",
 "gender":"1",
 "bodyHeight":"168.2",
 "idCardNo":"E111222333",
 "birthDate":"1980-01-01",
 "mobile":"0988123123",
 "tribeCode":"7",
 "remark":"test",
 "visitStatus":1,
 "tags": [
   "6c4ce87e8b2542629aebefb6179af745"
 ],
 "lastVisitDate":"2018-07-01",
 "lastVisitDate":"2018-07-01",
 "psychosis": "HAS_PSYCHOSIS",
 "infectiousDisease": "NO_HAS_DISEASE",
 "serviceType": "12312312",
 "aboriginalName": "jjj",
 "medicalStaffId": "fbc9d26e-4cfc-4de1-85d2-bc9d560a1289",
 "socialAffairsStaffId": "528ec6ba-c20a-445f-8e0a-4963e0255f2c"
}
```

### Response Body:

| Parameter          |  format  |  desc       |
| ------------------ | -------- |-------------|
| updateCount        | Integer| | 更新成功筆數 |

### Response Body Example:
* response: 200 

``` javascript
{
    "httpCode": 200,
    "result": {
        "data": {
            "updateCount": 1
        }
    }
}
```


## 4. Delete Household Member
```url
POST /{contextPath}/householdMember/delete
```

刪除家戶成員

### Request Body:

| Parameter              | Required |  format  |  desc                     |
| ---------------------- | -------- | -------- |-------------------------- |
| memberId               | Y        | String   | 成員ID                    |

### Request Body Example:

``` javascript
{
 "memberId":"3fb4f8a708b94c2bb6362321975e8093",
}
```

### Response Body:

| Parameter          |  format  |  desc       |
| ------------------ | -------- |-------------|
| updateCount        | Integer| | 更新成功筆數 |

### Response Body Example:
* response: 200 

``` javascript
{
    "httpCode": 200,
    "result": {
        "data": {
            "updateCount": 1
        }
    }
}
```


## 5. Household Member Vaccine Detail
```url
GET /{contextPath}/householdMember/vaccDetail
```

取得成員個人及監護人資訊

### Request Param:

| Parameter | Required | format | desc       |
|-----------|----------|--------|------------|
| memberId  | Y        | String | 家戶成員 ID |

### Request Example:

```javascript
GET /householdMember/vaccDetail?memberId=f046b96d35784937aa363dc0b468e38d
```

### Response Body:
| Parameter          |  format  |  desc           |
| ------------------ | -------- |-----------------|
| memberId           | String   | 關聯的成員ID     |
| name               | String   | 姓名            |
| idCardNo           | String   | 身分證字號       |
| birthDate          | String   | 出生日期        |
| gender             | Integer  | 性別            |
| bodyHeight             | Float  | 身高          |
| address            | String   | 戶籍地址        |
| mailingAddress     | String   | 通訊地址        |
| motherName         | String   | 母親名字        |
| weight             | Integer  | 體重            |
| remark             | String   | 備註            |
| guardianName       | String   | 監護人姓名      |
| guardianIdCard     | String   | 監護人身分證號   |
| guardianPhone      | String   | 監護人電話      |
| guardianAddress    | String   | 監護人住址      |
| guardianRegistrationCode    | String   | 監護人戶籍狀況 ,0=不在籍,1=在籍,2＝遷出,3=死亡,4=寄居|
| birthLowWeight     | Integer  | 是否低體重出身兒 |

### Response Body Example:
* response: 200 

``` javascript
{
    "httpCode": 200,
    "result": {
        "data": {
            "memberId": "f046b96d35784937aa363dc0b468e38d",
            "name": "李老",
            "idCardNo": "E123458787",
            "birthDate": "1988-07-07",
            "gender": 1,
            "bodyHeight": 165.8,
            "address": "高雄市那瑪夏區瑪雅里平和巷8號",
            "motherName": "林小英",
            "weight": 3800,
            "remark": "備註",
            "guardianName": "林小英",
            "guardianIdCard": "S123888999",
            "guardianPhone": "0933-123-456",
            "guardianAddress": "高雄市鹽埕區五福四路88號",
            "birthLowWeight": false,
            "guardianRegistrationCode": 0
        }
    }
}
```


## 6. Household Member Edit Guardian
```url
POST /{contextPath}/householdMember/editGuardian
```

編輯成員監護人資訊

### Request Body:

| Parameter          | Required |  format  |  desc                     |
| ------------------ | -------- | -------- |-------------------------- |
| memberId           | Y        | String   | 成員ID                    |
| motherName         | N        | String   | 母親名字                  |
| birthLowWeight     | N        | String   | 是否低體重出身兒           |
| weight             | N        | String   | 體重                      |
| remark             | N        | String   | 備註                      |
| guardianName       | Y        | String   | 監護人姓名                 |
| guardianIdCard     | Y        | String   | 監護人身分證號             |
| guardianPhone      | N        | String   | 監護人電話                 |
| guardianAddress    | N        | String   | 監護人住址                 |


### Request Body Example:

``` javascript
{
"memberId":"f046b96d35784937aa363dc0b468e38d",	
"motherName":"林志玲",
"birthLowWeight":true,
"weight":3800,
"remark":"備註",
"guardianName":"林志玲",
"guardianIdCard":"S123888999",
"guardianPhone":"0933-123-456",
"guardianAddress":"高雄市鹽埕區五福四路88號"
}
```

### Response Body:

| Parameter          |  format  |  desc       |
| ------------------ | -------- |-------------|
| updateCount        | Integer| | 更新成功筆數 |

### Response Body Example:
* response: 200 

``` javascript
{
    "httpCode": 200,
    "result": {
        "data": {
            "updateCount": 1
        }
    }
}
```


## 7. Household Member Delete Guardian
```url
GET /{contextPath}/householdMember/deleteGuardian
```

刪除成員監護人資訊

### Request Param:

| Parameter | Required | format | desc       |
|-----------|----------|--------|------------|
| memberId  | Y        | String | 家戶成員 ID |

### Request Example:

```javascript
GET /householdMember/deleteGuardian?memberId=f046b96d35784937aa363dc0b468e38d
```


### Response Body:

| Parameter          |  format  |  desc       |
| ------------------ | -------- |-------------|
| updateCount        | Integer| | 更新成功筆數 |

### Response Body Example:
* response: 200 

``` javascript
{
    "httpCode": 200,
    "result": {
        "data": {
            "updateCount": 1
        }
    }
}
```


## 8. Household Member Get Children
```url
GET /{contextPath}/householdMember/getChildren
```

監護人的資訊

### Request Param:

| Parameter | Required | format | desc       |
|-----------|----------|--------|------------|
NONE

### Request Example:

```javascript
GET /householdMember/getChildren
```

### Response Body:

| Parameter          |  format  |  desc       |
| ------------------ | -------- |-------------|
| id| String |家訪成員id, UUID |N |
| name| String |家防成員姓名 |Y |
| idCardNo| String |家防成員身分證字號 |N |
| birthDate| Date |家防成員出生年月日 |Y |
| gender| String |家防成員性別 |Y |
| vaccinationExpiredCount| String |家防成員接種逾期數量 |Y |
| guardianName | String | 監護人姓名 |Y |

### Response Body Example:
* response: 200 

``` javascript
{
    "httpCode": 200,
    "result": {
        "data": [
            {
                "vaccinationExpiredCount": 3,
                "id": "dbf4872d7f094ced88262c9ef5dcf8dd",
                "name": "test",
                "idCardNo": "A251033381",
                "birthDate": 1550073600000,
                "gender": 2,
                "areaCode": "6403800",
                "guardianName": "顏成恩"
            }
        ]
    }
}
```


## 9. Change Household
```url
POST /{contextPath}/householdMember/changeHousehold
```

家戶成員轉戶

### Request Body:

| Parameter              | Required |  format  |  desc                     |
| ---------------------- | -------- | -------- |-------------------------- |
| memberId               | Y        | String   | 成員ID                    |
| householdId            | Y        | String   | 過戶後新家戶ID             |

### Request Body Example:

``` javascript
{
 "memberId": "3d217642ca054478a4b21e4368e00345",
 "householdId": "605ccde71817484e979163e072d5a78f"
}
```

### Response Body:

| Parameter          |  format  |  desc       |
| ------------------ | -------- |-------------|
| updateCount        | Integer| | 更新成功筆數 |

### Response Body Example:
* response: 200 

``` javascript
{
    "httpCode": 200,
    "result": {
        "data": {
            "updateCount": 1
        }
    }
}
```


## 10. Get Household Member
```url
GET /{contextPath}/householdMember/getHouseholdMember
```

取得家戶成員資訊

### Request Param:

| Parameter | Required | format | desc       |
|-----------|----------|--------|------------|
| memberId  | Y        | String | 家戶成員 ID |

### Request Example:

```javascript
GET /householdMember/getHouseholdMember?memberId=f046b96d35784937aa363dc0b468e38d
```

### Response Body:

| Parameter        |  format  |  desc          | sort supported|
| ---------------- | -------- |----------------|-------------- |
| memberId         | String   | 成員ID         |               |
| visitStatus      | Integer  | 成員訪視狀態    |               |
| healthStatus     | Integer  | 健檢狀態        |               |
| name             | String   | 成員姓名        |               |
| title            | String   | 成員稱謂        |               |
| gender           | Integer  | 成員性別        |               |
| bodyHeight       | Float    | 成員身高        |               |
| idCardNo         | String   | 成員身分證號    |               |
| idCardNoUpdatable| Boolean  | 是否可以修改其身分證字號(已建立其一般民眾的帳號者不允許修改其idCardNo)  |           |
| registrationCode | Integer  | 成員在籍狀態代碼 (在籍:1,遷出:2,歿:3)) |   |
| registrationValue| String   | 成員在籍狀態值   |               |
| birthDate        | String   | 成員生日        |               |
| mobile           | String   | 成員手機號碼    |               |
| tribeCode        | Integer  | 成員原住民族碼   |               |
| tribeName        | String   | 成員原住民族名   |               |
| remark           | String   | 成員備註         |              |
| tags             | Array    | 成員帶有的標籤   |               |
| updateTime       | String   | 成員資料更新日期 |               |
| lastVisitDate    | String   | 上次訪視日期     |               |
| psychosis             | String   | 精神病狀態 |               |
| infectiousDisease     | String   | 傳染病狀態 |               |
| serviceType           | String   | 服務類型 |                 |
| aboriginalName        | String   | 原住民語姓名 |                 |
| medicalStaffId        | String   | 衛生所負責人 |                 |
| socialAffairsStaffId  | String   | 社政負責人 |               |
| medicalStaffName        | String   | 衛生所負責人姓名 |                 |
| medicalStaffTel        | String   | 衛生所負責人電話 |                 |
| socialAffairsStaffName  | String   | 社政負責人姓名 |               |
| socialAffairsStaffTel  | String   | 社政負責人聯絡電話 |               |

### Response Body Example:
* response: 200 

``` javascript
{
    "httpCode": 200,
    "result": {
        "data": {
            "memberId": "e5e8a1a1-8af2-4886-aae2-d901075bf022",
            "visitStatus": 2,
            "healthStatus": 0,
            "name": "哈哈哈哈哈",
            "title": "",
            "gender": 1,
            "bodyHeight": 165.58,
            "registrationCode": 1,
            "idCardNo": "A121337030",
            "idCardNoUpdatable": true,
            "birthDate": "2015-12-14",
            "mobile": "",
            "tribeCode": 17,
            "areaCode": "6403800",
            "psychosis": "HAS_PSYCHOSIS",
            "infectiousDisease": "NO_HAS_DISEASE",
            "serviceType": "12312312",
            "aboriginalName": "jjj",
            "medicalStaffId": "fbc9d26e-4cfc-4de1-85d2-bc9d560a1289",
            "socialAffairsStaffId": "528ec6ba-c20a-445f-8e0a-4963e0255f2c",
            "socialAffairsStaffName": "miketest",
            "socialAffairsStaffTel": "123456789",
            "socialAffairsStaffTitle": "qq",
            "medicalStaffName": "那瑪夏區衛生所醫師",
            "medicalStaffRole": "HEALTH_CENTER_DOCTOR",
            "updateTime": "2019-05-20",
            "lastVisitDate": "2019-05-15",
            "initPassword": "20151214"
        }
    }
}
```


## 11. Get List By Area
```url
POST /{contextPath}/householdMember/getListByArea
```

依據登入帳號取得該區域家戶成員資訊列表，可用姓名、生日搜尋
（衛教資訊推播家戶成員選項）

### Request Body:
* query

| Parameter     | Required |  format  |  desc             |
| ------------- | -------- | -------- |------------------ |
| name   | Y        | String   | 姓名  |
| birthDate   | Y        | String   | 生日  |

* sorter (sorter can be null, default sorter field: name asc)

| Parameter | Required |  format  |  desc                      |
| --------- | -------- | -------- |--------------------------- |
| field     | N        | String   | 排序欄位，預設為 name     |
| order     | N        | String   | desc/asc，預設為 asc       |

* pagination (pagination can be null. If null, it will return all data)

| Parameter | Required |  format  |  desc   |
| --------- | -------- | -------- |-------- |
| current| N| String | 目前頁數|
| pageSize| N| String |一頁幾筆 |

### Request Body Example:

``` javascript
{
 "query": {
   "name": "陳"
   "birthDate": "2018-12-15"
 },
 "pagination": {
   "current": "1",
   "pageSize": "10"
 },
 "sorter": {
   "field": "name",
   "order": "asc"
 }
}
```

### Response Body:
| Parameter        |  format  |  desc          | sort supported|
| ---------------- | -------- |----------------|-------------- |
| id               | String   | 成員ID         |               |
| name             | String   | 成員姓名        |               |
| idCardNo         | String   | 成員身分證號    |               |
| birthDate        | String   | 成員生日        |               |

### Response Body Example:
* response: 200 

``` javascript
{
   "httpCode": 200,
   "result": {
       "data": [
           {
               "id": "2f06d422-4a5a-457d-8fef-1e863b3117ec",
               "name": "陳O勳",
               "idCardNo": "A170989642",
               "birthDate": "2018-12-15"
           },
           {
               "id": "8a1d0d5a-5f4e-4627-bbc7-a571015f3a04",
               "name": "陳O妤",
               "gender": 1,
               "idCardNo": "A273319779",
               "birthDate": "2018-12-15"
           }
       ],
       "pagination": {
           "current": 1,
           "pageSize": 10,
           "total": 2
       },
       "sorter": {
           "field": "name",
           "order": "asc"
       }
   }
}
```


## 12. Get List By Keyword
```url
POST /{contextPath}/householdMember/getListByKeyword
```

關鍵字(姓名、身分證字號)搜尋取得家戶成員資訊列表


### Request Body:
* query

| Parameter     | Required |  format  |  desc             |
| ------------- | -------- | -------- |------------------ |
| keyword   | Y        | String   | 關鍵字(姓名、身分證字號)          |

* sorter

| Parameter | Required |  format  |  desc                      |
| --------- | -------- | -------- |--------------------------- |
| field     | N        | String   | 排序欄位，預設為 updateTime    |
| order     | N        | String   | desc/asc，預設為 desc       |

* pagination

| Parameter | Required |  format  |  desc   |
| --------- | -------- | -------- |-------- |
| current| N| String | 目前頁數|
| pageSize| N| String |一頁幾筆 |


### Request Body Example:

``` javascript
{
  "query": {
    "keyword": "陳"
  },
  "pagination": {
    "current": "1",
    "pageSize": "10"
  },
  "sorter": {
    "field": "name",
    "order": "asc"
  }
}
```

### Response Body:
| Parameter        |  format  |  desc          | sort supported|
| ---------------- | -------- |----------------|-------------- |
| id               | String   | 成員ID         |               |
| name             | String   | 成員姓名        |               |
| gender           | Integer  | 成員性別        |               |
| idCardNo         | String   | 成員身分證號    |               |
| birthDate        | String   | 成員生日        |               |
| mobile           | String   | 成員手機號碼    |               |
| householdId        | String  | 家戶ID   |               |
| postCode        | String   | 郵遞區號   |               |
| address        | String   | 家戶地址   |               |
| phones           | Array   | 家戶電話清單        |              |

### Response Body Example:
* response: 200 

``` javascript
{
    "httpCode": 200,
    "result": {
        "data": [
            {
                "id": "2f06d422-4a5a-457d-8fef-1e863b3117ec",
                "name": "陳O勳",
                "gender": 1,
                "idCardNo": "A170989642",
                "birthDate": "2018-12-15",
                "mobile": "0988111206",
                "householdId": "187643c4-7586-4a95-97b1-eeae9709ecd4",
                "postCode": "84941",
                "address": "高雄市那瑪夏區南沙魯里鞍山巷1號",
                "phones": [
                    {
                        "id": "abc17246-7d21-4b6c-8966-3e827eb10584",
                        "phone": "3897801",
                        "phoneCode": "07"
                    }
                ]
            },
            {
                "id": "8a1d0d5a-5f4e-4627-bbc7-a571015f3a04",
                "name": "陳O妤",
                "gender": 1,
                "idCardNo": "A273319779",
                "birthDate": "2017-12-14",
                "mobile": "0988111205",
                "householdId": "187643c4-7586-4a95-97b1-eeae9709ecd4",
                "postCode": "84941",
                "address": "高雄市那瑪夏區南沙魯里鞍山巷1號",
                "phones": [
                    {
                        "id": "abc17246-7d21-4b6c-8966-3e827eb10584",
                        "phone": "3897801",
                        "phoneCode": "07"
                    }
                ]
            },
            {
                "id": "faabce6b-64c3-483f-8f5d-556c3db8b5a6",
                "name": "陳O豪",
                "gender": 1,
                "idCardNo": "A107234372",
                "birthDate": "1987-12-12",
                "mobile": "0988111203",
                "householdId": "187643c4-7586-4a95-97b1-eeae9709ecd4",
                "postCode": "84941",
                "address": "高雄市那瑪夏區南沙魯里鞍山巷1號",
                "phones": [
                    {
                        "id": "abc17246-7d21-4b6c-8966-3e827eb10584",
                        "phone": "3897801",
                        "phoneCode": "07"
                    }
                ]
            }
        ],
        "pagination": {
            "current": 1,
            "pageSize": 10,
            "total": 3
        },
        "sorter": {
            "field": "name",
            "order": "asc"
        }
    }
}
```


## 13. Get Name List
```url
GET /{contextPath}/householdMember/name/list
```

* 依據登入帳號取得該租戶成員名字列表
* 平台管理員會取得全平台成員名字列表

### Request Body:

### Response Body:
| Parameter        |  format  |  desc          | sort supported|
| ---------------- | -------- |----------------|-------------- |
| memberId         | string   | householdMemberId |               |
| name             | string   | 成員姓名           |               |
| gender           | int      | 性別, 1:男, 2:女   |               |
| mobile           | string    | 手機號碼          |               |

### Response Body Example:
* response: 200 

``` javascript
{
    "httpCode": 200,
    "result": {
        "data": [
            {
                "memberId": "db11315c-8116-42bd-8a43-d30d84a571ad",
                "name": "林小英",
                "gender": 2,
                "mobile": "0987654321"
            },
            {
                "memberId": "64c2fe5c-9a4b-462f-9c9b-674130bddb11",
                "name": "王小明",
                "gender": 1,
                "mobile": "0987654321"
            },
            ...
        ]
    }
}
```