---
# System prepended metadata

title: URI-H-01 公司搜尋 API
tags: [API規格, URI-H]

---

# URI-H-01 公司搜尋 API

> [name=Tony Fan]
###### tags: `URI-H` `API規格`

公司搜尋 API

前台公司查詢
ADM 公司使用(and)查詢
## 網址

- path :  `${TT-API網址}/companies/search/lists`
## Input JSON Path
- path :  `${TT-API網址}/companies/search/lists`
- method : POST
- query : 無
- body :  
```=json
{
  "did": "${did}",
  "companyId": [
    "$cid1",
    "$cid2",
    "..."
  ],
  "startPage": "${1|2|3|...}",
  "maxResults": "${5|10|15|20}",
}
```
### 輸入參數說明

買主註冊欄位
| 欄位名稱 | 欄位說明 | 型態 | 是否可為空值 | 
| -------- | -------- | -------- | -------- |
| did	 | 網別代碼	 | int	 | N | 
| companyId	 | 公司ID(多值陣列)	 | [`int(Array)`] | Y | 
| maxResults	 | 每頁項目數	 | int | Y | 
| startPage	 | 起始頁	 | int | Y | 

- did : 參考 [URI001](https://docs.google.com/spreadsheets/d/12U90GlZtqTFVemxzp5lFCv5l_eAZchVlOJN6xbRxDLI/edit#gid=0&range=A2)
- maxResults : 預設20，最多回傳筆數 20 筆以內
- startPage : 預設1

## Output JSON Path

參考 [URI-H-01 規格](https://docs.google.com/spreadsheets/d/1rxhe6EIYPio7kVi2mOQnlB9p3oClHAhoO5d3i3mr4wI/edit#gid=0&range=A16)


### 輸出參數說明

參考 [URI-H-01 規格](https://docs.google.com/spreadsheets/d/1rxhe6EIYPio7kVi2mOQnlB9p3oClHAhoO5d3i3mr4wI/edit#gid=0&range=A16)

## API邏輯
參考 [URI-H-01 API邏輯](https://hackmd.io/euWkfRB9RUio73DD1t-bkA) (需有權限才能瀏覽)


## 範例

參考 [URI-H-01 測試案例](https://docs.google.com/spreadsheets/d/1rxhe6EIYPio7kVi2mOQnlB9p3oClHAhoO5d3i3mr4wI/edit#gid=1426594997)
