---
# System prepended metadata

title: 工單管理 API 文件

---

# 工單管理 API 文件

[TOC]

## 參數說明

### Header

名稱 | 敘述
- | -
API-TOKEN | Token碼，用來驗證呼叫API的來源是否被允許。

以下呼叫API都需要帶以上Header。

### 工單類型(type)

| type  | 工單類型 | 備註 |
| ----- | ------- | --------  |
| 1     | 新增廳主 |             |
| 2     | 新增域名 |             |
| 3     | 刪除廳主 | 預留，暫無功能 |
| 4     | 刪除域名 | 使用前先呼叫 "[查詢域名清單在PDNS指定廳主下比對不存在結果](###查詢域名清單在PDNS指定廳主下比對不存在結果)"，確認所有域名存在才能呼叫刪除域名     |


## 工單匯入 API

`POST /api/v2/workCases`

#### 參數

| 名稱 | 型別 | 敘述 |
| --- | --- | --- |
| partner_id | int | Hall ID |
| partner_code | string(16) | 識別碼,同(後置碼) |
| platform_vender | string(128) | 平台商 |
| partner_name | string(128) | 站別 |
| is_partner_new | bool | 是否為新站 |
| type | int | 工單類型 |
| build_staff | string(32) | 建立人員 |
| is_pay | bool | 是否有PAY_IP |
| is_company_purchase | bool | 是否公司購買網址 |
| is_company_manage | bool | 是否公司管理網址 |
| is_escrow_permission | bool | 是否提供代管權限(非必填) |
| escrow_account | string(128) | 網址商帳號，如果要提供代管權限，則此欄必填 |
| escrow_password | string(128) | 網址商密碼(非必填) |
| customer_domain_names | array | 客端域名 |
| partner_domain_names | array | 廳主端域名 |
| description | string | 備註(非必填) |

#### 注意事項

##### 刪除域名
1. (type=4)時，is_pay,is_company_purchase,is_company_manage 填入預設值
2. 域名資料填入 "客端域名"，廳主廳域名傳空陣列


#### Example1

```json=
{
    "partner_id": 17,
    "partner_code": "hsr2",
    "platform_vender": "NBB",
    "partner_name": "測試廳",
    "is_partner_new": true,
    "type": 1,
    "build_staff": "BBOS_RD5",
    "is_pay": false,
    "is_company_purchase": true,
    "is_company_manage": true,
    "is_escrow_permission": true,
    "escrow_account": "123",
    "escrow_password": "zzz",
    "partner_domain_names": [
        "zzz.com", "yyy.com", "xxx.com"
    ],
    "customer_domain_names": [
        "123.com", "456.com"
    ],
    "description": "test"
}
```

#### Response

`Status: 201 Created`

```json=
{
  "id": 1
}
```

#### Error

```json=
{
  "error": 3001
}
```

代碼: 敘述

1: 未知的錯誤

1009: 未授權(未帶Token)

2001: 新增失敗

3001: 輸入有空值

3002: 無效的參數

10001: 廳主已存在

10002: 廳主不存在

10004: 域名有重複



## 查詢域名清單在PDNS指定廳主下比對不存在結果 API

`GET /api/workCases/partner/pdns_domain_compare`

#### Example

```json=
{
    "partner_id": 1,
    "domain_names": ["xxx.com", "bbb.com", "ccc.com"]
}
```

#### Response

`Status: 200 OK`

```json=
{
    "not_exist": ["xxx.com", "bbb.com"]
}
```

#### Error

`Status: 400 BAD REQUEST`

```json=
{
  "error": 3001
}
```

代碼: 敘述

1: 未知的錯誤

3001: 輸入有空值

3002: 無效的參數

3003: 無效的廳主 ID
