---
title: API接口文档
language_tabs:
- shell: Shell
- http: HTTP
- javascript: JavaScript
- ruby: Ruby
- python: Python
- php: PHP
- java: Java
- go: Go
toc_footers: []
includes: []
search: true
code_clipboard: true
highlight_theme: darkula
headingLevel: 2
generator: "@tarslib/widdershins v4.0.30"
---
# API接口文档
Base URLs:
# Authentication
# wfc-auth/token-controller
## POST register
POST /register
> Body 请求参数
```json
{
"username": "string",
"password": "string",
"authType": "string",
"wanfiRedirectParams": {
"clientMac": "string",
"clientIp": "string",
"t": 0,
"site": "string",
"redirectUrl": "string",
"apMac": "string",
"ssidName": "string",
"radioId": 0
},
"email": "string",
"fullName": "string",
"age": 0,
"address": "string",
"birthDate": "2019-08-24T14:15:22Z",
"sex": "string",
"phonenumber": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[RegisterBody
](#schemaregisterbody)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RObject](#schemarobject)|
## POST refresh
POST /refresh
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RObject](#schemarobject)|
## POST login
POST /login
> Body 请求参数
```json
{
"username": "string",
"password": "string",
"authType": "string",
"wanfiRedirectParams": {
"clientMac": "string",
"clientIp": "string",
"t": 0,
"site": "string",
"redirectUrl": "string",
"apMac": "string",
"ssidName": "string",
"radioId": 0
}
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[LoginBody
](#schemaloginbody)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RObject](#schemarobject)|
## POST checkRepeat
POST /checkRepeat
> Body 请求参数
```json
{
"username": "string",
"password": "string",
"authType": "string",
"wanfiRedirectParams": {
"clientMac": "string",
"clientIp": "string",
"t": 0,
"site": "string",
"redirectUrl": "string",
"apMac": "string",
"ssidName": "string",
"radioId": 0
},
"email": "string",
"fullName": "string",
"age": 0,
"address": "string",
"birthDate": "2019-08-24T14:15:22Z",
"sex": "string",
"phonenumber": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[RegisterBody
](#schemaregisterbody)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RObject](#schemarobject)|
## GET health
GET /health
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RObject](#schemarobject)|
## DELETE logout
DELETE /logout
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RObject](#schemarobject)|
# wfc-system/sys-wlan-controller
## GET getSsidDetail
GET /wlan/ssid/{siteId
}/{wlanId
}/{ssidId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|wlanId|path|string| 是 |none|
|ssidId|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {
"ssidId": "string",
"name": "string",
"band": 0,
"guestNetEnable": true,
"security": 0,
"broadcast": true,
"vlanEnable": true,
"vlanId": 0,
"pskSetting": {},
"entSetting": {},
"ppskSetting": {},
"mloEnable": true,
"pmfMode": 0,
"enable11r": true,
"clientRateLimit": {},
"ssidRateLimit": {},
"wlanSchedule": {
"wlanScheduleEnable": true,
"action": 0,
"scheduleId": "string"
},
"rateControl": {
"rate2gCtrlEnable": true,
"lowerDensity2g": 0,
"higherDensity2g": 0,
"cckRatesDisable": true,
"clientRatesRequire2g": true,
"sendBeacons2g": true,
"rate5gCtrlEnable": true,
"lowerDensity5g": 0,
"higherDensity5g": 0,
"clientRatesRequire5g": true,
"sendBeacons5g": true,
"rate6gCtrlEnable": true,
"lowerDensity6g": 0,
"higherDensity6g": 0,
"clientRatesRequire6g": true,
"sendBeacons6g": true
},
"macFilter": {
"macFilterEnable": true,
"policy": 0,
"macFilterId": "string",
"ouiProfileIdList": [
"string"
]
},
"multiCast": {
"multiCastEnable": true,
"channelUtil": 0,
"arpCastEnable": true,
"ipv6CastEnable": true,
"filterEnable": true,
"filterMode": 0,
"macGroupId": "string"
},
"dhcpOption82": {
"dhcpEnable": true,
"format": 0,
"delimiter": "string",
"circuitId": [
0
],
"remoteId": [
0
]
},
"deviceType": 0
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RSsidDetailOpenApiVo](#schemarssiddetailopenapivo)|
## PUT updateSsidBasicConfig
PUT /wlan/ssid/{siteId
}/{wlanId
}/{ssidId
}
> Body 请求参数
```json
{
"name": "string",
"band": 0,
"guestNetEnable": true,
"security": 0,
"broadcast": true,
"vlanEnable": true,
"vlanId": 0,
"pskSetting": {},
"entSetting": {},
"ppskSetting": {},
"mloEnable": true,
"pmfMode": 0,
"enable11r": true,
"hidePwd": true,
"greEnable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|wlanId|path|string| 是 |none|
|ssidId|path|string| 是 |none|
|body|body|[UpdateSsidBasicConfigOpenApiVo
](#schemaupdatessidbasicconfigopenapivo)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## DELETE deleteSsid
DELETE /wlan/ssid/{siteId
}/{wlanId
}/{ssidId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|wlanId|path|string| 是 |none|
|ssidId|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## GET getSsidList
GET /wlan/ssid/{siteId
}/{wlanId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|wlanId|path|string| 是 |none|
|pageNum|query|integer(int32)| 是 |none|
|pageSize|query|integer(int32)| 是 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## POST createSsid
POST /wlan/ssid/{siteId
}/{wlanId
}
> Body 请求参数
```json
{
"name": "string",
"deviceType": 0,
"band": 0,
"guestNetEnable": true,
"security": 0,
"broadcast": true,
"vlanEnable": true,
"vlanId": 0,
"pskSetting": {},
"entSetting": {},
"ppskSetting": {},
"mloEnable": true,
"pmfMode": 0,
"enable11r": true,
"hidePwd": true,
"greEnable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|wlanId|path|string| 是 |none|
|body|body|[CreateSsidOpenApiVo
](#schemacreatessidopenapivo)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## GET getMacAuthSsids
GET /wlan/ssids/{siteId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": [
{
"wlanId": "string",
"wlanName": "string",
"ssidList": [
{
"ssidId": "string",
"ssidName": "string"
}
]
}
]
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RListWlanSimpleOpenApiVo](#schemarlistwlansimpleopenapivo)|
## GET getWlanGroupList
GET /wlan/group/{siteId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": [
{
"wlanId": "string",
"name": "string",
"primary": true
}
]
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RListWlanGroupOpenApiVo](#schemarlistwlangroupopenapivo)|
# wfc-system/sys-user-controller
## GET listUser
GET /user/listUser
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|userId|query|integer(int64)| 否 |none|
|deptId|query|integer(int64)| 否 |none|
|userName|query|string| 是 |none|
|birthDate|query|string(date-time)| 否 |none|
|nickName|query|string| 否 |none|
|email|query|string| 否 |none|
|phonenumber|query|string| 否 |none|
|sex|query|string| 否 |none|
|avatar|query|string| 否 |none|
|password|query|string| 否 |none|
|fullName|query|string| 否 |none|
|age|query|integer(int32)| 否 |none|
|address|query|string| 否 |none|
|status|query|string| 否 |none|
|delFlag|query|string| 否 |none|
|loginIp|query|string| 否 |none|
|loginDate|query|string(date-time)| 否 |none|
|dept|query|[UDept
](#schemaudept)| 否 |none|
|roles|query|array[object
]| 否 |none|
|roleIds|query|array[integer
]| 否 |none|
|postIds|query|array[integer
]| 否 |none|
|roleId|query|integer(int64)| 否 |none|
|kycStatus|query|string| 否 |none|
|admin|query|boolean| 否 |none|
|pageNum|query|integer(int32)| 是 |none|
|pageSize|query|integer(int32)| 是 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
# wfc-system/u-payment-controller
## PUT edit_1
PUT /system/uPayment
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"name": "string",
"type": 0,
"appId": "string",
"serverUrl": "string",
"domain": "string",
"privateKey": "string",
"publicKey": "string",
"appCertPath": "string",
"certPath": "string",
"rootCertPath": "string",
"enable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UPayment
](#schemaupayment)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_1
POST /system/uPayment
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"name": "string",
"type": 0,
"appId": "string",
"serverUrl": "string",
"domain": "string",
"privateKey": "string",
"publicKey": "string",
"appCertPath": "string",
"certPath": "string",
"rootCertPath": "string",
"enable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UPayment
](#schemaupayment)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getById
GET /system/uPayment/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET page
GET /system/uPayment/page
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|name|query|string| 否 |支付名称|
|type|query|integer(int32)| 否 |类型(0支付宝 1微信 2信用卡)|
|appId|query|string| 否 |应用编号|
|serverUrl|query|string| 否 |支付网关|
|domain|query|string| 否 |外网访问项目的域名|
|privateKey|query|string| 否 |应用私钥|
|publicKey|query|string| 否 |应用公钥|
|appCertPath|query|string| 否 |应用公钥证书|
|certPath|query|string| 否 |公钥证书|
|rootCertPath|query|string| 否 |根证书|
|enable|query|boolean| 否 |是否启用|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET list_1
GET /system/uPayment/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|name|query|string| 否 |支付名称|
|type|query|integer(int32)| 否 |类型(0支付宝 1微信 2信用卡)|
|appId|query|string| 否 |应用编号|
|serverUrl|query|string| 否 |支付网关|
|domain|query|string| 否 |外网访问项目的域名|
|privateKey|query|string| 否 |应用私钥|
|publicKey|query|string| 否 |应用公钥|
|appCertPath|query|string| 否 |应用公钥证书|
|certPath|query|string| 否 |公钥证书|
|rootCertPath|query|string| 否 |根证书|
|enable|query|boolean| 否 |是否启用|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove_1
DELETE /system/uPayment/{ids
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|ids|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-system/sys-site-controller
## GET getSiteInfo
GET /site/{siteId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {
"siteId": "string",
"name": "string",
"type": 0,
"tagIds": [
"string"
],
"region": "string",
"timeZone": "string",
"ntpEnable": true,
"ntpServers": [
"string"
],
"dst": {
"enable": true,
"start": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"end": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"status": true,
"startTime": 0,
"endTime": 0,
"offset": 0,
"nextStart": 0,
"nextEnd": 0,
"timeZone": "string",
"lastStart": 0,
"lastEnd": 0
},
"scenario": "string",
"longitude": 0.1,
"latitude": 0.1,
"address": "string",
"supportES": true,
"supportL2": true
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RSiteEntity](#schemarsiteentity)|
## PUT updateSite
PUT /site/{siteId
}
> Body 请求参数
```json
{
"name": "string",
"region": "string",
"timeZone": "string",
"tagIds": [
"string"
],
"ntpEnable": true,
"ntpServers": [
{
"address": "string"
}
],
"dst": {
"enable": true,
"start": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"end": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"offset": 0
},
"scenario": "string",
"longitude": 0.1,
"latitude": 0.1,
"address": "string",
"supportES": true,
"supportL2": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|body|body|[UpdateSiteEntity
](#schemaupdatesiteentity)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## DELETE deleteSite
DELETE /site/{siteId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## POST createNewSite
POST /site
> Body 请求参数
```json
{
"name": "string",
"type": 0,
"region": "string",
"timeZone": "string",
"scenario": "string",
"tagIds": [
"string"
],
"longitude": 0.1,
"latitude": 0.1,
"address": "string",
"deviceAccountSetting": {
"username": "string",
"password": "string"
},
"supportES": true,
"supportL2": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[CreateSiteEntity
](#schemacreatesiteentity)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## GET getRoamingSetting
GET /site/{siteId
}/roaming
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {
"roaming": {
"fastRoamingEnable": true,
"aiRoamingEnable": true,
"dualBand11kReportEnable": true,
"forceDisassociationEnable": true,
"nonStickRoamingEnable": true
}
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RSiteRoamingSetting](#schemarsiteroamingsetting)|
## POST updateRoamingSetting
POST /site/{siteId
}/roaming
> Body 请求参数
```json
{
"roaming": {
"fastRoamingEnable": true,
"aiRoamingEnable": true,
"dualBand11kReportEnable": true,
"forceDisassociationEnable": true,
"nonStickRoamingEnable": true
}
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|body|body|[SiteRoamingSetting
](#schemasiteroamingsetting)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## GET getMeshSetting
GET /site/{siteId
}/mesh
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {
"mesh": {
"meshEnable": true,
"autoFailoverEnable": true,
"defGatewayEnable": true,
"gateway": "string",
"fullSector": true
}
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RSiteMeshSetting](#schemarsitemeshsetting)|
## POST updateMeshSetting
POST /site/{siteId
}/mesh
> Body 请求参数
```json
{
"mesh": {
"meshEnable": true,
"autoFailoverEnable": true,
"defGatewayEnable": true,
"gateway": "string",
"fullSector": true
}
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|body|body|[SiteMeshSetting
](#schemasitemeshsetting)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## GET getSiteList
GET /site/page
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|pageNum|query|integer(int32)| 是 |none|
|pageSize|query|integer(int32)| 是 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
# wfc-system/u-rate-limit-controller
## PUT edit_3
PUT /rateLimit
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[URateLimit
](#schemauratelimit)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_3
POST /rateLimit
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[URateLimit
](#schemauratelimit)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getById_1
GET /rateLimit/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove_3
DELETE /rateLimit/{ids
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|ids|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-system/sys-portal-controller
## GET getPortalDetail
GET /portal/{siteId
}/{portalId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|portalId|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {
"id": "string",
"name": "string",
"enable": true,
"ssidList": [
"string"
],
"networkList": [
"string"
],
"authType": 0,
"authTimeout": {
"authTimeout": 0,
"customTimeout": 0,
"customTimeoutUnit": 0
},
"httpsRedirectEnable": true,
"landingPage": 0,
"landingUrlScheme": "string",
"landingUrl": "string",
"noAuth": {},
"simplePassword": {},
"hotspot": {},
"sms": {
"sid": "string",
"authToken": "string",
"phoneNum": "string",
"maxVerificationCodeEnable": true,
"maxVerificationCodeTimes": 0,
"authTimeout": {
"authTimeout": 0,
"customTimeout": 0,
"customTimeoutUnit": 0
},
"countryCode": "string"
},
"portalFormId": "string",
"hotspotRadius": {
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"authTimeout": {
"authTimeout": 0,
"customTimeout": 0,
"customTimeoutUnit": 0
},
"disconnectReq": true,
"receiverPort": 0,
"receiverPortStatus": 0
},
"externalPortal": {},
"externalRadius": {
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string",
"disconnectReq": true,
"receiverPort": 0,
"receiverPortStatus": 0
},
"ldap": {
"ldapProfileId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string"
}
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RPortalDetailResOpenApiVo](#schemarportaldetailresopenapivo)|
## PUT modifyPortal
PUT /portal/{siteId
}/{portalId
}
> Body 请求参数
```json
{
"name": "string",
"enable": true,
"ssidList": [
"string"
],
"networkList": [
"string"
],
"authType": 0,
"authTimeout": {
"customTimeout": 0,
"customTimeoutUnit": 0
},
"httpsRedirectEnable": true,
"landingPage": 0,
"landingUrlScheme": "string",
"landingUrl": "string",
"noAuth": {},
"simplePassword": {},
"hotspot": {},
"sms": {
"sid": "string",
"authToken": "string",
"phoneNum": "string",
"userLimitEnable": true,
"userLimit": 0,
"authTimeout": {
"customTimeout": 0,
"customTimeoutUnit": 0
},
"countryCode": "string"
},
"portalFormId": "string",
"hotspotRadius": {
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"authTimeout": {
"customTimeout": 0,
"customTimeoutUnit": 0
},
"disconnectReq": true,
"receiverPort": 0
},
"externalPortal": {},
"externalRadius": {
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string",
"disconnectReq": true,
"receiverPort": 0
},
"ldap": {
"ldapProfileId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string"
},
"pageType": 0,
"importedPortalPage": {
"id": "string"
},
"portalCustomize": {
"defaultLanguage": 0,
"backgroundPictureId": "string",
"logoPictureId": "string",
"logoDisplay": true,
"inputBoxColor": "string",
"inputBoxOpacity": 0,
"inputTextColor": "string",
"inputTextOpacity": 0,
"buttonColor": "string",
"buttonOpacity": 0,
"buttonTextColor": "string",
"buttonTextOpacity": 0,
"buttonText": "string",
"formAuthButtonText": "string",
"welcomeEnable": true,
"welcomeInformation": "string",
"welcomeTextColor": "string",
"welcomeTextOpacity": 0,
"welcomeTextFontSize": 0,
"termsOfServiceEnable": true,
"termsOfServiceText": "string",
"termsOfServiceFontSize": 0,
"termsOfServiceUrlTexts": [
{}
],
"copyrightEnable": true,
"copyright": "string",
"copyrightTextColor": "string",
"copyrightTextOpacity": 0,
"copyrightTextFontSize": 0,
"redirectionCountDownEnable": true,
"advertisement": {
"enable": true,
"pictureIds": [
"string"
],
"totalDuration": 0,
"pictureInterval": 0,
"skipEnable": true
}
}
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|portalId|path|string| 是 |none|
|body|body|[PortalSetting
](#schemaportalsetting)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## DELETE deletePortal
DELETE /portal/{siteId
}/{portalId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|portalId|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## GET getPortalList
GET /portal/{siteId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|pageNum|query|integer(int32)| 是 |none|
|pageSize|query|integer(int32)| 是 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## POST addPortal
POST /portal/{siteId
}
> Body 请求参数
```json
{
"name": "string",
"enable": true,
"ssidList": [
"string"
],
"networkList": [
"string"
],
"authType": 0,
"authTimeout": {
"customTimeout": 0,
"customTimeoutUnit": 0
},
"httpsRedirectEnable": true,
"landingPage": 0,
"landingUrlScheme": "string",
"landingUrl": "string",
"noAuth": {},
"simplePassword": {},
"hotspot": {},
"sms": {
"sid": "string",
"authToken": "string",
"phoneNum": "string",
"userLimitEnable": true,
"userLimit": 0,
"authTimeout": {
"customTimeout": 0,
"customTimeoutUnit": 0
},
"countryCode": "string"
},
"portalFormId": "string",
"hotspotRadius": {
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"authTimeout": {
"customTimeout": 0,
"customTimeoutUnit": 0
},
"disconnectReq": true,
"receiverPort": 0
},
"externalPortal": {},
"externalRadius": {
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string",
"disconnectReq": true,
"receiverPort": 0
},
"ldap": {
"ldapProfileId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string"
},
"pageType": 0,
"importedPortalPage": {
"id": "string"
},
"portalCustomize": {
"defaultLanguage": 0,
"backgroundPictureId": "string",
"logoPictureId": "string",
"logoDisplay": true,
"inputBoxColor": "string",
"inputBoxOpacity": 0,
"inputTextColor": "string",
"inputTextOpacity": 0,
"buttonColor": "string",
"buttonOpacity": 0,
"buttonTextColor": "string",
"buttonTextOpacity": 0,
"buttonText": "string",
"formAuthButtonText": "string",
"welcomeEnable": true,
"welcomeInformation": "string",
"welcomeTextColor": "string",
"welcomeTextOpacity": 0,
"welcomeTextFontSize": 0,
"termsOfServiceEnable": true,
"termsOfServiceText": "string",
"termsOfServiceFontSize": 0,
"termsOfServiceUrlTexts": [
{}
],
"copyrightEnable": true,
"copyright": "string",
"copyrightTextColor": "string",
"copyrightTextOpacity": 0,
"copyrightTextFontSize": 0,
"redirectionCountDownEnable": true,
"advertisement": {
"enable": true,
"pictureIds": [
"string"
],
"totalDuration": 0,
"pictureInterval": 0,
"skipEnable": true
}
}
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|body|body|[PortalSetting
](#schemaportalsetting)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
# wfc-system/u-package-controller
## PUT edit_5
PUT /package
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitId": 0,
"packageName": "string",
"periodNum": 0,
"periodType": 0,
"price": 0,
"traffic": 0,
"duration": 0,
"clientNum": 0,
"remark": "string",
"rateLimitEnable": true,
"trafficEnable": true,
"durationEnable": true,
"clientNumEnable": true,
"packageEnable": true,
"rateLimits": {
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true
}
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UPackage
](#schemaupackage)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_5
POST /package
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitId": 0,
"packageName": "string",
"periodNum": 0,
"periodType": 0,
"price": 0,
"traffic": 0,
"duration": 0,
"clientNum": 0,
"remark": "string",
"rateLimitEnable": true,
"trafficEnable": true,
"durationEnable": true,
"clientNumEnable": true,
"packageEnable": true,
"rateLimits": {
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true
}
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UPackage
](#schemaupackage)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getById_2
GET /package/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove_5
DELETE /package/{ids
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|ids|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-system/sys-notice-controller
## PUT edit_6
PUT /notice
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"noticeId": 0,
"noticeTitle": "string",
"noticeType": "string",
"noticeContent": "string",
"status": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[SysNotice
](#schemasysnotice)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_7
POST /notice
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"noticeId": 0,
"noticeTitle": "string",
"noticeType": "string",
"noticeContent": "string",
"status": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[SysNotice
](#schemasysnotice)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getInfo_5
GET /notice/{noticeId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|noticeId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET list_9
GET /notice/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|noticeId|query|integer(int64)| 否 |none|
|noticeTitle|query|string| 是 |none|
|noticeType|query|string| 否 |none|
|noticeContent|query|string| 否 |none|
|status|query|string| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## DELETE remove_7
DELETE /notice/{noticeIds
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|noticeIds|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-system/u-kyc-controller
## PUT reject
PUT /kyc/reject
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"kycId": 0,
"userId": 0,
"realName": "string",
"birthDate": "string",
"idType": 0,
"idFile": "string",
"identifyPicture": "string",
"status": 0,
"description": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UKyc
](#schemaukyc)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT approve
PUT /kyc/approve
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"kycId": 0,
"userId": 0,
"realName": "string",
"birthDate": "string",
"idType": 0,
"idFile": "string",
"identifyPicture": "string",
"status": 0,
"description": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UKyc
](#schemaukyc)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getById_4
GET /kyc/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-system/sys-device-controller
## PUT edit_10
PUT /device
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"siteId": "string",
"mac": "string",
"name": "string",
"type": "string",
"subtype": "string",
"deviceSeriesType": "string",
"model": "string",
"ip": "string",
"ipv6s": "string",
"uptime": "string",
"status": 0,
"lastSeen": 0,
"cpuUtil": 0,
"memUtil": 0,
"sn": "string",
"licenseStatus": 0,
"tagName": "string",
"uplinkDeviceMac": "string",
"uplinkDeviceName": "string",
"uplinkDevicePort": "string",
"linkSpeed": 0,
"duplex": 0,
"switchConsistent": true,
"publicIp": "string",
"firmwareVersion": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[SysDevice
](#schemasysdevice)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_12
POST /device
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"siteId": "string",
"mac": "string",
"name": "string",
"type": "string",
"subtype": "string",
"deviceSeriesType": "string",
"model": "string",
"ip": "string",
"ipv6s": "string",
"uptime": "string",
"status": 0,
"lastSeen": 0,
"cpuUtil": 0,
"memUtil": 0,
"sn": "string",
"licenseStatus": 0,
"tagName": "string",
"uplinkDeviceMac": "string",
"uplinkDeviceName": "string",
"uplinkDevicePort": "string",
"linkSpeed": 0,
"duplex": 0,
"switchConsistent": true,
"publicIp": "string",
"firmwareVersion": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[SysDevice
](#schemasysdevice)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST updateConfig
POST /device/updateConfig/{siteId
}/{deviceMac
}
> Body 请求参数
```json
{
"name": "string",
"ledSetting": 0,
"tagIds": [
"string"
],
"location": {
"longitude": 0.1,
"latitude": 0.1,
"address": "string"
}
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|deviceMac|path|string| 是 |none|
|body|body|[ApGeneralConfig
](#schemaapgeneralconfig)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## POST testJob
POST /device/testJob
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RString](#schemarstring)|
## POST startAdoptDevice
POST /device/startAdopt/{siteId
}/{deviceMac
}
> Body 请求参数
```json
{
"username": "string",
"password": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|deviceMac|path|string| 是 |none|
|body|body|[AdoptDeviceRequest
](#schemaadoptdevicerequest)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## POST settingJob
POST /device/settingJob
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST rebootDevice
POST /device/reboot/{siteId
}/{deviceMac
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|deviceMac|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## POST getConfig
POST /device/getConfig/{siteId
}/{deviceMac
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|deviceMac|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {
"name": "string",
"ledSetting": 0,
"tagIds": [
"string"
],
"location": {
"longitude": 0.1,
"latitude": 0.1,
"address": "string"
}
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RApGeneralConfig](#schemarapgeneralconfig)|
## POST forgetDevice
POST /device/forget/{siteId
}/{deviceMac
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|deviceMac|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## POST deviceJob
POST /device/deviceJob
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST addDevice
POST /device/add/{siteId
}
> Body 请求参数
```json
{
"devices": [
{
"sn": "string",
"name": "string",
"username": "string",
"password": "string"
}
]
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|body|body|[DeviceListAddBySnOpenApiVo
](#schemadevicelistaddbysnopenapivo)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## GET getById_5
GET /device/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET page_4
GET /device/page/{siteId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|pageNum|query|integer(int32)| 是 |none|
|pageSize|query|integer(int32)| 是 |none|
|searchKey|query|string| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET list_15
GET /device/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|siteId|query|string| 否 |siteId|
|mac|query|string| 否 |mac|
|name|query|string| 否 |name|
|type|query|string| 否 |type|
|subtype|query|string| 否 |subtype|
|deviceSeriesType|query|string| 否 |deviceSeriesType|
|model|query|string| 否 |model|
|ip|query|string| 否 |ip|
|ipv6s|query|string| 否 |ipv6s|
|uptime|query|string| 否 |uptime|
|status|query|integer(int32)| 否 |status|
|lastSeen|query|integer(int64)| 否 |lastSeen|
|cpuUtil|query|integer(int32)| 否 |cpuUtil|
|memUtil|query|integer(int32)| 否 |memUtil|
|sn|query|string| 否 |sn|
|licenseStatus|query|integer(int32)| 否 |licenseStatus|
|tagName|query|string| 否 |tagName|
|uplinkDeviceMac|query|string| 否 |uplinkDeviceMac|
|uplinkDeviceName|query|string| 否 |uplink_device_name|
|uplinkDevicePort|query|string| 否 |uplinkDevicePort|
|linkSpeed|query|integer(int32)| 否 |linkSpeed|
|duplex|query|integer(int32)| 否 |duplex|
|switchConsistent|query|boolean| 否 |switchConsistent|
|publicIp|query|string| 否 |publicIp|
|firmwareVersion|query|string| 否 |firmwareVersion|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove_12
DELETE /device/{ids
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|ids|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-system/sys-config-controller
## PUT setPayConfig
PUT /config/pay
> Body 请求参数
```json
{
"currency": "string",
"currencySymbol": "string",
"paymentMethods": [
"string"
]
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[SysPayConfigBo
](#schemasyspayconfigbo)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
# wfc-system/u-bill-rule-controller
## PUT edit_13
PUT /billRule
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"price": 0,
"traffic": 0,
"unit": 0,
"enable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UBillRule
](#schemaubillrule)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_15
POST /billRule
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"price": 0,
"traffic": 0,
"unit": 0,
"enable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UBillRule
](#schemaubillrule)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getById_6
GET /billRule/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET page_7
GET /billRule/page
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|price|query|number| 否 |价格|
|traffic|query|integer(int64)| 否 |流量|
|unit|query|integer(int32)| 否 |单位|
|enable|query|boolean| 否 |是否启用|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET list_19
GET /billRule/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|price|query|number| 否 |价格|
|traffic|query|integer(int64)| 否 |流量|
|unit|query|integer(int32)| 否 |单位|
|enable|query|boolean| 否 |是否启用|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove_15
DELETE /billRule/{ids
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|ids|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-system/sys-omada-log-controller
## GET getAlertLogsForSite
GET /log/alerts/{siteId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|pageNum|query|integer(int32)| 是 |none|
|pageSize|query|integer(int32)| 是 |none|
|filters.timeStart|query|integer(int64)| 是 |none|
|filters.timeEnd|query|integer(int64)| 是 |none|
|filters.module|query|string| 否 |none|
|filters.resolved|query|boolean| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## POST resolveAlertForSite
POST /log/alerts/{siteId
}
> Body 请求参数
```json
{
"logs": [
"string"
],
"selectType": "string",
"startTime": 0,
"endTime": 0,
"filterModule": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|body|body|[ResolveSiteLogListOpenApiVo
](#schemaresolvesiteloglistopenapivo)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## DELETE deleteAlertLogsForSite
DELETE /log/alerts/{siteId
}
> Body 请求参数
```json
{
"logs": [
"string"
],
"selectType": "string",
"startTime": 0,
"endTime": 0,
"filterModule": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|body|body|[DeleteSiteAlertLogListOpenApiVo
](#schemadeletesitealertloglistopenapivo)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
# wfc-system/sys-access-control-controller
## GET getAccessControl
GET /access-control/{siteId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {
"preAuthAccessEnable": true,
"preAuthAccessPolicies": [
{
"idInt": 0,
"type": 0,
"ip": "string",
"subnetMask": 0,
"url": "string"
}
],
"freeAuthClientEnable": true,
"freeAuthClientPolicies": [
{
"idInt": 0,
"type": 0,
"clientIp": "string",
"clientMac": "string"
}
]
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RPortalAccessControlOpenApiVo](#schemarportalaccesscontrolopenapivo)|
## POST modifyAccessControl
POST /access-control/{siteId
}
> Body 请求参数
```json
{
"preAuthAccessEnable": true,
"preAuthAccessPolicies": [
{
"idInt": 0,
"type": 0,
"ip": "string",
"subnetMask": 0,
"url": "string"
}
],
"freeAuthClientEnable": true,
"freeAuthClientPolicies": [
{
"idInt": 0,
"type": 0,
"clientIp": "string",
"clientMac": "string"
}
]
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|siteId|path|string| 是 |none|
|body|body|[PortalAccessControlOpenApiVo
](#schemaportalaccesscontrolopenapivo)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
# wfc-system/sys-dashboard-controller
## GET page_5
GET /dashboard/page
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|searchKey|query|string| 否 |none|
|pageNum|query|integer(int32)| 是 |none|
|pageSize|query|integer(int32)| 是 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET overview
GET /dashboard/overview
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-system/u-client-controller
## GET page_6
GET /client/page
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|searchKey|query|string| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET list_18
GET /client/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|searchKey|query|string| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-job/sys-job-controller
## PUT edit
PUT /job
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"jobId": 0,
"jobName": "string",
"jobGroup": "string",
"invokeTarget": "string",
"cronExpression": "string",
"misfirePolicy": "string",
"concurrent": "string",
"status": "string",
"nextValidTime": "2019-08-24T14:15:22Z"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[SysJob
](#schemasysjob)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add
POST /job
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"jobId": 0,
"jobName": "string",
"jobGroup": "string",
"invokeTarget": "string",
"cronExpression": "string",
"misfirePolicy": "string",
"concurrent": "string",
"status": "string",
"nextValidTime": "2019-08-24T14:15:22Z"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[SysJob
](#schemasysjob)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT run
PUT /job/run
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"jobId": 0,
"jobName": "string",
"jobGroup": "string",
"invokeTarget": "string",
"cronExpression": "string",
"misfirePolicy": "string",
"concurrent": "string",
"status": "string",
"nextValidTime": "2019-08-24T14:15:22Z"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[SysJob
](#schemasysjob)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT changeStatus
PUT /job/changeStatus
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"jobId": 0,
"jobName": "string",
"jobGroup": "string",
"invokeTarget": "string",
"cronExpression": "string",
"misfirePolicy": "string",
"concurrent": "string",
"status": "string",
"nextValidTime": "2019-08-24T14:15:22Z"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[SysJob
](#schemasysjob)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST export_1
POST /job/export
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|jobId|query|integer(int64)| 否 |none|
|jobName|query|string| 是 |none|
|jobGroup|query|string| 否 |none|
|invokeTarget|query|string| 是 |none|
|cronExpression|query|string| 是 |none|
|misfirePolicy|query|string| 否 |none|
|concurrent|query|string| 否 |none|
|status|query|string| 否 |none|
|nextValidTime|query|string(date-time)| 否 |none|
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### 返回数据结构
## GET getInfo
GET /job/{jobId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|jobId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET list_1
GET /job/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|jobId|query|integer(int64)| 否 |none|
|jobName|query|string| 是 |none|
|jobGroup|query|string| 否 |none|
|invokeTarget|query|string| 是 |none|
|cronExpression|query|string| 是 |none|
|misfirePolicy|query|string| 否 |none|
|concurrent|query|string| 否 |none|
|status|query|string| 否 |none|
|nextValidTime|query|string(date-time)| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## DELETE remove
DELETE /job/{jobIds
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|jobIds|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-job/sys-job-log-controller
## POST export
POST /job/log/export
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|jobLogId|query|integer(int64)| 否 |none|
|jobName|query|string| 否 |none|
|jobGroup|query|string| 否 |none|
|invokeTarget|query|string| 否 |none|
|jobMessage|query|string| 否 |none|
|status|query|string| 否 |none|
|exceptionInfo|query|string| 否 |none|
|startTime|query|string(date-time)| 否 |none|
|stopTime|query|string(date-time)| 否 |none|
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### 返回数据结构
## GET getInfo_1
GET /job/log/{jobLogId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|jobLogId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET list
GET /job/log/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|jobLogId|query|integer(int64)| 否 |none|
|jobName|query|string| 否 |none|
|jobGroup|query|string| 否 |none|
|invokeTarget|query|string| 否 |none|
|jobMessage|query|string| 否 |none|
|status|query|string| 否 |none|
|exceptionInfo|query|string| 否 |none|
|startTime|query|string(date-time)| 否 |none|
|stopTime|query|string(date-time)| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## DELETE remove_1
DELETE /job/log/{jobLogIds
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|jobLogIds|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE clean
DELETE /job/log/clean
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-user-controller
## PUT edit
PUT /user
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"birthDate": "2019-08-24T14:15:22Z",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"remark": null,
"params": null,
"deptId": null,
"parentId": null,
"ancestors": null,
"deptName": null,
"orderNum": null,
"leader": null,
"phone": null,
"email": null,
"status": null,
"delFlag": null,
"parentName": null,
"children": null
}
]
}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"kycStatus": "string",
"admin": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UUser
](#schemauuser)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add
POST /user
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"birthDate": "2019-08-24T14:15:22Z",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"remark": null,
"params": null,
"deptId": null,
"parentId": null,
"ancestors": null,
"deptName": null,
"orderNum": null,
"leader": null,
"phone": null,
"email": null,
"status": null,
"delFlag": null,
"parentName": null,
"children": null
}
]
}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"kycStatus": "string",
"admin": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UUser
](#schemauuser)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT resetPwd
PUT /user/resetPwd
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"birthDate": "2019-08-24T14:15:22Z",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"remark": null,
"params": null,
"deptId": null,
"parentId": null,
"ancestors": null,
"deptName": null,
"orderNum": null,
"leader": null,
"phone": null,
"email": null,
"status": null,
"delFlag": null,
"parentName": null,
"children": null
}
]
}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"kycStatus": "string",
"admin": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UUser
](#schemauuser)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT recordlogin
PUT /user/recordlogin
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"birthDate": "2019-08-24T14:15:22Z",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"remark": null,
"params": null,
"deptId": null,
"parentId": null,
"ancestors": null,
"deptName": null,
"orderNum": null,
"leader": null,
"phone": null,
"email": null,
"status": null,
"delFlag": null,
"parentName": null,
"children": null
}
]
}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"kycStatus": "string",
"admin": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UUser
](#schemauuser)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## PUT changeStatus
PUT /user/changeStatus
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"birthDate": "2019-08-24T14:15:22Z",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"remark": null,
"params": null,
"deptId": null,
"parentId": null,
"ancestors": null,
"deptName": null,
"orderNum": null,
"leader": null,
"phone": null,
"email": null,
"status": null,
"delFlag": null,
"parentName": null,
"children": null
}
]
}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"kycStatus": "string",
"admin": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UUser
](#schemauuser)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT insertAuthRole
PUT /user/authRole
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|userId|query|integer(int64)| 是 |none|
|roleIds|query|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST register
POST /user/register
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"birthDate": "2019-08-24T14:15:22Z",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"remark": null,
"params": null,
"deptId": null,
"parentId": null,
"ancestors": null,
"deptName": null,
"orderNum": null,
"leader": null,
"phone": null,
"email": null,
"status": null,
"delFlag": null,
"parentName": null,
"children": null
}
]
}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"kycStatus": "string",
"admin": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UUser
](#schemauuser)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## POST importTemplate
POST /user/importTemplate
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### 返回数据结构
## POST importData
POST /user/importData
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|file|query|string(binary)| 是 |none|
|updateSupport|query|boolean| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST export
POST /user/export
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|userId|query|integer(int64)| 否 |none|
|deptId|query|integer(int64)| 否 |none|
|userName|query|string| 是 |none|
|birthDate|query|string(date-time)| 否 |none|
|nickName|query|string| 否 |none|
|email|query|string| 否 |none|
|phonenumber|query|string| 否 |none|
|sex|query|string| 否 |none|
|avatar|query|string| 否 |none|
|password|query|string| 否 |none|
|fullName|query|string| 否 |none|
|age|query|integer(int32)| 否 |none|
|address|query|string| 否 |none|
|status|query|string| 否 |none|
|delFlag|query|string| 否 |none|
|loginIp|query|string| 否 |none|
|loginDate|query|string(date-time)| 否 |none|
|dept|query|[UDept
](#schemaudept)| 否 |none|
|roles|query|array[object
]| 否 |none|
|roleIds|query|array[integer
]| 否 |none|
|postIds|query|array[integer
]| 否 |none|
|roleId|query|integer(int64)| 否 |none|
|kycStatus|query|string| 否 |none|
|admin|query|boolean| 否 |none|
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### 返回数据结构
## POST checkRepeat
POST /user/checkRepeat
> Body 请求参数
```json
{
"userName": "string",
"email": "string",
"phonenumber": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UserRepeatQuery
](#schemauserrepeatquery)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## GET test
GET /user/test
> 返回示例
> 200 Response
```
"string"
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|string|
## GET list_3
GET /user/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|userId|query|integer(int64)| 否 |none|
|deptId|query|integer(int64)| 否 |none|
|userName|query|string| 是 |none|
|birthDate|query|string(date-time)| 否 |none|
|nickName|query|string| 否 |none|
|email|query|string| 否 |none|
|phonenumber|query|string| 否 |none|
|sex|query|string| 否 |none|
|avatar|query|string| 否 |none|
|password|query|string| 否 |none|
|fullName|query|string| 否 |none|
|age|query|integer(int32)| 否 |none|
|address|query|string| 否 |none|
|status|query|string| 否 |none|
|delFlag|query|string| 否 |none|
|loginIp|query|string| 否 |none|
|loginDate|query|string(date-time)| 否 |none|
|dept|query|[UDept
](#schemaudept)| 否 |none|
|roles|query|array[object
]| 否 |none|
|roleIds|query|array[integer
]| 否 |none|
|postIds|query|array[integer
]| 否 |none|
|roleId|query|integer(int64)| 否 |none|
|kycStatus|query|string| 否 |none|
|admin|query|boolean| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET info
GET /user/info/{username
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|username|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {
"token": "string",
"userid": 0,
"username": "string",
"loginTime": 0,
"expireTime": 0,
"ipaddr": "string",
"permissions": [
"string"
],
"roles": [
"string"
],
"user": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"birthDate": "2019-08-24T14:15:22Z",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
null
],
"deptIds": [
null
],
"permissions": [
null
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"kycStatus": "string",
"admin": true
},
"wanFiRedirectParams": {
"clientMac": "string",
"clientIp": "string",
"t": 0,
"site": "string",
"redirectUrl": "string",
"apMac": "string",
"ssidName": "string",
"radioId": 0
}
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RLoginUserUUser](#schemarloginuseruuser)|
## GET getInfo
GET /user/getInfo
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET deptTree
GET /user/deptTree
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|deptId|query|integer(int64)| 否 |none|
|parentId|query|integer(int64)| 否 |none|
|ancestors|query|string| 否 |none|
|deptName|query|string| 是 |none|
|orderNum|query|integer(int32)| 是 |none|
|leader|query|string| 否 |none|
|phone|query|string| 否 |none|
|email|query|string| 否 |none|
|status|query|string| 否 |none|
|delFlag|query|string| 否 |none|
|parentName|query|string| 否 |none|
|children|query|array[object
]| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET authRole
GET /user/authRole/{userId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|userId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getInfo_1
GET /user/
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|userId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getInfo_2
GET /user/{userId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|userId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove
DELETE /user/{userIds
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|userIds|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST page
POST /user/page
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"birthDate": "2019-08-24T14:15:22Z",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"remark": null,
"params": null,
"deptId": null,
"parentId": null,
"ancestors": null,
"deptName": null,
"orderNum": null,
"leader": null,
"phone": null,
"email": null,
"status": null,
"delFlag": null,
"parentName": null,
"children": null
}
]
}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"kycStatus": "string",
"admin": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UUser
](#schemauuser)| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
# wfc-user/u-payment-controller
## PUT edit_1
PUT /user/uPayment
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"name": "string",
"type": 0,
"appId": "string",
"serverUrl": "string",
"domain": "string",
"privateKey": "string",
"publicKey": "string",
"appCertPath": "string",
"certPath": "string",
"rootCertPath": "string",
"enable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UPayment
](#schemaupayment)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_1
POST /user/uPayment
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"name": "string",
"type": 0,
"appId": "string",
"serverUrl": "string",
"domain": "string",
"privateKey": "string",
"publicKey": "string",
"appCertPath": "string",
"certPath": "string",
"rootCertPath": "string",
"enable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UPayment
](#schemaupayment)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getById
GET /user/uPayment/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET page_1
GET /user/uPayment/page
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|name|query|string| 否 |支付名称|
|type|query|integer(int32)| 否 |类型(0支付宝 1微信 2信用卡)|
|appId|query|string| 否 |应用编号|
|serverUrl|query|string| 否 |支付网关|
|domain|query|string| 否 |外网访问项目的域名|
|privateKey|query|string| 否 |应用私钥|
|publicKey|query|string| 否 |应用公钥|
|appCertPath|query|string| 否 |应用公钥证书|
|certPath|query|string| 否 |公钥证书|
|rootCertPath|query|string| 否 |根证书|
|enable|query|boolean| 否 |是否启用|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET list
GET /user/uPayment/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|name|query|string| 否 |支付名称|
|type|query|integer(int32)| 否 |类型(0支付宝 1微信 2信用卡)|
|appId|query|string| 否 |应用编号|
|serverUrl|query|string| 否 |支付网关|
|domain|query|string| 否 |外网访问项目的域名|
|privateKey|query|string| 否 |应用私钥|
|publicKey|query|string| 否 |应用公钥|
|appCertPath|query|string| 否 |应用公钥证书|
|certPath|query|string| 否 |公钥证书|
|rootCertPath|query|string| 否 |根证书|
|enable|query|boolean| 否 |是否启用|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove_1
DELETE /user/uPayment/{ids
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|ids|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-bill-rule-controller
## PUT edit_2
PUT /user/uBillRule
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"price": 0,
"traffic": 0,
"unit": 0,
"enable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UBillRule
](#schemaubillrule)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_2
POST /user/uBillRule
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"price": 0,
"traffic": 0,
"unit": 0,
"enable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UBillRule
](#schemaubillrule)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getById_1
GET /user/uBillRule/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET page_2
GET /user/uBillRule/page
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|price|query|number| 否 |价格|
|traffic|query|integer(int64)| 否 |流量|
|unit|query|integer(int32)| 否 |单位|
|enable|query|boolean| 否 |是否启用|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET list_1
GET /user/uBillRule/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|price|query|number| 否 |价格|
|traffic|query|integer(int64)| 否 |流量|
|unit|query|integer(int32)| 否 |单位|
|enable|query|boolean| 否 |是否启用|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove_2
DELETE /user/uBillRule/{ids
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|ids|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-account-package-controller
## PUT edit_3
PUT /user/uAccountPackage
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"accountId": 0,
"packageId": 0,
"traffic": 0,
"duration": 0,
"clientNum": 0,
"expiredTime": "2019-08-24T14:15:22Z",
"packageName": "string",
"periodNum": 0,
"periodType": 0,
"price": 0,
"remark": "string",
"rateLimitEnable": true,
"trafficEnable": true,
"durationEnable": true,
"clientNumEnable": true,
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UAccountPackage
](#schemauaccountpackage)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_3
POST /user/uAccountPackage
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"accountId": 0,
"packageId": 0,
"traffic": 0,
"duration": 0,
"clientNum": 0,
"expiredTime": "2019-08-24T14:15:22Z",
"packageName": "string",
"periodNum": 0,
"periodType": 0,
"price": 0,
"remark": "string",
"rateLimitEnable": true,
"trafficEnable": true,
"durationEnable": true,
"clientNumEnable": true,
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UAccountPackage
](#schemauaccountpackage)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getById_2
GET /user/uAccountPackage/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET page_3
GET /user/uAccountPackage/page
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|accountId|query|integer(int64)| 否 |账户ID|
|packageId|query|integer(int64)| 否 |套餐ID|
|traffic|query|integer(int64)| 否 |流量|
|duration|query|integer(int64)| 否 |时长|
|clientNum|query|integer(int32)| 否 |在线设备数|
|expiredTime|query|string(date-time)| 否 |失效时间|
|packageName|query|string| 否 |套餐名称|
|periodNum|query|integer(int32)| 否 |有效期数|
|periodType|query|integer(int32)| 否 |有效期类型|
|price|query|number| 否 |价格|
|remark|query|string| 否 |备注|
|rateLimitEnable|query|boolean| 否 |带宽是否限制|
|trafficEnable|query|boolean| 否 |流量是否限制|
|durationEnable|query|boolean| 否 |时长是否限制|
|clientNumEnable|query|boolean| 否 |在线设备数是否限制|
|rateLimitName|query|string| 否 |限速名称|
|downLimit|query|integer(int64)| 否 |下行限速|
|downLimitEnable|query|boolean| 否 |下行限速启用|
|upLimit|query|integer(int64)| 否 |上行限速|
|upLimitEnable|query|boolean| 否 |上行限速启用|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET list_2
GET /user/uAccountPackage/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|accountId|query|integer(int64)| 否 |账户ID|
|packageId|query|integer(int64)| 否 |套餐ID|
|traffic|query|integer(int64)| 否 |流量|
|duration|query|integer(int64)| 否 |时长|
|clientNum|query|integer(int32)| 否 |在线设备数|
|expiredTime|query|string(date-time)| 否 |失效时间|
|packageName|query|string| 否 |套餐名称|
|periodNum|query|integer(int32)| 否 |有效期数|
|periodType|query|integer(int32)| 否 |有效期类型|
|price|query|number| 否 |价格|
|remark|query|string| 否 |备注|
|rateLimitEnable|query|boolean| 否 |带宽是否限制|
|trafficEnable|query|boolean| 否 |流量是否限制|
|durationEnable|query|boolean| 否 |时长是否限制|
|clientNumEnable|query|boolean| 否 |在线设备数是否限制|
|rateLimitName|query|string| 否 |限速名称|
|downLimit|query|integer(int64)| 否 |下行限速|
|downLimitEnable|query|boolean| 否 |下行限速启用|
|upLimit|query|integer(int64)| 否 |上行限速|
|upLimitEnable|query|boolean| 否 |上行限速启用|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove_3
DELETE /user/uAccountPackage/{ids
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|ids|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-profile-controller
## GET profile
GET /user/profile
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT updateProfile
PUT /user/profile
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"birthDate": "2019-08-24T14:15:22Z",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"remark": null,
"params": null,
"deptId": null,
"parentId": null,
"ancestors": null,
"deptName": null,
"orderNum": null,
"leader": null,
"phone": null,
"email": null,
"status": null,
"delFlag": null,
"parentName": null,
"children": null
}
]
}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"kycStatus": "string",
"admin": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UUser
](#schemauuser)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT updatePwd
PUT /user/profile/updatePwd
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|oldPassword|query|string| 是 |none|
|newPassword|query|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT forgotPwd
PUT /user/profile/forgotPwd
> Body 请求参数
```json
{
"email": "string",
"password": "string",
"code": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UUserForgotPwdBo
](#schemauuserforgotpwdbo)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST avatar
POST /user/profile/avatar
> Body 请求参数
```json
{
"avatarfile": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|object| 否 |none|
|» avatarfile|body|string(binary)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-role-controller
## PUT edit_4
PUT /role
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[URole
](#schemaurole)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_4
POST /role
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[URole
](#schemaurole)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT dataScope
PUT /role/dataScope
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[URole
](#schemaurole)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT changeStatus_1
PUT /role/changeStatus
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[URole
](#schemaurole)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT selectAuthUserAll
PUT /role/authUser/selectAll
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|roleId|query|integer(int64)| 是 |none|
|userIds|query|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT cancelAuthUser
PUT /role/authUser/cancel
> Body 请求参数
```json
{
"userId": 0,
"roleId": 0
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UUserRole
](#schemauuserrole)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT cancelAuthUserAll
PUT /role/authUser/cancelAll
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|roleId|query|integer(int64)| 是 |none|
|userIds|query|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST export_1
POST /role/export
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|roleId|query|integer(int64)| 否 |none|
|roleName|query|string| 是 |none|
|roleKey|query|string| 是 |none|
|roleSort|query|integer(int32)| 是 |none|
|dataScope|query|string| 否 |none|
|menuCheckStrictly|query|boolean| 否 |none|
|deptCheckStrictly|query|boolean| 否 |none|
|status|query|string| 否 |none|
|delFlag|query|string| 否 |none|
|flag|query|boolean| 否 |none|
|menuIds|query|array[integer
]| 否 |none|
|deptIds|query|array[integer
]| 否 |none|
|permissions|query|array[string
]| 否 |none|
|admin|query|boolean| 否 |none|
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### 返回数据结构
## GET getInfo_3
GET /role/{roleId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|roleId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET optionselect
GET /role/optionselect
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET list_4
GET /role/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|roleId|query|integer(int64)| 否 |none|
|roleName|query|string| 是 |none|
|roleKey|query|string| 是 |none|
|roleSort|query|integer(int32)| 是 |none|
|dataScope|query|string| 否 |none|
|menuCheckStrictly|query|boolean| 否 |none|
|deptCheckStrictly|query|boolean| 否 |none|
|status|query|string| 否 |none|
|delFlag|query|string| 否 |none|
|flag|query|boolean| 否 |none|
|menuIds|query|array[integer
]| 否 |none|
|deptIds|query|array[integer
]| 否 |none|
|permissions|query|array[string
]| 否 |none|
|admin|query|boolean| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET deptTree_1
GET /role/deptTree/{roleId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|roleId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET unallocatedList
GET /role/authUser/unallocatedList
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|userId|query|integer(int64)| 否 |none|
|deptId|query|integer(int64)| 否 |none|
|userName|query|string| 是 |none|
|birthDate|query|string(date-time)| 否 |none|
|nickName|query|string| 否 |none|
|email|query|string| 否 |none|
|phonenumber|query|string| 否 |none|
|sex|query|string| 否 |none|
|avatar|query|string| 否 |none|
|password|query|string| 否 |none|
|fullName|query|string| 否 |none|
|age|query|integer(int32)| 否 |none|
|address|query|string| 否 |none|
|status|query|string| 否 |none|
|delFlag|query|string| 否 |none|
|loginIp|query|string| 否 |none|
|loginDate|query|string(date-time)| 否 |none|
|dept|query|[UDept
](#schemaudept)| 否 |none|
|roles|query|array[object
]| 否 |none|
|roleIds|query|array[integer
]| 否 |none|
|postIds|query|array[integer
]| 否 |none|
|roleId|query|integer(int64)| 否 |none|
|kycStatus|query|string| 否 |none|
|admin|query|boolean| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET allocatedList
GET /role/authUser/allocatedList
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|userId|query|integer(int64)| 否 |none|
|deptId|query|integer(int64)| 否 |none|
|userName|query|string| 是 |none|
|birthDate|query|string(date-time)| 否 |none|
|nickName|query|string| 否 |none|
|email|query|string| 否 |none|
|phonenumber|query|string| 否 |none|
|sex|query|string| 否 |none|
|avatar|query|string| 否 |none|
|password|query|string| 否 |none|
|fullName|query|string| 否 |none|
|age|query|integer(int32)| 否 |none|
|address|query|string| 否 |none|
|status|query|string| 否 |none|
|delFlag|query|string| 否 |none|
|loginIp|query|string| 否 |none|
|loginDate|query|string(date-time)| 否 |none|
|dept|query|[UDept
](#schemaudept)| 否 |none|
|roles|query|array[object
]| 否 |none|
|roleIds|query|array[integer
]| 否 |none|
|postIds|query|array[integer
]| 否 |none|
|roleId|query|integer(int64)| 否 |none|
|kycStatus|query|string| 否 |none|
|admin|query|boolean| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## DELETE remove_4
DELETE /role/{roleIds
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|roleIds|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-post-controller
## PUT edit_5
PUT /post
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"postId": 0,
"postCode": "string",
"postName": "string",
"postSort": 0,
"status": "string",
"flag": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UPost
](#schemaupost)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_5
POST /post
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"postId": 0,
"postCode": "string",
"postName": "string",
"postSort": 0,
"status": "string",
"flag": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UPost
](#schemaupost)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST export_2
POST /post/export
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|postId|query|integer(int64)| 否 |none|
|postCode|query|string| 是 |none|
|postName|query|string| 是 |none|
|postSort|query|integer(int32)| 是 |none|
|status|query|string| 否 |none|
|flag|query|boolean| 否 |none|
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### 返回数据结构
## GET getInfo_4
GET /post/{postId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|postId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET optionselect_1
GET /post/optionselect
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET list_6
GET /post/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|postId|query|integer(int64)| 否 |none|
|postCode|query|string| 是 |none|
|postName|query|string| 是 |none|
|postSort|query|integer(int32)| 是 |none|
|status|query|string| 否 |none|
|flag|query|boolean| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## DELETE remove_5
DELETE /post/{postIds
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|postIds|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-order-controller
## GET getById_3
GET /order/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET page_6
GET /order/page
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|userId|query|integer(int64)| 否 |用户ID|
|packageId|query|integer(int64)| 否 |套餐ID|
|paymentId|query|integer(int64)| 否 |支付ID|
|orderNo|query|string| 否 |订单编号|
|type|query|integer(int32)| 否 |订单类型(0套餐 1充值)|
|orderAmount|query|number| 否 |订单金额|
|status|query|integer(int32)| 否 |订单状态(0待支付 1已支付 2已取消)|
|currency|query|string| 否 |none|
|upackage|query|[UPackage
](#schemaupackage)| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET list_8
GET /order/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|userId|query|integer(int64)| 否 |用户ID|
|packageId|query|integer(int64)| 否 |套餐ID|
|paymentId|query|integer(int64)| 否 |支付ID|
|orderNo|query|string| 否 |订单编号|
|type|query|integer(int32)| 否 |订单类型(0套餐 1充值)|
|orderAmount|query|number| 否 |订单金额|
|status|query|integer(int32)| 否 |订单状态(0待支付 1已支付 2已取消)|
|currency|query|string| 否 |none|
|upackage|query|[UPackage
](#schemaupackage)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT edit_6
PUT /order
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"userId": 0,
"packageId": 0,
"paymentId": 0,
"orderNo": "string",
"type": 0,
"orderAmount": 0,
"status": 0,
"currency": "string",
"upackage": {
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitId": 0,
"packageName": "string",
"periodNum": 0,
"periodType": 0,
"price": 0,
"traffic": 0,
"duration": 0,
"clientNum": 0,
"remark": "string",
"rateLimitEnable": true,
"trafficEnable": true,
"durationEnable": true,
"clientNumEnable": true,
"packageEnable": true,
"rateLimits": {
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true
}
}
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UOrder
](#schemauorder)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_6
POST /order
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"userId": 0,
"packageId": 0,
"paymentId": 0,
"orderNo": "string",
"type": 0,
"orderAmount": 0,
"status": 0,
"currency": "string",
"upackage": {
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitId": 0,
"packageName": "string",
"periodNum": 0,
"periodType": 0,
"price": 0,
"traffic": 0,
"duration": 0,
"clientNum": 0,
"remark": "string",
"rateLimitEnable": true,
"trafficEnable": true,
"durationEnable": true,
"clientNumEnable": true,
"packageEnable": true,
"rateLimits": {
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true
}
}
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UOrder
](#schemauorder)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": 0
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RLong](#schemarlong)|
## POST paySuccess
POST /order/paySuccess/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST payBalance
POST /order/payBalance/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET rechargePage
GET /order/rechargePage
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET packagePage
GET /order/packagePage
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## DELETE remove_6
DELETE /order/{ids
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|ids|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-menu-controller
## PUT edit_7
PUT /menu
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"menuId": 0,
"menuName": "string",
"parentName": "string",
"parentId": 0,
"orderNum": 0,
"path": "string",
"component": "string",
"query": "string",
"routeName": "string",
"isFrame": "string",
"isCache": "string",
"menuType": "string",
"visible": "string",
"status": "string",
"perms": "string",
"icon": "string",
"name": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"menuId": 0,
"menuName": "string",
"parentName": "string",
"parentId": 0,
"orderNum": 0,
"path": "string",
"component": "string",
"query": "string",
"routeName": "string",
"isFrame": "string",
"isCache": "string",
"menuType": "string",
"visible": "string",
"status": "string",
"perms": "string",
"icon": "string",
"name": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"menuId": 0,
"menuName": "string",
"parentName": "string",
"parentId": 0,
"orderNum": 0,
"path": "string",
"component": "string",
"query": "string",
"routeName": "string",
"isFrame": "string",
"isCache": "string",
"menuType": "string",
"visible": "string",
"status": "string",
"perms": "string",
"icon": "string",
"name": "string",
"children": [
{}
]
}
]
}
]
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UMenu
](#schemaumenu)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_8
POST /menu
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"menuId": 0,
"menuName": "string",
"parentName": "string",
"parentId": 0,
"orderNum": 0,
"path": "string",
"component": "string",
"query": "string",
"routeName": "string",
"isFrame": "string",
"isCache": "string",
"menuType": "string",
"visible": "string",
"status": "string",
"perms": "string",
"icon": "string",
"name": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"menuId": 0,
"menuName": "string",
"parentName": "string",
"parentId": 0,
"orderNum": 0,
"path": "string",
"component": "string",
"query": "string",
"routeName": "string",
"isFrame": "string",
"isCache": "string",
"menuType": "string",
"visible": "string",
"status": "string",
"perms": "string",
"icon": "string",
"name": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"menuId": 0,
"menuName": "string",
"parentName": "string",
"parentId": 0,
"orderNum": 0,
"path": "string",
"component": "string",
"query": "string",
"routeName": "string",
"isFrame": "string",
"isCache": "string",
"menuType": "string",
"visible": "string",
"status": "string",
"perms": "string",
"icon": "string",
"name": "string",
"children": [
{}
]
}
]
}
]
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UMenu
](#schemaumenu)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getInfo_5
GET /menu/{menuId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|menuId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove_8
DELETE /menu/{menuId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|menuId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET treeselect
GET /menu/treeselect
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|menuId|query|integer(int64)| 否 |none|
|menuName|query|string| 是 |none|
|parentName|query|string| 否 |none|
|parentId|query|integer(int64)| 否 |none|
|orderNum|query|integer(int32)| 是 |none|
|path|query|string| 否 |none|
|component|query|string| 否 |none|
|query|query|string| 否 |none|
|routeName|query|string| 否 |none|
|isFrame|query|string| 否 |none|
|isCache|query|string| 否 |none|
|menuType|query|string| 是 |none|
|visible|query|string| 否 |none|
|status|query|string| 否 |none|
|perms|query|string| 否 |none|
|icon|query|string| 否 |none|
|name|query|string| 否 |none|
|children|query|array[object
]| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET roleMenuTreeselect
GET /menu/roleMenuTreeselect/{roleId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|roleId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET list_11
GET /menu/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|menuId|query|integer(int64)| 否 |none|
|menuName|query|string| 是 |none|
|parentName|query|string| 否 |none|
|parentId|query|integer(int64)| 否 |none|
|orderNum|query|integer(int32)| 是 |none|
|path|query|string| 否 |none|
|component|query|string| 否 |none|
|query|query|string| 否 |none|
|routeName|query|string| 否 |none|
|isFrame|query|string| 否 |none|
|isCache|query|string| 否 |none|
|menuType|query|string| 是 |none|
|visible|query|string| 否 |none|
|status|query|string| 否 |none|
|perms|query|string| 否 |none|
|icon|query|string| 否 |none|
|name|query|string| 否 |none|
|children|query|array[object
]| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET getRouters
GET /menu/getRouters
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-kyc-controller
## GET page_7
GET /kyc/page
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET list_13
GET /kyc/list
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## PUT edit_8
PUT /kyc/verify
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"kycId": 0,
"userId": 0,
"realName": "string",
"birthDate": "string",
"idType": 0,
"idFile": "string",
"identifyPicture": "string",
"status": 0,
"description": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UKyc
](#schemaukyc)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_10
POST /kyc/verify
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"kycId": 0,
"userId": 0,
"realName": "string",
"birthDate": "string",
"idType": 0,
"idFile": "string",
"identifyPicture": "string",
"status": 0,
"description": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UKyc
](#schemaukyc)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-dict-type-controller
## PUT edit_9
PUT /dict/type
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"dictId": 0,
"dictName": "string",
"dictType": "string",
"status": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UDictType
](#schemaudicttype)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_11
POST /dict/type
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"dictId": 0,
"dictName": "string",
"dictType": "string",
"status": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UDictType
](#schemaudicttype)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST export_5
POST /dict/type/export
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|dictId|query|integer(int64)| 否 |none|
|dictName|query|string| 是 |none|
|dictType|query|string| 是 |none|
|status|query|string| 否 |none|
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### 返回数据结构
## GET getInfo_6
GET /dict/type/{dictId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|dictId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET optionselect_2
GET /dict/type/optionselect
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET list_14
GET /dict/type/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|dictId|query|integer(int64)| 否 |none|
|dictName|query|string| 是 |none|
|dictType|query|string| 是 |none|
|status|query|string| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## DELETE remove_10
DELETE /dict/type/{dictIds
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|dictIds|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE refreshCache
DELETE /dict/type/refreshCache
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-dict-data-controller
## PUT edit_10
PUT /dict/data
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"dictCode": 0,
"dictSort": 0,
"dictLabel": "string",
"dictValue": "string",
"dictType": "string",
"cssClass": "string",
"listClass": "string",
"isDefault": "string",
"status": "string",
"default": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UDictData
](#schemaudictdata)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_12
POST /dict/data
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"dictCode": 0,
"dictSort": 0,
"dictLabel": "string",
"dictValue": "string",
"dictType": "string",
"cssClass": "string",
"listClass": "string",
"isDefault": "string",
"status": "string",
"default": true
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UDictData
](#schemaudictdata)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST export_6
POST /dict/data/export
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|dictCode|query|integer(int64)| 否 |none|
|dictSort|query|integer(int64)| 否 |none|
|dictLabel|query|string| 是 |none|
|dictValue|query|string| 是 |none|
|dictType|query|string| 是 |none|
|cssClass|query|string| 否 |none|
|listClass|query|string| 否 |none|
|isDefault|query|string| 否 |none|
|status|query|string| 否 |none|
|default|query|boolean| 否 |none|
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### 返回数据结构
## GET getInfo_7
GET /dict/data/{dictCode
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|dictCode|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET dictType
GET /dict/data/type/{dictType
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|dictType|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET list_15
GET /dict/data/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|dictCode|query|integer(int64)| 否 |none|
|dictSort|query|integer(int64)| 否 |none|
|dictLabel|query|string| 是 |none|
|dictValue|query|string| 是 |none|
|dictType|query|string| 是 |none|
|cssClass|query|string| 否 |none|
|listClass|query|string| 否 |none|
|isDefault|query|string| 否 |none|
|status|query|string| 否 |none|
|default|query|boolean| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## DELETE remove_11
DELETE /dict/data/{dictCodes
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|dictCodes|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-dept-controller
## PUT edit_11
PUT /dept
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{}
]
}
]
}
]
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UDept
](#schemaudept)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_13
POST /dept
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{}
]
}
]
}
]
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UDept
](#schemaudept)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getInfo_8
GET /dept/{deptId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|deptId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove_12
DELETE /dept/{deptId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|deptId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET list_16
GET /dept/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|deptId|query|integer(int64)| 否 |none|
|parentId|query|integer(int64)| 否 |none|
|ancestors|query|string| 否 |none|
|deptName|query|string| 是 |none|
|orderNum|query|integer(int32)| 是 |none|
|leader|query|string| 否 |none|
|phone|query|string| 否 |none|
|email|query|string| 否 |none|
|status|query|string| 否 |none|
|delFlag|query|string| 否 |none|
|parentName|query|string| 否 |none|
|children|query|array[object
]| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET excludeChild
GET /dept/list/exclude/{deptId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|deptId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-config-controller
## PUT edit_12
PUT /config
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"configId": 0,
"configName": "string",
"configKey": "string",
"configValue": "string",
"configType": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UConfig
](#schemauconfig)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_14
POST /config
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"configId": 0,
"configName": "string",
"configKey": "string",
"configValue": "string",
"configType": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UConfig
](#schemauconfig)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET getPayConfig
GET /config/pay
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {
"currency": "string",
"currencySymbol": "string",
"paymentMethods": [
"string"
]
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RUPayConfigBo](#schemarupayconfigbo)|
## POST export_7
POST /config/export
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|configId|query|integer(int64)| 否 |none|
|configName|query|string| 是 |none|
|configKey|query|string| 是 |none|
|configValue|query|string| 是 |none|
|configType|query|string| 否 |none|
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### 返回数据结构
## GET getInfo_9
GET /config/{configId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|configId|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET list_17
GET /config/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|configId|query|integer(int64)| 否 |none|
|configName|query|string| 是 |none|
|configKey|query|string| 是 |none|
|configValue|query|string| 是 |none|
|configType|query|string| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET getConfigKey
GET /config/configKey/{configKey
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|configKey|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove_13
DELETE /config/{configIds
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|configIds|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE refreshCache_1
DELETE /config/refreshCache
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-account-controller
## PUT edit_13
PUT /account
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"userId": 0,
"balance": 0,
"packageId": 0,
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"trafficUsed": 0,
"durationUsed": 0,
"expiredTime": "2019-08-24T14:15:22Z",
"clientNumUsed": 0,
"balanceUsed": 0,
"packageName": "string",
"periodNum": 0,
"periodType": 0,
"price": 0,
"traffic": 0,
"duration": 0,
"clientNum": 0,
"remark": "string",
"rateLimitEnable": true,
"trafficEnable": true,
"durationEnable": true,
"clientNumEnable": true,
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true,
"packageReminder": 0,
"balanceReminder": 0
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UAccount
](#schemauaccount)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST add_15
POST /account
> Body 请求参数
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"userId": 0,
"balance": 0,
"packageId": 0,
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"trafficUsed": 0,
"durationUsed": 0,
"expiredTime": "2019-08-24T14:15:22Z",
"clientNumUsed": 0,
"balanceUsed": 0,
"packageName": "string",
"periodNum": 0,
"periodType": 0,
"price": 0,
"traffic": 0,
"duration": 0,
"clientNum": 0,
"remark": "string",
"rateLimitEnable": true,
"trafficEnable": true,
"durationEnable": true,
"clientNumEnable": true,
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true,
"packageReminder": 0,
"balanceReminder": 0
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UAccount
](#schemauaccount)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST sendReminderEMail
POST /account/reminder
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## GET getById_4
GET /account/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET page_9
GET /account/page
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|userId|query|integer(int64)| 否 |用户ID|
|balance|query|number| 否 |余额|
|packageId|query|integer(int64)| 否 |套餐ID|
|startTime|query|string(date-time)| 否 |开始时间|
|endTime|query|string(date-time)| 否 |结束时间|
|trafficUsed|query|integer(int64)| 否 |流量已使用|
|durationUsed|query|integer(int64)| 否 |时长已使用|
|expiredTime|query|string(date-time)| 否 |失效时间|
|clientNumUsed|query|integer(int32)| 否 |在线设备数已使用|
|balanceUsed|query|number| 否 |余额已使用|
|packageName|query|string| 否 |套餐名称|
|periodNum|query|integer(int32)| 否 |有效期数|
|periodType|query|integer(int32)| 否 |有效期类型|
|price|query|number| 否 |价格|
|traffic|query|integer(int64)| 否 |流量|
|duration|query|integer(int64)| 否 |时长|
|clientNum|query|integer(int32)| 否 |在线设备数|
|remark|query|string| 否 |备注|
|rateLimitEnable|query|boolean| 否 |带宽是否限制|
|trafficEnable|query|boolean| 否 |流量是否限制|
|durationEnable|query|boolean| 否 |时长是否限制|
|clientNumEnable|query|boolean| 否 |在线设备数是否限制|
|rateLimitName|query|string| 否 |限速名称|
|downLimit|query|integer(int64)| 否 |下行限速|
|downLimitEnable|query|boolean| 否 |下行限速启用|
|upLimit|query|integer(int64)| 否 |上行限速|
|upLimitEnable|query|boolean| 否 |上行限速启用|
|packageReminder|query|integer(int32)| 否 |套餐提醒|
|balanceReminder|query|integer(int32)| 否 |余额提醒|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET list_18
GET /account/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|userId|query|integer(int64)| 否 |用户ID|
|balance|query|number| 否 |余额|
|packageId|query|integer(int64)| 否 |套餐ID|
|startTime|query|string(date-time)| 否 |开始时间|
|endTime|query|string(date-time)| 否 |结束时间|
|trafficUsed|query|integer(int64)| 否 |流量已使用|
|durationUsed|query|integer(int64)| 否 |时长已使用|
|expiredTime|query|string(date-time)| 否 |失效时间|
|clientNumUsed|query|integer(int32)| 否 |在线设备数已使用|
|balanceUsed|query|number| 否 |余额已使用|
|packageName|query|string| 否 |套餐名称|
|periodNum|query|integer(int32)| 否 |有效期数|
|periodType|query|integer(int32)| 否 |有效期类型|
|price|query|number| 否 |价格|
|traffic|query|integer(int64)| 否 |流量|
|duration|query|integer(int64)| 否 |时长|
|clientNum|query|integer(int32)| 否 |在线设备数|
|remark|query|string| 否 |备注|
|rateLimitEnable|query|boolean| 否 |带宽是否限制|
|trafficEnable|query|boolean| 否 |流量是否限制|
|durationEnable|query|boolean| 否 |时长是否限制|
|clientNumEnable|query|boolean| 否 |在线设备数是否限制|
|rateLimitName|query|string| 否 |限速名称|
|downLimit|query|integer(int64)| 否 |下行限速|
|downLimitEnable|query|boolean| 否 |下行限速启用|
|upLimit|query|integer(int64)| 否 |上行限速|
|upLimitEnable|query|boolean| 否 |上行限速启用|
|packageReminder|query|integer(int32)| 否 |套餐提醒|
|balanceReminder|query|integer(int32)| 否 |余额提醒|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET dashboard
GET /account/dashboard
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE remove_14
DELETE /account/{ids
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|ids|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-operlog-controller
## POST add_7
POST /operlog
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"operId": 0,
"title": "string",
"businessType": 0,
"businessTypes": [
0
],
"method": "string",
"requestMethod": "string",
"operatorType": 0,
"operName": "string",
"deptName": "string",
"operUrl": "string",
"operIp": "string",
"operParam": "string",
"jsonResult": "string",
"status": 0,
"errorMsg": "string",
"operTime": "2019-08-24T14:15:22Z",
"costTime": 0
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UOperLog
](#schemauoperlog)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST export_3
POST /operlog/export
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|operId|query|integer(int64)| 否 |none|
|title|query|string| 否 |none|
|businessType|query|integer(int32)| 否 |none|
|businessTypes|query|array[integer
]| 否 |none|
|method|query|string| 否 |none|
|requestMethod|query|string| 否 |none|
|operatorType|query|integer(int32)| 否 |none|
|operName|query|string| 否 |none|
|deptName|query|string| 否 |none|
|operUrl|query|string| 否 |none|
|operIp|query|string| 否 |none|
|operParam|query|string| 否 |none|
|jsonResult|query|string| 否 |none|
|status|query|integer(int32)| 否 |none|
|errorMsg|query|string| 否 |none|
|operTime|query|string(date-time)| 否 |none|
|costTime|query|integer(int64)| 否 |none|
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### 返回数据结构
## GET list_9
GET /operlog/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|operId|query|integer(int64)| 否 |none|
|title|query|string| 否 |none|
|businessType|query|integer(int32)| 否 |none|
|businessTypes|query|array[integer
]| 否 |none|
|method|query|string| 否 |none|
|requestMethod|query|string| 否 |none|
|operatorType|query|integer(int32)| 否 |none|
|operName|query|string| 否 |none|
|deptName|query|string| 否 |none|
|operUrl|query|string| 否 |none|
|operIp|query|string| 否 |none|
|operParam|query|string| 否 |none|
|jsonResult|query|string| 否 |none|
|status|query|integer(int32)| 否 |none|
|errorMsg|query|string| 否 |none|
|operTime|query|string(date-time)| 否 |none|
|costTime|query|integer(int64)| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## DELETE remove_7
DELETE /operlog/{operIds
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|operIds|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE clean
DELETE /operlog/clean
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-logininfor-controller
## POST add_9
POST /logininfor
> Body 请求参数
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"infoId": 0,
"userName": "string",
"status": "string",
"ipaddr": "string",
"msg": "string",
"accessTime": "2019-08-24T14:15:22Z"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[ULogininfor
](#schemaulogininfor)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## POST export_4
POST /logininfor/export
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|infoId|query|integer(int64)| 否 |none|
|userName|query|string| 否 |none|
|status|query|string| 否 |none|
|ipaddr|query|string| 否 |none|
|msg|query|string| 否 |none|
|accessTime|query|string(date-time)| 否 |none|
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### 返回数据结构
## GET unlock
GET /logininfor/unlock/{userName
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|userName|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET list_12
GET /logininfor/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|createBy|query|string| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|string| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|remark|query|string| 否 |none|
|params|query|object| 否 |none|
|infoId|query|integer(int64)| 否 |none|
|userName|query|string| 否 |none|
|status|query|string| 否 |none|
|ipaddr|query|string| 否 |none|
|msg|query|string| 否 |none|
|accessTime|query|string(date-time)| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## DELETE remove_9
DELETE /logininfor/{infoIds
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|infoIds|path|array[integer
]| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## DELETE clean_1
DELETE /logininfor/clean
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-client-controller
## POST recordClientUser
POST /client/recordClientUser
> Body 请求参数
```json
{
"userId": 0,
"clientName": "string",
"siteId": "string",
"clientDeviceType": "string",
"clientMac": "string"
}
```
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|body|body|[UClientBo
](#schemauclientbo)| 否 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
## GET getHistoryByUser
GET /client/pageHistoryClient
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET getCurrentClients
GET /client/pageCurrentClient
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
# wfc-user/u-rate-limit-controller
## GET page_4
GET /rateLimit/page
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|rateLimitName|query|string| 否 |限速名称|
|downLimit|query|integer(int64)| 否 |下行限速|
|downLimitEnable|query|boolean| 否 |下行限速启用|
|upLimit|query|integer(int64)| 否 |上行限速|
|upLimitEnable|query|boolean| 否 |上行限速启用|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET list_5
GET /rateLimit/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|rateLimitName|query|string| 否 |限速名称|
|downLimit|query|integer(int64)| 否 |下行限速|
|downLimitEnable|query|boolean| 否 |下行限速启用|
|upLimit|query|integer(int64)| 否 |上行限速|
|upLimitEnable|query|boolean| 否 |上行限速启用|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-package-controller
## GET page_5
GET /package/page
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|rateLimitId|query|integer(int64)| 否 |带宽限速ID|
|packageName|query|string| 否 |套餐名称|
|periodNum|query|integer(int32)| 否 |有效期数|
|periodType|query|integer(int32)| 否 |有效期类型|
|price|query|number| 否 |价格|
|traffic|query|integer(int64)| 否 |流量|
|duration|query|integer(int64)| 否 |时长|
|clientNum|query|integer(int32)| 否 |在线设备数|
|remark|query|string| 否 |备注|
|rateLimitEnable|query|boolean| 否 |带宽是否限制|
|trafficEnable|query|boolean| 否 |流量是否限制|
|durationEnable|query|boolean| 否 |时长是否限制|
|clientNumEnable|query|boolean| 否 |在线设备数是否限制|
|packageEnable|query|boolean| 否 |套餐是否启用|
|rateLimits|query|[URateLimit
](#schemauratelimit)| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET list_7
GET /package/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|query|integer(int64)| 否 |none|
|delFlag|query|boolean| 否 |none|
|createBy|query|integer(int64)| 否 |none|
|createTime|query|string(date-time)| 否 |none|
|updateBy|query|integer(int64)| 否 |none|
|updateTime|query|string(date-time)| 否 |none|
|rateLimitId|query|integer(int64)| 否 |带宽限速ID|
|packageName|query|string| 否 |套餐名称|
|periodNum|query|integer(int32)| 否 |有效期数|
|periodType|query|integer(int32)| 否 |有效期类型|
|price|query|number| 否 |价格|
|traffic|query|integer(int64)| 否 |流量|
|duration|query|integer(int64)| 否 |时长|
|clientNum|query|integer(int32)| 否 |在线设备数|
|remark|query|string| 否 |备注|
|rateLimitEnable|query|boolean| 否 |带宽是否限制|
|trafficEnable|query|boolean| 否 |流量是否限制|
|durationEnable|query|boolean| 否 |时长是否限制|
|clientNumEnable|query|boolean| 否 |在线设备数是否限制|
|packageEnable|query|boolean| 否 |套餐是否启用|
|rateLimits|query|[URateLimit
](#schemauratelimit)| 否 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-user-online-controller
## GET list_10
GET /online/list
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|ipaddr|query|string| 是 |none|
|userName|query|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## DELETE forceLogout
DELETE /online/{tokenId
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|tokenId|path|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-email-controller
## GET emailCode
GET /email/code
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|email|query|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RVoid](#schemarvoid)|
# wfc-user/client-controller
## GET unauth
GET /client/unauth
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET info_1
GET /client/info
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
## GET auth
GET /client/auth
> 返回示例
> 200 Response
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[AjaxResult](#schemaajaxresult)|
# wfc-user/u-cdr-controller
## GET getHistoryByUser
GET /cdr/pageHistory
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|userId|query|integer(int64)| 否 |none|
|userName|query|string| 否 |none|
|clientName|query|string| 否 |none|
|clientMac|query|string| 否 |none|
|startTimeS|query|integer(int64)| 否 |none|
|startTimeE|query|integer(int64)| 否 |none|
|endTimeS|query|integer(int64)| 否 |none|
|endTimeE|query|integer(int64)| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET getByClient
GET /cdr/pageClient
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|clientName|query|string| 否 |none|
|clientMac|query|string| 否 |none|
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET getByUser
GET /cdr/getOne
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {
"id": 0,
"startTime": 0,
"endTime": 0,
"duration": 0,
"trafficDown": 0,
"trafficUp": 0,
"activity": 0
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RUCdrUserVo](#schemarucdruservo)|
## GET addCdrInfoByOmadaApi
GET /cdr/addCdrInfo
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RBoolean](#schemarboolean)|
# wfc-user/u-bill-controller
## GET page_8
GET /bill/page
> 返回示例
> 200 Response
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string"
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[TableDataInfo](#schematabledatainfo)|
## GET download
GET /bill/download/{id
}
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|id|path|integer(int64)| 是 |none|
> 返回示例
> 200 Response
```json
{}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|Inline|
### 返回数据结构
# wfc-file/sys-file-controller
## POST upload
POST /upload
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|file|query|string(binary)| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": {
"name": "string",
"url": "string",
"localUrl": "string",
"filePath": "string",
"gatewayUrl": "string"
}
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RSysFile](#schemarsysfile)|
## GET download
GET /download
### 请求参数
|名称|位置|类型|必选|说明|
|---|---|---|---|---|
|filePath|query|string| 是 |none|
> 返回示例
> 200 Response
```json
{
"code": 0,
"msg": "string",
"data": [
"string"
]
}
```
### 返回结果
|状态码|状态码含义|说明|数据模型|
|---|---|---|---|
|200|[OK
](https: //tools.ietf.org/html/rfc7231#section-6.3.1)|OK|[RByte[]](#schemarbyte[])|
# 数据模型
RegisterBody
```json
{
"username": "string",
"password": "string",
"authType": "string",
"wanfiRedirectParams": {
"clientMac": "string",
"clientIp": "string",
"t": 0,
"site": "string",
"redirectUrl": "string",
"apMac": "string",
"ssidName": "string",
"radioId": 0
},
"email": "string",
"fullName": "string",
"age": 0,
"address": "string",
"birthDate": "2019-08-24T14:15:22Z",
"sex": "string",
"phonenumber": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|username|string|false|none||none|
|password|string|false|none||none|
|authType|string|false|none||none|
|wanfiRedirectParams|[WANFiRedirectParams
](#schemawanfiredirectparams)|false|none||none|
|email|string|false|none||none|
|fullName|string|false|none||none|
|age|integer(int32)|false|none||none|
|address|string|false|none||none|
|birthDate|string(date-time)|false|none||none|
|sex|string|false|none||none|
|phonenumber|string|false|none||none|
UpdateSsidBasicConfigOpenApiVo
```json
{
"name": "string",
"band": 0,
"guestNetEnable": true,
"security": 0,
"broadcast": true,
"vlanEnable": true,
"vlanId": 0,
"pskSetting": {},
"entSetting": {},
"ppskSetting": {},
"mloEnable": true,
"pmfMode": 0,
"enable11r": true,
"hidePwd": true,
"greEnable": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|true|none||none|
|band|integer(int32)|true|none||none|
|guestNetEnable|boolean|true|none||none|
|security|integer(int32)|true|none||none|
|broadcast|boolean|true|none||none|
|vlanEnable|boolean|true|none||none|
|vlanId|integer(int32)|false|none||none|
|pskSetting|object|false|none||none|
|entSetting|object|false|none||none|
|ppskSetting|object|false|none||none|
|mloEnable|boolean|true|none||none|
|pmfMode|integer(int32)|true|none||none|
|enable11r|boolean|true|none||none|
|hidePwd|boolean|true|none||none|
|greEnable|boolean|true|none||none|
RSysFile
```json
{
"code": 0,
"msg": "string",
"data": {
"name": "string",
"url": "string",
"localUrl": "string",
"filePath": "string",
"gatewayUrl": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[SysFile
](#schemasysfile)|false|none||none|
SysJob
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"jobId": 0,
"jobName": "string",
"jobGroup": "string",
"invokeTarget": "string",
"cronExpression": "string",
"misfirePolicy": "string",
"concurrent": "string",
"status": "string",
"nextValidTime": "2019-08-24T14:15:22Z"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|jobId|integer(int64)|false|none||none|
|jobName|string|true|none||none|
|jobGroup|string|false|none||none|
|invokeTarget|string|true|none||none|
|cronExpression|string|true|none||none|
|misfirePolicy|string|false|none||none|
|concurrent|string|false|none||none|
|status|string|false|none||none|
|nextValidTime|string(date-time)|false|none||none|
WANFiRedirectParams
```json
{
"clientMac": "string",
"clientIp": "string",
"t": 0,
"site": "string",
"redirectUrl": "string",
"apMac": "string",
"ssidName": "string",
"radioId": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|clientMac|string|false|none||none|
|clientIp|string|false|none||none|
|t|integer(int64)|false|none||none|
|site|string|false|none||none|
|redirectUrl|string|false|none||none|
|apMac|string|false|none||none|
|ssidName|string|false|none||none|
|radioId|integer(int32)|false|none||none|
RBoolean
```json
{
"code": 0,
"msg": "string",
"data": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|boolean|false|none||none|
SysFile
```json
{
"name": "string",
"url": "string",
"localUrl": "string",
"filePath": "string",
"gatewayUrl": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|url|string|false|none||none|
|localUrl|string|false|none||none|
|filePath|string|false|none||none|
|gatewayUrl|string|false|none||none|
RObject
```json
{
"code": 0,
"msg": "string",
"data": {}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|object|false|none||none|
SysDept
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{}
]
}
]
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|deptId|integer(int64)|false|none||none|
|parentId|integer(int64)|false|none||none|
|ancestors|string|false|none||none|
|deptName|string|true|none||none|
|orderNum|integer(int32)|true|none||none|
|leader|string|false|none||none|
|phone|string|false|none||none|
|email|string|false|none||none|
|status|string|false|none||none|
|delFlag|string|false|none||none|
|parentName|string|false|none||none|
|children|[
[SysDept
](#schemasysdept)
]|false|none||none|
RByte[]
```json
{
"code": 0,
"msg": "string",
"data": [
"string"
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[string
]|false|none||none|
Address
```json
{
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|address_line_1|string|false|none||none|
|address_line_2|string|false|none||none|
|admin_area_2|string|false|none||none|
|admin_area_1|string|false|none||none|
|postal_code|string|false|none||none|
|country_code|string|false|none||none|
SysJobLog
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"jobLogId": 0,
"jobName": "string",
"jobGroup": "string",
"invokeTarget": "string",
"jobMessage": "string",
"status": "string",
"exceptionInfo": "string",
"startTime": "2019-08-24T14:15:22Z",
"stopTime": "2019-08-24T14:15:22Z"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|jobLogId|integer(int64)|false|none||none|
|jobName|string|false|none||none|
|jobGroup|string|false|none||none|
|invokeTarget|string|false|none||none|
|jobMessage|string|false|none||none|
|status|string|false|none||none|
|exceptionInfo|string|false|none||none|
|startTime|string(date-time)|false|none||none|
|stopTime|string(date-time)|false|none||none|
LoginBody
```json
{
"username": "string",
"password": "string",
"authType": "string",
"wanfiRedirectParams": {
"clientMac": "string",
"clientIp": "string",
"t": 0,
"site": "string",
"redirectUrl": "string",
"apMac": "string",
"ssidName": "string",
"radioId": 0
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|username|string|false|none||none|
|password|string|false|none||none|
|authType|string|false|none||none|
|wanfiRedirectParams|[WANFiRedirectParams
](#schemawanfiredirectparams)|false|none||none|
SysRole
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|roleId|integer(int64)|false|none||none|
|roleName|string|true|none||none|
|roleKey|string|true|none||none|
|roleSort|integer(int32)|false|none||none|
|dataScope|string|false|none||none|
|menuCheckStrictly|boolean|false|none||none|
|deptCheckStrictly|boolean|false|none||none|
|status|string|false|none||none|
|delFlag|string|false|none||none|
|flag|boolean|false|none||none|
|menuIds|[integer
]|false|none||none|
|deptIds|[integer
]|false|none||none|
|permissions|[string
]|false|none||none|
|admin|boolean|false|none||none|
AmountBreakdown
```json
{
"item_total": {
"currency_code": "string",
"value": "string"
},
"shipping": {
"currency_code": "string",
"value": "string"
},
"handling": {
"currency_code": "string",
"value": "string"
},
"tax_total": {
"currency_code": "string",
"value": "string"
},
"insurance": {
"currency_code": "string",
"value": "string"
},
"shipping_discount": {
"currency_code": "string",
"value": "string"
},
"discount": {
"currency_code": "string",
"value": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|item_total|[Money
](#schemamoney)|false|none||none|
|shipping|[Money
](#schemamoney)|false|none||none|
|handling|[Money
](#schemamoney)|false|none||none|
|tax_total|[Money
](#schemamoney)|false|none||none|
|insurance|[Money
](#schemamoney)|false|none||none|
|shipping_discount|[Money
](#schemamoney)|false|none||none|
|discount|[Money
](#schemamoney)|false|none||none|
SysUser
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"code": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"remark": null,
"params": null,
"deptId": null,
"parentId": null,
"ancestors": null,
"deptName": null,
"orderNum": null,
"leader": null,
"phone": null,
"email": null,
"status": null,
"delFlag": null,
"parentName": null,
"children": null
}
]
}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"admin": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|userId|integer(int64)|false|none||none|
|deptId|integer(int64)|false|none||none|
|userName|string|true|none||none|
|nickName|string|false|none||none|
|email|string|false|none||none|
|phonenumber|string|false|none||none|
|sex|string|false|none||none|
|avatar|string|false|none||none|
|password|string|false|none||none|
|fullName|string|false|none||none|
|age|integer(int32)|false|none||none|
|address|string|false|none||none|
|code|string|false|none||none|
|status|string|false|none||none|
|delFlag|string|false|none||none|
|loginIp|string|false|none||none|
|loginDate|string(date-time)|false|none||none|
|dept|[SysDept
](#schemasysdept)|false|none||none|
|roles|[
[SysRole
](#schemasysrole)
]|false|none||none|
|roleIds|[integer
]|false|none||none|
|postIds|[integer
]|false|none||none|
|roleId|integer(int64)|false|none||none|
|admin|boolean|false|none||none|
AmountWithBreakdown
```json
{
"currency_code": "string",
"value": "string",
"breakdown": {
"item_total": {
"currency_code": "string",
"value": "string"
},
"shipping": {
"currency_code": "string",
"value": "string"
},
"handling": {
"currency_code": "string",
"value": "string"
},
"tax_total": {
"currency_code": "string",
"value": "string"
},
"insurance": {
"currency_code": "string",
"value": "string"
},
"shipping_discount": {
"currency_code": "string",
"value": "string"
},
"discount": {
"currency_code": "string",
"value": "string"
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|currency_code|string|false|none||none|
|value|string|false|none||none|
|breakdown|[AmountBreakdown
](#schemaamountbreakdown)|false|none||none|
AjaxResult
```json
{
"success": true,
"warn": true,
"error": true,
"empty": true,
"property1": {},
"property2": {}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|**additionalProperties**|object|false|none||none|
|success|boolean|false|none||none|
|warn|boolean|false|none||none|
|error|boolean|false|none||none|
|empty|boolean|false|none||none|
ApplePayAttributesResponse
```json
{
"vault": {
"id": "string",
"status": "VAULTED",
"customer": {
"id": "string"
},
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
]
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|vault|[VaultResponse
](#schemavaultresponse)|false|none||none|
SysUserForgotPwdBo
```json
{
"email": "string",
"password": "string",
"code": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|email|string|false|none||none|
|password|string|false|none||none|
|code|string|false|none||none|
UAccountPackage
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"accountId": 0,
"packageId": 0,
"traffic": 0,
"duration": 0,
"clientNum": 0,
"expiredTime": "2019-08-24T14:15:22Z",
"packageName": "string",
"periodNum": 0,
"periodType": 0,
"price": 0,
"remark": "string",
"rateLimitEnable": true,
"trafficEnable": true,
"durationEnable": true,
"clientNumEnable": true,
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true
}
```
用户平台-账户套餐表
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|integer(int64)|false|none||none|
|delFlag|boolean|false|none||none|
|createBy|integer(int64)|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|integer(int64)|false|none||none|
|updateTime|string(date-time)|false|none||none|
|accountId|integer(int64)|false|none||账户ID|
|packageId|integer(int64)|false|none||套餐ID|
|traffic|integer(int64)|false|none||流量|
|duration|integer(int64)|false|none||时长|
|clientNum|integer(int32)|false|none||在线设备数|
|expiredTime|string(date-time)|false|none||失效时间|
|packageName|string|false|none||套餐名称|
|periodNum|integer(int32)|false|none||有效期数|
|periodType|integer(int32)|false|none||有效期类型|
|price|number|false|none||价格|
|remark|string|false|none||备注|
|rateLimitEnable|boolean|false|none||带宽是否限制|
|trafficEnable|boolean|false|none||流量是否限制|
|durationEnable|boolean|false|none||时长是否限制|
|clientNumEnable|boolean|false|none||在线设备数是否限制|
|rateLimitName|string|false|none||限速名称|
|downLimit|integer(int64)|false|none||下行限速|
|downLimitEnable|boolean|false|none||下行限速启用|
|upLimit|integer(int64)|false|none||上行限速|
|upLimitEnable|boolean|false|none||上行限速启用|
ApplePayCardResponse
```json
{
"name": "string",
"last_digits": "string",
"brand": "VISA",
"available_networks": [
"VISA"
],
"type": "CREDIT",
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
},
"attributes": {
"vault": {
"id": "string",
"status": "VAULTED",
"links": [
{
"href": "string",
"rel": "string",
"method": "["
}
],
"customer": {
"id": "string",
"email_address": "string",
"phone": {
"phone_type": null,
"phone_number": null
},
"merchant_customer_id": "string"
}
}
},
"from_request": {
"expiry": "string",
"last_digits": "string"
},
"expiry": "string",
"bin_details": {
"bin": "string",
"issuing_bank": "string",
"bin_country_code": "string",
"products": [
"string"
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "FIRST",
"previous_network_transaction_reference": {
"id": "string",
"date": "string",
"network": "VISA",
"acquirer_reference_number": "string"
}
},
"billing_address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"country_code": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|last_digits|string|false|none||none|
|brand|string|false|none||none|
|available_networks|[string
]|false|none||none|
|type|string|false|none||none|
|authentication_result|[AuthenticationResponse
](#schemaauthenticationresponse)|false|none||none|
|attributes|[CardAttributesResponse
](#schemacardattributesresponse)|false|none||none|
|from_request|[CardFromRequest
](#schemacardfromrequest)|false|none||none|
|expiry|string|false|none||none|
|bin_details|[BinDetails
](#schemabindetails)|false|none||none|
|stored_credential|[CardStoredCredential
](#schemacardstoredcredential)|false|none||none|
|billing_address|[Address
](#schemaaddress)|false|none||none|
|country_code|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|brand|VISA|
|brand|MASTERCARD|
|brand|DISCOVER|
|brand|AMEX|
|brand|SOLO|
|brand|JCB|
|brand|STAR|
|brand|DELTA|
|brand|SWITCH|
|brand|MAESTRO|
|brand|CB_NATIONALE|
|brand|CONFIGOGA|
|brand|CONFIDIS|
|brand|ELECTRON|
|brand|CETELEM|
|brand|CHINA_UNION_PAY|
|brand|DINERS|
|brand|ELO|
|brand|HIPER|
|brand|HIPERCARD|
|brand|RUPAY|
|brand|GE|
|brand|SYNCHRONY|
|brand|EFTPOS|
|brand|UNKNOWN|
|brand|null|
|type|CREDIT|
|type|DEBIT|
|type|PREPAID|
|type|STORE|
|type|UNKNOWN|
|type|null|
UPayment
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"name": "string",
"type": 0,
"appId": "string",
"serverUrl": "string",
"domain": "string",
"privateKey": "string",
"publicKey": "string",
"appCertPath": "string",
"certPath": "string",
"rootCertPath": "string",
"enable": true
}
```
用户平台-支付表
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|integer(int64)|false|none||none|
|delFlag|boolean|false|none||none|
|createBy|integer(int64)|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|integer(int64)|false|none||none|
|updateTime|string(date-time)|false|none||none|
|name|string|false|none||支付名称|
|type|integer(int32)|false|none||类型(0支付宝 1微信 2信用卡)|
|appId|string|false|none||应用编号|
|serverUrl|string|false|none||支付网关|
|domain|string|false|none||外网访问项目的域名|
|privateKey|string|false|none||应用私钥|
|publicKey|string|false|none||应用公钥|
|appCertPath|string|false|none||应用公钥证书|
|certPath|string|false|none||公钥证书|
|rootCertPath|string|false|none||根证书|
|enable|boolean|false|none||是否启用|
ApplePayPaymentObject
```json
{
"id": "string",
"token": "string",
"name": "string",
"email_address": "string",
"phone_number": {
"national_number": "string"
},
"card": {
"name": "string",
"last_digits": "string",
"brand": "VISA",
"available_networks": [
"VISA"
],
"type": "CREDIT",
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
},
"attributes": {
"vault": {
"id": "string",
"status": "VAULTED",
"links": [
{}
],
"customer": {
"id": null,
"email_address": null,
"phone": null,
"merchant_customer_id": null
}
}
},
"from_request": {
"expiry": "string",
"last_digits": "string"
},
"expiry": "string",
"bin_details": {
"bin": "string",
"issuing_bank": "string",
"bin_country_code": "string",
"products": [
"string"
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "FIRST",
"previous_network_transaction_reference": {
"id": "string",
"date": "string",
"network": "VISA",
"acquirer_reference_number": "string"
}
},
"billing_address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"country_code": "string"
},
"attributes": {
"vault": {
"id": "string",
"status": "VAULTED",
"customer": {
"id": "string"
},
"links": [
{
"href": "string",
"rel": "string",
"method": "["
}
]
}
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "FIRST",
"previous_network_transaction_reference": {
"id": "string",
"date": "string",
"network": "VISA",
"acquirer_reference_number": "string"
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|string|false|none||none|
|token|string|false|none||none|
|name|string|false|none||none|
|email_address|string|false|none||none|
|phone_number|[PhoneNumber
](#schemaphonenumber)|false|none||none|
|card|[ApplePayCardResponse
](#schemaapplepaycardresponse)|false|none||none|
|attributes|[ApplePayAttributesResponse
](#schemaapplepayattributesresponse)|false|none||none|
|stored_credential|[CardStoredCredential
](#schemacardstoredcredential)|false|none||none|
DstTimeOpenApiDto
```json
{
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|month|integer(int32)|true|none||none|
|serial|integer(int32)|true|none||none|
|day|integer(int32)|true|none||none|
|hour|integer(int32)|true|none||none|
|minute|integer(int32)|true|none||none|
UUserForgotPwdBo
```json
{
"email": "string",
"password": "string",
"code": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|email|string|false|none||none|
|password|string|false|none||none|
|code|string|false|none||none|
AuthenticationResponse
```json
{
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|liability_shift|string|false|none||none|
|three_d_secure|[ThreeDSecureAuthenticationResponse
](#schemathreedsecureauthenticationresponse)|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|liability_shift|NO|
|liability_shift|POSSIBLE|
|liability_shift|UNKNOWN|
|liability_shift|null|
ModifyDstDto
```json
{
"enable": true,
"start": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"end": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"offset": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|enable|boolean|false|none||none|
|start|[DstTimeOpenApiDto
](#schemadsttimeopenapidto)|false|none||none|
|end|[DstTimeOpenApiDto
](#schemadsttimeopenapidto)|false|none||none|
|offset|integer(int64)|false|none||none|
UUserRole
```json
{
"userId": 0,
"roleId": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|userId|integer(int64)|false|none||none|
|roleId|integer(int64)|false|none||none|
AuthorizationStatusDetails
```json
{
"reason": "PENDING_REVIEW"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|reason|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|reason|PENDING_REVIEW|
|reason|DECLINED_BY_RISK_FRAUD_FILTERS|
|reason|null|
NtpServer
```json
{
"address": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|address|string|false|none||none|
UPost
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"postId": 0,
"postCode": "string",
"postName": "string",
"postSort": 0,
"status": "string",
"flag": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|postId|integer(int64)|false|none||none|
|postCode|string|true|none||none|
|postName|string|true|none||none|
|postSort|integer(int32)|true|none||none|
|status|string|false|none||none|
|flag|boolean|false|none||none|
AuthorizationWithAdditionalData
```json
{
"status": "CREATED",
"status_details": {
"reason": "PENDING_REVIEW"
},
"id": "string",
"amount": {
"currency_code": "string",
"value": "string"
},
"invoice_id": "string",
"custom_id": "string",
"network_transaction_reference": {
"id": "string",
"date": "string",
"network": "VISA",
"acquirer_reference_number": "string"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED"
]
},
"expiration_time": "string",
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
],
"create_time": "string",
"update_time": "string",
"processor_response": {
"avs_code": "A",
"cvv_code": "E",
"response_code": "0000",
"payment_advice_code": "01"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|status|string|false|none||none|
|status_details|[AuthorizationStatusDetails
](#schemaauthorizationstatusdetails)|false|none||none|
|id|string|false|none||none|
|amount|[Money
](#schemamoney)|false|none||none|
|invoice_id|string|false|none||none|
|custom_id|string|false|none||none|
|network_transaction_reference|[NetworkTransactionReference
](#schemanetworktransactionreference)|false|none||none|
|seller_protection|[SellerProtection
](#schemasellerprotection)|false|none||none|
|expiration_time|string|false|none||none|
|links|[
[LinkDescription
](#schemalinkdescription)
]|false|none||none|
|create_time|string|false|none||none|
|update_time|string|false|none||none|
|processor_response|[ProcessorResponse
](#schemaprocessorresponse)|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|status|CREATED|
|status|CAPTURED|
|status|DENIED|
|status|PARTIALLY_CAPTURED|
|status|VOIDED|
|status|PENDING|
|status|null|
UpdateSiteEntity
```json
{
"name": "string",
"region": "string",
"timeZone": "string",
"tagIds": [
"string"
],
"ntpEnable": true,
"ntpServers": [
{
"address": "string"
}
],
"dst": {
"enable": true,
"start": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"end": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"offset": 0
},
"scenario": "string",
"longitude": 0.1,
"latitude": 0.1,
"address": "string",
"supportES": true,
"supportL2": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|region|string|true|none||none|
|timeZone|string|true|none||none|
|tagIds|[string
]|false|none||none|
|ntpEnable|boolean|false|none||none|
|ntpServers|[
[NtpServer
](#schemantpserver)
]|false|none||none|
|dst|[ModifyDstDto
](#schemamodifydstdto)|false|none||none|
|scenario|string|true|none||none|
|longitude|number(double)|false|none||none|
|latitude|number(double)|false|none||none|
|address|string|false|none||none|
|supportES|boolean|false|none||none|
|supportL2|boolean|false|none||none|
```json
{
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string",
"card_last_digits": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|country_code|string|false|none||none|
|bic|string|false|none||none|
|iban_last_chars|string|false|none||none|
|card_last_digits|string|false|none||none|
SysUserRole
```json
{
"userId": 0,
"roleId": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|userId|integer(int64)|false|none||none|
|roleId|integer(int64)|false|none||none|
BinDetails
```json
{
"bin": "string",
"issuing_bank": "string",
"bin_country_code": "string",
"products": [
"string"
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|bin|string|false|none||none|
|issuing_bank|string|false|none||none|
|bin_country_code|string|false|none||none|
|products|[string
]|false|none||none|
URateLimit
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true
}
```
用户平台-带宽限速表
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|integer(int64)|false|none||none|
|delFlag|boolean|false|none||none|
|createBy|integer(int64)|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|integer(int64)|false|none||none|
|updateTime|string(date-time)|false|none||none|
|rateLimitName|string|false|none||限速名称|
|downLimit|integer(int64)|false|none||下行限速|
|downLimitEnable|boolean|false|none||下行限速启用|
|upLimit|integer(int64)|false|none||上行限速|
|upLimitEnable|boolean|false|none||上行限速启用|
BlikOneClickPaymentObject
```json
{
"consumer_reference": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|consumer_reference|string|false|none||none|
SysPost
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"postId": 0,
"postCode": "string",
"postName": "string",
"postSort": 0,
"status": "string",
"flag": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|postId|integer(int64)|false|none||none|
|postCode|string|true|none||none|
|postName|string|true|none||none|
|postSort|integer(int32)|true|none||none|
|status|string|false|none||none|
|flag|boolean|false|none||none|
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"menuId": 0,
"menuName": "string",
"parentName": "string",
"parentId": 0,
"orderNum": 0,
"path": "string",
"component": "string",
"query": "string",
"routeName": "string",
"isFrame": "string",
"isCache": "string",
"menuType": "string",
"visible": "string",
"status": "string",
"perms": "string",
"icon": "string",
"name": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"menuId": 0,
"menuName": "string",
"parentName": "string",
"parentId": 0,
"orderNum": 0,
"path": "string",
"component": "string",
"query": "string",
"routeName": "string",
"isFrame": "string",
"isCache": "string",
"menuType": "string",
"visible": "string",
"status": "string",
"perms": "string",
"icon": "string",
"name": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"menuId": 0,
"menuName": "string",
"parentName": "string",
"parentId": 0,
"orderNum": 0,
"path": "string",
"component": "string",
"query": "string",
"routeName": "string",
"isFrame": "string",
"isCache": "string",
"menuType": "string",
"visible": "string",
"status": "string",
"perms": "string",
"icon": "string",
"name": "string",
"children": [
{}
]
}
]
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|menuId|integer(int64)|false|none||none|
|menuName|string|true|none||none|
|parentName|string|false|none||none|
|parentId|integer(int64)|false|none||none|
|orderNum|integer(int32)|true|none||none|
|path|string|false|none||none|
|component|string|false|none||none|
|query|string|false|none||none|
|routeName|string|false|none||none|
|isFrame|string|false|none||none|
|isCache|string|false|none||none|
|menuType|string|true|none||none|
|visible|string|false|none||none|
|status|string|false|none||none|
|perms|string|false|none||none|
|icon|string|false|none||none|
|name|string|false|none||none|
|children|[
[UMenu
](#schemaumenu)
]|false|none||none|
BlikPaymentObject
```json
{
"name": "string",
"country_code": "string",
"email": "string",
"one_click": {
"consumer_reference": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|country_code|string|false|none||none|
|email|string|false|none||none|
|one_click|[BlikOneClickPaymentObject
](#schemablikoneclickpaymentobject)|false|none||none|
AdvertisementSetting
```json
{
"enable": true,
"pictureIds": [
"string"
],
"totalDuration": 0,
"pictureInterval": 0,
"skipEnable": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|enable|boolean|true|none||none|
|pictureIds|[string
]|false|none||none|
|totalDuration|integer(int32)|false|none||none|
|pictureInterval|integer(int32)|false|none||none|
|skipEnable|boolean|false|none||none|
CaptureStatusDetails
```json
{
"reason": "BUYER_COMPLAINT"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|reason|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|reason|BUYER_COMPLAINT|
|reason|CHARGEBACK|
|reason|ECHECK|
|reason|INTERNATIONAL_WITHDRAWAL|
|reason|OTHER|
|reason|PENDING_REVIEW|
|reason|RECEIVING_PREFERENCE_MANDATES_MANUAL_ACTION|
|reason|REFUNDED|
|reason|TRANSACTION_APPROVED_AWAITING_FUNDING|
|reason|UNILATERAL|
|reason|VERIFICATION_REQUIRED|
|reason|DECLINED_BY_RISK_FRAUD_FILTERS|
|reason|null|
AuthTimeoutSetting
```json
{
"customTimeout": 0,
"customTimeoutUnit": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|customTimeout|integer(int32)|false|none||none|
|customTimeoutUnit|integer(int32)|false|none||none|
UDictType
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"dictId": 0,
"dictName": "string",
"dictType": "string",
"status": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|dictId|integer(int64)|false|none||none|
|dictName|string|true|none||none|
|dictType|string|true|none||none|
|status|string|false|none||none|
CardAttributesResponse
```json
{
"vault": {
"id": "string",
"status": "VAULTED",
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
],
"customer": {
"id": "string",
"email_address": "string",
"phone": {
"phone_type": "FAX",
"phone_number": {
"national_number": null
}
},
"merchant_customer_id": "string"
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|vault|[CardVaultResponse
](#schemacardvaultresponse)|false|none||none|
ExternalRadiusSetting
```json
{
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string",
"disconnectReq": true,
"receiverPort": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|radiusProfileId|string|true|none||none|
|authMode|integer(int32)|true|none||none|
|nasId|string|true|none||none|
|portalCustom|integer(int32)|true|none||none|
|externalUrlScheme|string|false|none||none|
|externalUrl|string|false|none||none|
|disconnectReq|boolean|false|none||none|
|receiverPort|integer(int32)|false|none||none|
UDictData
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"dictCode": 0,
"dictSort": 0,
"dictLabel": "string",
"dictValue": "string",
"dictType": "string",
"cssClass": "string",
"listClass": "string",
"isDefault": "string",
"status": "string",
"default": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|dictCode|integer(int64)|false|none||none|
|dictSort|integer(int64)|false|none||none|
|dictLabel|string|true|none||none|
|dictValue|string|true|none||none|
|dictType|string|true|none||none|
|cssClass|string|false|none||none|
|listClass|string|false|none||none|
|isDefault|string|false|none||none|
|status|string|false|none||none|
|default|boolean|false|none||none|
```json
{
"id": "string",
"email_address": "string",
"phone": {
"phone_type": "FAX",
"phone_number": {
"national_number": "string"
}
},
"merchant_customer_id": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|string|false|none||none|
|email_address|string|false|none||none|
|phone|[PhoneWithType
](#schemaphonewithtype)|false|none||none|
|merchant_customer_id|string|false|none||none|
HotspotRadiusSetting
```json
{
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"authTimeout": {
"customTimeout": 0,
"customTimeoutUnit": 0
},
"disconnectReq": true,
"receiverPort": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|radiusProfileId|string|true|none||none|
|authMode|integer(int32)|true|none||none|
|nasId|string|true|none||none|
|authTimeout|[AuthTimeoutSetting
](#schemaauthtimeoutsetting)|true|none||none|
|disconnectReq|boolean|false|none||none|
|receiverPort|integer(int32)|false|none||none|
UConfig
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"configId": 0,
"configName": "string",
"configKey": "string",
"configValue": "string",
"configType": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|configId|integer(int64)|false|none||none|
|configName|string|true|none||none|
|configKey|string|true|none||none|
|configValue|string|true|none||none|
|configType|string|false|none||none|
CardFromRequest
```json
{
"expiry": "string",
"last_digits": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|expiry|string|false|none||none|
|last_digits|string|false|none||none|
ImportedPortalPageOpenApiVo
```json
{
"id": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|string|true|none||none|
UAccount
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"userId": 0,
"balance": 0,
"packageId": 0,
"startTime": "2019-08-24T14:15:22Z",
"endTime": "2019-08-24T14:15:22Z",
"trafficUsed": 0,
"durationUsed": 0,
"expiredTime": "2019-08-24T14:15:22Z",
"clientNumUsed": 0,
"balanceUsed": 0,
"packageName": "string",
"periodNum": 0,
"periodType": 0,
"price": 0,
"traffic": 0,
"duration": 0,
"clientNum": 0,
"remark": "string",
"rateLimitEnable": true,
"trafficEnable": true,
"durationEnable": true,
"clientNumEnable": true,
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true,
"packageReminder": 0,
"balanceReminder": 0
}
```
用户平台-账户表
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|integer(int64)|false|none||none|
|delFlag|boolean|false|none||none|
|createBy|integer(int64)|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|integer(int64)|false|none||none|
|updateTime|string(date-time)|false|none||none|
|userId|integer(int64)|false|none||用户ID|
|balance|number|false|none||余额|
|packageId|integer(int64)|false|none||套餐ID|
|startTime|string(date-time)|false|none||开始时间|
|endTime|string(date-time)|false|none||结束时间|
|trafficUsed|integer(int64)|false|none||流量已使用|
|durationUsed|integer(int64)|false|none||时长已使用|
|expiredTime|string(date-time)|false|none||失效时间|
|clientNumUsed|integer(int32)|false|none||在线设备数已使用|
|balanceUsed|number|false|none||余额已使用|
|packageName|string|false|none||套餐名称|
|periodNum|integer(int32)|false|none||有效期数|
|periodType|integer(int32)|false|none||有效期类型|
|price|number|false|none||价格|
|traffic|integer(int64)|false|none||流量|
|duration|integer(int64)|false|none||时长|
|clientNum|integer(int32)|false|none||在线设备数|
|remark|string|false|none||备注|
|rateLimitEnable|boolean|false|none||带宽是否限制|
|trafficEnable|boolean|false|none||流量是否限制|
|durationEnable|boolean|false|none||时长是否限制|
|clientNumEnable|boolean|false|none||在线设备数是否限制|
|rateLimitName|string|false|none||限速名称|
|downLimit|integer(int64)|false|none||下行限速|
|downLimitEnable|boolean|false|none||下行限速启用|
|upLimit|integer(int64)|false|none||上行限速|
|upLimitEnable|boolean|false|none||上行限速启用|
|packageReminder|integer(int32)|false|none||套餐提醒|
|balanceReminder|integer(int32)|false|none||余额提醒|
CardResponse
```json
{
"name": "string",
"last_digits": "string",
"brand": "VISA",
"available_networks": [
"VISA"
],
"type": "CREDIT",
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
},
"attributes": {
"vault": {
"id": "string",
"status": "VAULTED",
"links": [
{
"href": "string",
"rel": "string",
"method": "["
}
],
"customer": {
"id": "string",
"email_address": "string",
"phone": {
"phone_type": null,
"phone_number": null
},
"merchant_customer_id": "string"
}
}
},
"from_request": {
"expiry": "string",
"last_digits": "string"
},
"expiry": "string",
"bin_details": {
"bin": "string",
"issuing_bank": "string",
"bin_country_code": "string",
"products": [
"string"
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "FIRST",
"previous_network_transaction_reference": {
"id": "string",
"date": "string",
"network": "VISA",
"acquirer_reference_number": "string"
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|last_digits|string|false|none||none|
|brand|string|false|none||none|
|available_networks|[string
]|false|none||none|
|type|string|false|none||none|
|authentication_result|[AuthenticationResponse
](#schemaauthenticationresponse)|false|none||none|
|attributes|[CardAttributesResponse
](#schemacardattributesresponse)|false|none||none|
|from_request|[CardFromRequest
](#schemacardfromrequest)|false|none||none|
|expiry|string|false|none||none|
|bin_details|[BinDetails
](#schemabindetails)|false|none||none|
|stored_credential|[CardStoredCredential
](#schemacardstoredcredential)|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|brand|VISA|
|brand|MASTERCARD|
|brand|DISCOVER|
|brand|AMEX|
|brand|SOLO|
|brand|JCB|
|brand|STAR|
|brand|DELTA|
|brand|SWITCH|
|brand|MAESTRO|
|brand|CB_NATIONALE|
|brand|CONFIGOGA|
|brand|CONFIDIS|
|brand|ELECTRON|
|brand|CETELEM|
|brand|CHINA_UNION_PAY|
|brand|DINERS|
|brand|ELO|
|brand|HIPER|
|brand|HIPERCARD|
|brand|RUPAY|
|brand|GE|
|brand|SYNCHRONY|
|brand|EFTPOS|
|brand|UNKNOWN|
|brand|null|
|type|CREDIT|
|type|DEBIT|
|type|PREPAID|
|type|STORE|
|type|UNKNOWN|
|type|null|
LdapSetting
```json
{
"ldapProfileId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|ldapProfileId|string|true|none||none|
|portalCustom|integer(int32)|true|none||none|
|externalUrlScheme|string|false|none||none|
|externalUrl|string|false|none||none|
CardStoredCredential
```json
{
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "FIRST",
"previous_network_transaction_reference": {
"id": "string",
"date": "string",
"network": "VISA",
"acquirer_reference_number": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|payment_initiator|string|false|none||none|
|payment_type|string|false|none||none|
|usage|string|false|none||none|
|previous_network_transaction_reference|[NetworkTransactionReference
](#schemanetworktransactionreference)|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|payment_initiator|CUSTOMER|
|payment_initiator|MERCHANT|
|payment_initiator|null|
|payment_type|ONE_TIME|
|payment_type|RECURRING|
|payment_type|UNSCHEDULED|
|payment_type|null|
|usage|FIRST|
|usage|SUBSEQUENT|
|usage|DERIVED|
|usage|null|
PortalCustomizeOpenApiVo
```json
{
"defaultLanguage": 0,
"backgroundPictureId": "string",
"logoPictureId": "string",
"logoDisplay": true,
"inputBoxColor": "string",
"inputBoxOpacity": 0,
"inputTextColor": "string",
"inputTextOpacity": 0,
"buttonColor": "string",
"buttonOpacity": 0,
"buttonTextColor": "string",
"buttonTextOpacity": 0,
"buttonText": "string",
"formAuthButtonText": "string",
"welcomeEnable": true,
"welcomeInformation": "string",
"welcomeTextColor": "string",
"welcomeTextOpacity": 0,
"welcomeTextFontSize": 0,
"termsOfServiceEnable": true,
"termsOfServiceText": "string",
"termsOfServiceFontSize": 0,
"termsOfServiceUrlTexts": [
{}
],
"copyrightEnable": true,
"copyright": "string",
"copyrightTextColor": "string",
"copyrightTextOpacity": 0,
"copyrightTextFontSize": 0,
"redirectionCountDownEnable": true,
"advertisement": {
"enable": true,
"pictureIds": [
"string"
],
"totalDuration": 0,
"pictureInterval": 0,
"skipEnable": true
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|defaultLanguage|integer(int32)|true|none||none|
|backgroundPictureId|string|false|none||none|
|logoPictureId|string|false|none||none|
|logoDisplay|boolean|true|none||none|
|inputBoxColor|string|false|none||none|
|inputBoxOpacity|integer(int32)|false|none||none|
|inputTextColor|string|false|none||none|
|inputTextOpacity|integer(int32)|false|none||none|
|buttonColor|string|false|none||none|
|buttonOpacity|integer(int32)|false|none||none|
|buttonTextColor|string|false|none||none|
|buttonTextOpacity|integer(int32)|false|none||none|
|buttonText|string|false|none||none|
|formAuthButtonText|string|false|none||none|
|welcomeEnable|boolean|true|none||none|
|welcomeInformation|string|false|none||none|
|welcomeTextColor|string|false|none||none|
|welcomeTextOpacity|integer(int32)|false|none||none|
|welcomeTextFontSize|integer(int32)|false|none||none|
|termsOfServiceEnable|boolean|true|none||none|
|termsOfServiceText|string|false|none||none|
|termsOfServiceFontSize|integer(int32)|false|none||none|
|termsOfServiceUrlTexts|[object
]|false|none||none|
|copyrightEnable|boolean|true|none||none|
|copyright|string|false|none||none|
|copyrightTextColor|string|false|none||none|
|copyrightTextOpacity|integer(int32)|false|none||none|
|copyrightTextFontSize|integer(int32)|false|none||none|
|redirectionCountDownEnable|boolean|false|none||none|
|advertisement|[AdvertisementSetting
](#schemaadvertisementsetting)|false|none||none|
CardSupplementaryData
```json
{
"level_2": {
"invoice_id": "string",
"tax_total": {
"currency_code": "string",
"value": "string"
}
},
"level_3": {
"shipping_amount": {
"currency_code": "string",
"value": "string"
},
"duty_amount": {
"currency_code": "string",
"value": "string"
},
"discount_amount": {
"currency_code": "string",
"value": "string"
},
"shipping_address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"ships_from_postal_code": "string",
"line_items": [
{
"name": "string",
"quantity": "string",
"description": "string",
"sku": "string",
"url": "string",
"image_url": "string",
"upc": {
"type": "[",
"code": "string"
},
"unit_amount": {
"currency_code": "string",
"value": "string"
},
"tax": {
"currency_code": "string",
"value": "string"
},
"commodity_code": "string",
"discount_amount": {
"currency_code": "string",
"value": "string"
},
"total_amount": {
"currency_code": "string",
"value": "string"
},
"unit_of_measure": "string"
}
]
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|level_2|[Level2CardProcessingData
](#schemalevel2cardprocessingdata)|false|none||none|
|level_3|[Level3CardProcessingData
](#schemalevel3cardprocessingdata)|false|none||none|
PortalSetting
```json
{
"name": "string",
"enable": true,
"ssidList": [
"string"
],
"networkList": [
"string"
],
"authType": 0,
"authTimeout": {
"customTimeout": 0,
"customTimeoutUnit": 0
},
"httpsRedirectEnable": true,
"landingPage": 0,
"landingUrlScheme": "string",
"landingUrl": "string",
"noAuth": {},
"simplePassword": {},
"hotspot": {},
"sms": {
"sid": "string",
"authToken": "string",
"phoneNum": "string",
"userLimitEnable": true,
"userLimit": 0,
"authTimeout": {
"customTimeout": 0,
"customTimeoutUnit": 0
},
"countryCode": "string"
},
"portalFormId": "string",
"hotspotRadius": {
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"authTimeout": {
"customTimeout": 0,
"customTimeoutUnit": 0
},
"disconnectReq": true,
"receiverPort": 0
},
"externalPortal": {},
"externalRadius": {
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string",
"disconnectReq": true,
"receiverPort": 0
},
"ldap": {
"ldapProfileId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string"
},
"pageType": 0,
"importedPortalPage": {
"id": "string"
},
"portalCustomize": {
"defaultLanguage": 0,
"backgroundPictureId": "string",
"logoPictureId": "string",
"logoDisplay": true,
"inputBoxColor": "string",
"inputBoxOpacity": 0,
"inputTextColor": "string",
"inputTextOpacity": 0,
"buttonColor": "string",
"buttonOpacity": 0,
"buttonTextColor": "string",
"buttonTextOpacity": 0,
"buttonText": "string",
"formAuthButtonText": "string",
"welcomeEnable": true,
"welcomeInformation": "string",
"welcomeTextColor": "string",
"welcomeTextOpacity": 0,
"welcomeTextFontSize": 0,
"termsOfServiceEnable": true,
"termsOfServiceText": "string",
"termsOfServiceFontSize": 0,
"termsOfServiceUrlTexts": [
{}
],
"copyrightEnable": true,
"copyright": "string",
"copyrightTextColor": "string",
"copyrightTextOpacity": 0,
"copyrightTextFontSize": 0,
"redirectionCountDownEnable": true,
"advertisement": {
"enable": true,
"pictureIds": [
"string"
],
"totalDuration": 0,
"pictureInterval": 0,
"skipEnable": true
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|true|none||none|
|enable|boolean|true|none||none|
|ssidList|[string
]|false|none||none|
|networkList|[string
]|false|none||none|
|authType|integer(int32)|true|none||none|
|authTimeout|[AuthTimeoutSetting
](#schemaauthtimeoutsetting)|true|none||none|
|httpsRedirectEnable|boolean|true|none||none|
|landingPage|integer(int32)|true|none||none|
|landingUrlScheme|string|false|none||none|
|landingUrl|string|false|none||none|
|noAuth|object|false|none||none|
|simplePassword|object|false|none||none|
|hotspot|object|false|none||none|
|sms|[SmsSetting
](#schemasmssetting)|false|none||none|
|portalFormId|string|false|none||none|
|hotspotRadius|[HotspotRadiusSetting
](#schemahotspotradiussetting)|false|none||none|
|externalPortal|object|false|none||none|
|externalRadius|[ExternalRadiusSetting
](#schemaexternalradiussetting)|false|none||none|
|ldap|[LdapSetting
](#schemaldapsetting)|false|none||none|
|pageType|integer(int32)|false|none||none|
|importedPortalPage|[ImportedPortalPageOpenApiVo
](#schemaimportedportalpageopenapivo)|false|none||none|
|portalCustomize|[PortalCustomizeOpenApiVo
](#schemaportalcustomizeopenapivo)|false|none||none|
CardVaultResponse
```json
{
"id": "string",
"status": "VAULTED",
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
],
"customer": {
"id": "string",
"email_address": "string",
"phone": {
"phone_type": "FAX",
"phone_number": {
"national_number": "string"
}
},
"merchant_customer_id": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|string|false|none||none|
|status|string|false|none||none|
|links|[
[LinkDescription
](#schemalinkdescription)
]|false|none||none|
|customer|[CardCustomerInformation
](#schemacardcustomerinformation)|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|status|VAULTED|
|status|CREATED|
|status|APPROVED|
|status|null|
SmsSetting
```json
{
"sid": "string",
"authToken": "string",
"phoneNum": "string",
"userLimitEnable": true,
"userLimit": 0,
"authTimeout": {
"customTimeout": 0,
"customTimeoutUnit": 0
},
"countryCode": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|sid|string|true|none||none|
|authToken|string|true|none||none|
|phoneNum|string|true|none||none|
|userLimitEnable|boolean|true|none||none|
|userLimit|integer(int32)|false|none||none|
|authTimeout|[AuthTimeoutSetting
](#schemaauthtimeoutsetting)|true|none||none|
|countryCode|string|false|none||none|
RLong
```json
{
"code": 0,
"msg": "string",
"data": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|integer(int64)|false|none||none|
CobrandedCard
```json
{
"labels": [
"string"
],
"payee": {
"email_address": "string",
"merchant_id": "string"
},
"amount": {
"currency_code": "string",
"value": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|labels|[string
]|false|none||none|
|payee|[PayeeBase
](#schemapayeebase)|false|none||none|
|amount|[Money
](#schemamoney)|false|none||none|
UPackage
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitId": 0,
"packageName": "string",
"periodNum": 0,
"periodType": 0,
"price": 0,
"traffic": 0,
"duration": 0,
"clientNum": 0,
"remark": "string",
"rateLimitEnable": true,
"trafficEnable": true,
"durationEnable": true,
"clientNumEnable": true,
"packageEnable": true,
"rateLimits": {
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true
}
}
```
用户平台-套餐表
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|integer(int64)|false|none||none|
|delFlag|boolean|false|none||none|
|createBy|integer(int64)|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|integer(int64)|false|none||none|
|updateTime|string(date-time)|false|none||none|
|rateLimitId|integer(int64)|false|none||带宽限速ID|
|packageName|string|false|none||套餐名称|
|periodNum|integer(int32)|false|none||有效期数|
|periodType|integer(int32)|false|none||有效期类型|
|price|number|false|none||价格|
|traffic|integer(int64)|false|none||流量|
|duration|integer(int64)|false|none||时长|
|clientNum|integer(int32)|false|none||在线设备数|
|remark|string|false|none||备注|
|rateLimitEnable|boolean|false|none||带宽是否限制|
|trafficEnable|boolean|false|none||流量是否限制|
|durationEnable|boolean|false|none||时长是否限制|
|clientNumEnable|boolean|false|none||在线设备数是否限制|
|packageEnable|boolean|false|none||套餐是否启用|
|rateLimits|[URateLimit
](#schemauratelimit)|false|none||用户平台-带宽限速表|
UOperLog
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"operId": 0,
"title": "string",
"businessType": 0,
"businessTypes": [
0
],
"method": "string",
"requestMethod": "string",
"operatorType": 0,
"operName": "string",
"deptName": "string",
"operUrl": "string",
"operIp": "string",
"operParam": "string",
"jsonResult": "string",
"status": 0,
"errorMsg": "string",
"operTime": "2019-08-24T14:15:22Z",
"costTime": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|operId|integer(int64)|false|none||none|
|title|string|false|none||none|
|businessType|integer(int32)|false|none||none|
|businessTypes|[integer
]|false|none||none|
|method|string|false|none||none|
|requestMethod|string|false|none||none|
|operatorType|integer(int32)|false|none||none|
|operName|string|false|none||none|
|deptName|string|false|none||none|
|operUrl|string|false|none||none|
|operIp|string|false|none||none|
|operParam|string|false|none||none|
|jsonResult|string|false|none||none|
|status|integer(int32)|false|none||none|
|errorMsg|string|false|none||none|
|operTime|string(date-time)|false|none||none|
|costTime|integer(int64)|false|none||none|
EpsPaymentObject
```json
{
"name": "string",
"country_code": "string",
"bic": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|country_code|string|false|none||none|
|bic|string|false|none||none|
SysNotice
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"noticeId": 0,
"noticeTitle": "string",
"noticeType": "string",
"noticeContent": "string",
"status": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|noticeId|integer(int64)|false|none||none|
|noticeTitle|string|true|none||none|
|noticeType|string|false|none||none|
|noticeContent|string|false|none||none|
|status|string|false|none||none|
ULogininfor
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"infoId": 0,
"userName": "string",
"status": "string",
"ipaddr": "string",
"msg": "string",
"accessTime": "2019-08-24T14:15:22Z"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|infoId|integer(int64)|false|none||none|
|userName|string|false|none||none|
|status|string|false|none||none|
|ipaddr|string|false|none||none|
|msg|string|false|none||none|
|accessTime|string(date-time)|false|none||none|
ExchangeRate
```json
{
"source_currency": "string",
"target_currency": "string",
"value": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|source_currency|string|false|none||none|
|target_currency|string|false|none||none|
|value|string|false|none||none|
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"menuId": 0,
"menuName": "string",
"parentName": "string",
"parentId": 0,
"orderNum": 0,
"path": "string",
"component": "string",
"query": "string",
"routeName": "string",
"isFrame": "string",
"isCache": "string",
"menuType": "string",
"visible": "string",
"status": "string",
"perms": "string",
"icon": "string",
"name": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"menuId": 0,
"menuName": "string",
"parentName": "string",
"parentId": 0,
"orderNum": 0,
"path": "string",
"component": "string",
"query": "string",
"routeName": "string",
"isFrame": "string",
"isCache": "string",
"menuType": "string",
"visible": "string",
"status": "string",
"perms": "string",
"icon": "string",
"name": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"menuId": 0,
"menuName": "string",
"parentName": "string",
"parentId": 0,
"orderNum": 0,
"path": "string",
"component": "string",
"query": "string",
"routeName": "string",
"isFrame": "string",
"isCache": "string",
"menuType": "string",
"visible": "string",
"status": "string",
"perms": "string",
"icon": "string",
"name": "string",
"children": [
{}
]
}
]
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|menuId|integer(int64)|false|none||none|
|menuName|string|true|none||none|
|parentName|string|false|none||none|
|parentId|integer(int64)|false|none||none|
|orderNum|integer(int32)|true|none||none|
|path|string|false|none||none|
|component|string|false|none||none|
|query|string|false|none||none|
|routeName|string|false|none||none|
|isFrame|string|false|none||none|
|isCache|string|false|none||none|
|menuType|string|true|none||none|
|visible|string|false|none||none|
|status|string|false|none||none|
|perms|string|false|none||none|
|icon|string|false|none||none|
|name|string|false|none||none|
|children|[
[SysMenu
](#schemasysmenu)
]|false|none||none|
UClientBo
```json
{
"userId": 0,
"clientName": "string",
"siteId": "string",
"clientDeviceType": "string",
"clientMac": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|userId|integer(int64)|false|none||none|
|clientName|string|false|none||none|
|siteId|string|false|none||none|
|clientDeviceType|string|false|none||none|
|clientMac|string|false|none||none|
GiropayPaymentObject
```json
{
"name": "string",
"country_code": "string",
"bic": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|country_code|string|false|none||none|
|bic|string|false|none||none|
UKyc
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"kycId": 0,
"userId": 0,
"realName": "string",
"birthDate": "string",
"idType": 0,
"idFile": "string",
"identifyPicture": "string",
"status": 0,
"description": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|kycId|integer(int64)|false|none||none|
|userId|integer(int64)|false|none||none|
|realName|string|false|none||none|
|birthDate|string|false|none||none|
|idType|integer(int32)|false|none||none|
|idFile|string|false|none||none|
|identifyPicture|string|false|none||none|
|status|integer(int32)|false|none||none|
|description|string|false|none||none|
LoginUserUUser
```json
{
"token": "string",
"userid": 0,
"username": "string",
"loginTime": 0,
"expireTime": 0,
"ipaddr": "string",
"permissions": [
"string"
],
"roles": [
"string"
],
"user": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"birthDate": "2019-08-24T14:15:22Z",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
null
]
}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"kycStatus": "string",
"admin": true
},
"wanFiRedirectParams": {
"clientMac": "string",
"clientIp": "string",
"t": 0,
"site": "string",
"redirectUrl": "string",
"apMac": "string",
"ssidName": "string",
"radioId": 0
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|token|string|false|none||none|
|userid|integer(int64)|false|none||none|
|username|string|false|none||none|
|loginTime|integer(int64)|false|none||none|
|expireTime|integer(int64)|false|none||none|
|ipaddr|string|false|none||none|
|permissions|[string
]|false|none||none|
|roles|[string
]|false|none||none|
|user|[UUser
](#schemauuser)|false|none||none|
|wanFiRedirectParams|[WANFiRedirectParams
](#schemawanfiredirectparams)|false|none||none|
GooglePayCardResponse
```json
{
"name": "string",
"last_digits": "string",
"type": "CREDIT",
"brand": "VISA",
"billing_address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|last_digits|string|false|none||none|
|type|string|false|none||none|
|brand|string|false|none||none|
|billing_address|[Address
](#schemaaddress)|false|none||none|
|authentication_result|[AuthenticationResponse
](#schemaauthenticationresponse)|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|type|CREDIT|
|type|DEBIT|
|type|PREPAID|
|type|STORE|
|type|UNKNOWN|
|type|null|
|brand|VISA|
|brand|MASTERCARD|
|brand|DISCOVER|
|brand|AMEX|
|brand|SOLO|
|brand|JCB|
|brand|STAR|
|brand|DELTA|
|brand|SWITCH|
|brand|MAESTRO|
|brand|CB_NATIONALE|
|brand|CONFIGOGA|
|brand|CONFIDIS|
|brand|ELECTRON|
|brand|CETELEM|
|brand|CHINA_UNION_PAY|
|brand|DINERS|
|brand|ELO|
|brand|HIPER|
|brand|HIPERCARD|
|brand|RUPAY|
|brand|GE|
|brand|SYNCHRONY|
|brand|EFTPOS|
|brand|UNKNOWN|
|brand|null|
SysDictType
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"dictId": 0,
"dictName": "string",
"dictType": "string",
"status": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|dictId|integer(int64)|false|none||none|
|dictName|string|true|none||none|
|dictType|string|true|none||none|
|status|string|false|none||none|
RLoginUserUUser
```json
{
"code": 0,
"msg": "string",
"data": {
"token": "string",
"userid": 0,
"username": "string",
"loginTime": 0,
"expireTime": 0,
"ipaddr": "string",
"permissions": [
"string"
],
"roles": [
"string"
],
"user": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"birthDate": "2019-08-24T14:15:22Z",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
null
],
"deptIds": [
null
],
"permissions": [
null
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"kycStatus": "string",
"admin": true
},
"wanFiRedirectParams": {
"clientMac": "string",
"clientIp": "string",
"t": 0,
"site": "string",
"redirectUrl": "string",
"apMac": "string",
"ssidName": "string",
"radioId": 0
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[LoginUserUUser
](#schemaloginuseruuser)|false|none||none|
GooglePayWalletResponse
```json
{
"name": "string",
"email_address": "string",
"phone_number": {
"country_code": "string",
"national_number": "string"
},
"card": {
"name": "string",
"last_digits": "string",
"type": "CREDIT",
"brand": "VISA",
"billing_address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|email_address|string|false|none||none|
|phone_number|[PhoneNumberWithCountryCode
](#schemaphonenumberwithcountrycode)|false|none||none|
|card|[GooglePayCardResponse
](#schemagooglepaycardresponse)|false|none||none|
SysDictData
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"dictCode": 0,
"dictSort": 0,
"dictLabel": "string",
"dictValue": "string",
"dictType": "string",
"cssClass": "string",
"listClass": "string",
"isDefault": "string",
"status": "string",
"default": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|dictCode|integer(int64)|false|none||none|
|dictSort|integer(int64)|false|none||none|
|dictLabel|string|true|none||none|
|dictValue|string|true|none||none|
|dictType|string|true|none||none|
|cssClass|string|false|none||none|
|listClass|string|false|none||none|
|isDefault|string|false|none||none|
|status|string|false|none||none|
|default|boolean|false|none||none|
IdealPaymentObject
```json
{
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|country_code|string|false|none||none|
|bic|string|false|none||none|
|iban_last_chars|string|false|none||none|
SysDevice
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"siteId": "string",
"mac": "string",
"name": "string",
"type": "string",
"subtype": "string",
"deviceSeriesType": "string",
"model": "string",
"ip": "string",
"ipv6s": "string",
"uptime": "string",
"status": 0,
"lastSeen": 0,
"cpuUtil": 0,
"memUtil": 0,
"sn": "string",
"licenseStatus": 0,
"tagName": "string",
"uplinkDeviceMac": "string",
"uplinkDeviceName": "string",
"uplinkDevicePort": "string",
"linkSpeed": 0,
"duplex": 0,
"switchConsistent": true,
"publicIp": "string",
"firmwareVersion": "string"
}
```
客户平台-设备表
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|integer(int64)|false|none||none|
|delFlag|boolean|false|none||none|
|createBy|integer(int64)|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|integer(int64)|false|none||none|
|updateTime|string(date-time)|false|none||none|
|siteId|string|false|none||siteId|
|mac|string|false|none||mac|
|name|string|false|none||name|
|type|string|false|none||type|
|subtype|string|false|none||subtype|
|deviceSeriesType|string|false|none||deviceSeriesType|
|model|string|false|none||model|
|ip|string|false|none||ip|
|ipv6s|string|false|none||ipv6s|
|uptime|string|false|none||uptime|
|status|integer(int32)|false|none||status|
|lastSeen|integer(int64)|false|none||lastSeen|
|cpuUtil|integer(int32)|false|none||cpuUtil|
|memUtil|integer(int32)|false|none||memUtil|
|sn|string|false|none||sn|
|licenseStatus|integer(int32)|false|none||licenseStatus|
|tagName|string|false|none||tagName|
|uplinkDeviceMac|string|false|none||uplinkDeviceMac|
|uplinkDeviceName|string|false|none||uplink_device_name|
|uplinkDevicePort|string|false|none||uplinkDevicePort|
|linkSpeed|integer(int32)|false|none||linkSpeed|
|duplex|integer(int32)|false|none||duplex|
|switchConsistent|boolean|false|none||switchConsistent|
|publicIp|string|false|none||publicIp|
|firmwareVersion|string|false|none||firmwareVersion|
Item
```json
{
"name": "string",
"unit_amount": {
"currency_code": "string",
"value": "string"
},
"tax": {
"currency_code": "string",
"value": "string"
},
"quantity": "string",
"description": "string",
"sku": "string",
"url": "string",
"category": "DIGITAL_GOODS",
"image_url": "string",
"upc": {
"type": "UPC-A",
"code": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|unit_amount|[Money
](#schemamoney)|false|none||none|
|tax|[Money
](#schemamoney)|false|none||none|
|quantity|string|false|none||none|
|description|string|false|none||none|
|sku|string|false|none||none|
|url|string|false|none||none|
|category|string|false|none||none|
|image_url|string|false|none||none|
|upc|[UniversalProductCode
](#schemauniversalproductcode)|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|category|DIGITAL_GOODS|
|category|PHYSICAL_GOODS|
|category|DONATION|
|category|null|
SysConfig
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"configId": 0,
"configName": "string",
"configKey": "string",
"configValue": "string",
"configType": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|configId|integer(int64)|false|none||none|
|configName|string|true|none||none|
|configKey|string|true|none||none|
|configValue|string|true|none||none|
|configType|string|false|none||none|
RUPayConfigBo
```json
{
"code": 0,
"msg": "string",
"data": {
"currency": "string",
"currencySymbol": "string",
"paymentMethods": [
"string"
]
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[UPayConfigBo
](#schemaupayconfigbo)|false|none||none|
JsonNode
```json
{}
```
### 属性
*None*
SysPayConfigBo
```json
{
"currency": "string",
"currencySymbol": "string",
"paymentMethods": [
"string"
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|currency|string|false|none||none|
|currencySymbol|string|false|none||none|
|paymentMethods|[string
]|false|none||none|
UPayConfigBo
```json
{
"currency": "string",
"currencySymbol": "string",
"paymentMethods": [
"string"
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|currency|string|false|none||none|
|currencySymbol|string|false|none||none|
|paymentMethods|[string
]|false|none||none|
Level2CardProcessingData
```json
{
"invoice_id": "string",
"tax_total": {
"currency_code": "string",
"value": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|invoice_id|string|false|none||none|
|tax_total|[Money
](#schemamoney)|false|none||none|
UBillRule
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"price": 0,
"traffic": 0,
"unit": 0,
"enable": true
}
```
用户平台-计费规则表
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|integer(int64)|false|none||none|
|delFlag|boolean|false|none||none|
|createBy|integer(int64)|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|integer(int64)|false|none||none|
|updateTime|string(date-time)|false|none||none|
|price|number|false|none||价格|
|traffic|integer(int64)|false|none||流量|
|unit|integer(int32)|false|none||单位|
|enable|boolean|false|none||是否启用|
UUCdrHistoryUserBo
```json
{
"userId": 0,
"userName": "string",
"clientName": "string",
"clientMac": "string",
"startTimeS": 0,
"startTimeE": 0,
"endTimeS": 0,
"endTimeE": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|userId|integer(int64)|false|none||none|
|userName|string|false|none||none|
|clientName|string|false|none||none|
|clientMac|string|false|none||none|
|startTimeS|integer(int64)|false|none||none|
|startTimeE|integer(int64)|false|none||none|
|endTimeS|integer(int64)|false|none||none|
|endTimeE|integer(int64)|false|none||none|
Level3CardProcessingData
```json
{
"shipping_amount": {
"currency_code": "string",
"value": "string"
},
"duty_amount": {
"currency_code": "string",
"value": "string"
},
"discount_amount": {
"currency_code": "string",
"value": "string"
},
"shipping_address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"ships_from_postal_code": "string",
"line_items": [
{
"name": "string",
"quantity": "string",
"description": "string",
"sku": "string",
"url": "string",
"image_url": "string",
"upc": {
"type": "UPC-A",
"code": "string"
},
"unit_amount": {
"currency_code": "string",
"value": "string"
},
"tax": {
"currency_code": "string",
"value": "string"
},
"commodity_code": "string",
"discount_amount": {
"currency_code": "string",
"value": "string"
},
"total_amount": {
"currency_code": "string",
"value": "string"
},
"unit_of_measure": "string"
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|shipping_amount|[Money
](#schemamoney)|false|none||none|
|duty_amount|[Money
](#schemamoney)|false|none||none|
|discount_amount|[Money
](#schemamoney)|false|none||none|
|shipping_address|[Address
](#schemaaddress)|false|none||none|
|ships_from_postal_code|string|false|none||none|
|line_items|[
[LineItem
](#schemalineitem)
]|false|none||none|
CreateSsidOpenApiVo
```json
{
"name": "string",
"deviceType": 0,
"band": 0,
"guestNetEnable": true,
"security": 0,
"broadcast": true,
"vlanEnable": true,
"vlanId": 0,
"pskSetting": {},
"entSetting": {},
"ppskSetting": {},
"mloEnable": true,
"pmfMode": 0,
"enable11r": true,
"hidePwd": true,
"greEnable": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|true|none||none|
|deviceType|integer(int32)|true|none||none|
|band|integer(int32)|true|none||none|
|guestNetEnable|boolean|true|none||none|
|security|integer(int32)|true|none||none|
|broadcast|boolean|true|none||none|
|vlanEnable|boolean|true|none||none|
|vlanId|integer(int32)|false|none||none|
|pskSetting|object|false|none||none|
|entSetting|object|false|none||none|
|ppskSetting|object|false|none||none|
|mloEnable|boolean|true|none||none|
|pmfMode|integer(int32)|true|none||none|
|enable11r|boolean|true|none||none|
|hidePwd|boolean|true|none||none|
|greEnable|boolean|false|none||none|
UCdrClientBo
```json
{
"clientName": "string",
"clientMac": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|clientName|string|false|none||none|
|clientMac|string|false|none||none|
LineItem
```json
{
"name": "string",
"quantity": "string",
"description": "string",
"sku": "string",
"url": "string",
"image_url": "string",
"upc": {
"type": "UPC-A",
"code": "string"
},
"unit_amount": {
"currency_code": "string",
"value": "string"
},
"tax": {
"currency_code": "string",
"value": "string"
},
"commodity_code": "string",
"discount_amount": {
"currency_code": "string",
"value": "string"
},
"total_amount": {
"currency_code": "string",
"value": "string"
},
"unit_of_measure": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|quantity|string|false|none||none|
|description|string|false|none||none|
|sku|string|false|none||none|
|url|string|false|none||none|
|image_url|string|false|none||none|
|upc|[UniversalProductCode
](#schemauniversalproductcode)|false|none||none|
|unit_amount|[Money
](#schemamoney)|false|none||none|
|tax|[Money
](#schemamoney)|false|none||none|
|commodity_code|string|false|none||none|
|discount_amount|[Money
](#schemamoney)|false|none||none|
|total_amount|[Money
](#schemamoney)|false|none||none|
|unit_of_measure|string|false|none||none|
UserRepeatQuery
```json
{
"userName": "string",
"email": "string",
"phonenumber": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|userName|string|false|none||none|
|email|string|false|none||none|
|phonenumber|string|false|none||none|
RUCdrUserVo
```json
{
"code": 0,
"msg": "string",
"data": {
"id": 0,
"startTime": 0,
"endTime": 0,
"duration": 0,
"trafficDown": 0,
"trafficUp": 0,
"activity": 0
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[UCdrUserVo
](#schemaucdruservo)|false|none||none|
LinkDescription
```json
{
"href": "string",
"rel": "string",
"method": "GET"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|href|string|false|none||none|
|rel|string|false|none||none|
|method|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|method|GET|
|method|POST|
|method|PUT|
|method|DELETE|
|method|HEAD|
|method|CONNECT|
|method|OPTIONS|
|method|PATCH|
|method|null|
CreateSiteEntity
```json
{
"name": "string",
"type": 0,
"region": "string",
"timeZone": "string",
"scenario": "string",
"tagIds": [
"string"
],
"longitude": 0.1,
"latitude": 0.1,
"address": "string",
"deviceAccountSetting": {
"username": "string",
"password": "string"
},
"supportES": true,
"supportL2": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|true|none||none|
|type|integer(int32)|false|none||none|
|region|string|true|none||none|
|timeZone|string|true|none||none|
|scenario|string|true|none||none|
|tagIds|[string
]|false|none||none|
|longitude|number(double)|false|none||none|
|latitude|number(double)|false|none||none|
|address|string|false|none||none|
|deviceAccountSetting|[DeviceAccountSettingOpenApiVo
](#schemadeviceaccountsettingopenapivo)|true|none||none|
|supportES|boolean|false|none||none|
|supportL2|boolean|false|none||none|
UCdrUserVo
```json
{
"id": 0,
"startTime": 0,
"endTime": 0,
"duration": 0,
"trafficDown": 0,
"trafficUp": 0,
"activity": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|integer(int64)|false|none||none|
|startTime|integer(int64)|false|none||none|
|endTime|integer(int64)|false|none||none|
|duration|integer(int64)|false|none||none|
|trafficDown|integer(int64)|false|none||none|
|trafficUp|integer(int64)|false|none||none|
|activity|integer(int64)|false|none||none|
Money
```json
{
"currency_code": "string",
"value": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|currency_code|string|false|none||none|
|value|string|false|none||none|
DeviceAccountSettingOpenApiVo
```json
{
"username": "string",
"password": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|username|string|true|none||none|
|password|string|true|none||none|
MybankPaymentObject
```json
{
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|country_code|string|false|none||none|
|bic|string|false|none||none|
|iban_last_chars|string|false|none||none|
RoamingOpenApiVo
```json
{
"fastRoamingEnable": true,
"aiRoamingEnable": true,
"dualBand11kReportEnable": true,
"forceDisassociationEnable": true,
"nonStickRoamingEnable": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|fastRoamingEnable|boolean|true|none||none|
|aiRoamingEnable|boolean|true|none||none|
|dualBand11kReportEnable|boolean|false|none||none|
|forceDisassociationEnable|boolean|false|none||none|
|nonStickRoamingEnable|boolean|false|none||none|
Name
```json
{
"given_name": "string",
"surname": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|given_name|string|false|none||none|
|surname|string|false|none||none|
SiteRoamingSetting
```json
{
"roaming": {
"fastRoamingEnable": true,
"aiRoamingEnable": true,
"dualBand11kReportEnable": true,
"forceDisassociationEnable": true,
"nonStickRoamingEnable": true
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|roaming|[RoamingOpenApiVo
](#schemaroamingopenapivo)|true|none||none|
NetAmountBreakdownItem
```json
{
"payable_amount": {
"currency_code": "string",
"value": "string"
},
"converted_amount": {
"currency_code": "string",
"value": "string"
},
"exchange_rate": {
"source_currency": "string",
"target_currency": "string",
"value": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|payable_amount|[Money
](#schemamoney)|false|none||none|
|converted_amount|[Money
](#schemamoney)|false|none||none|
|exchange_rate|[ExchangeRate
](#schemaexchangerate)|false|none||none|
MeshSettingVo
```json
{
"meshEnable": true,
"autoFailoverEnable": true,
"defGatewayEnable": true,
"gateway": "string",
"fullSector": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|meshEnable|boolean|true|none||none|
|autoFailoverEnable|boolean|false|none||none|
|defGatewayEnable|boolean|false|none||none|
|gateway|string|false|none||none|
|fullSector|boolean|false|none||none|
NetworkTransactionReference
```json
{
"id": "string",
"date": "string",
"network": "VISA",
"acquirer_reference_number": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|string|false|none||none|
|date|string|false|none||none|
|network|string|false|none||none|
|acquirer_reference_number|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|network|VISA|
|network|MASTERCARD|
|network|DISCOVER|
|network|AMEX|
|network|SOLO|
|network|JCB|
|network|STAR|
|network|DELTA|
|network|SWITCH|
|network|MAESTRO|
|network|CB_NATIONALE|
|network|CONFIGOGA|
|network|CONFIDIS|
|network|ELECTRON|
|network|CETELEM|
|network|CHINA_UNION_PAY|
|network|DINERS|
|network|ELO|
|network|HIPER|
|network|HIPERCARD|
|network|RUPAY|
|network|GE|
|network|SYNCHRONY|
|network|EFTPOS|
|network|UNKNOWN|
|network|null|
SiteMeshSetting
```json
{
"mesh": {
"meshEnable": true,
"autoFailoverEnable": true,
"defGatewayEnable": true,
"gateway": "string",
"fullSector": true
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|mesh|[MeshSettingVo
](#schemameshsettingvo)|false|none||none|
Order
```json
{
"create_time": "string",
"update_time": "string",
"id": "string",
"payment_source": {
"card": {
"name": "string",
"last_digits": "string",
"brand": "VISA",
"available_networks": [
"VISA"
],
"type": "CREDIT",
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": null,
"enrollment_status": null
}
},
"attributes": {
"vault": {
"id": null,
"status": null,
"links": null,
"customer": null
}
},
"from_request": {
"expiry": "string",
"last_digits": "string"
},
"expiry": "string",
"bin_details": {
"bin": "string",
"issuing_bank": "string",
"bin_country_code": "string",
"products": [
"string"
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "FIRST",
"previous_network_transaction_reference": {
"id": null,
"date": null,
"network": null,
"acquirer_reference_number": null
}
}
},
"paypal": {
"email_address": "string",
"account_id": "string",
"account_status": "VERIFIED",
"name": {
"given_name": "string",
"surname": "string"
},
"phone_type": "FAX",
"phone_number": {
"national_number": "string"
},
"birth_date": "string",
"business_name": "string",
"tax_info": {
"tax_id": "string",
"tax_id_type": "BR_CPF"
},
"address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"attributes": {
"vault": {
"id": null,
"status": null,
"links": null,
"customer": null
},
"cobranded_cards": [
{}
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"charge_pattern": "IMMEDIATE",
"usage_pattern": "IMMEDIATE",
"usage": "FIRST"
}
},
"bancontact": {
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string",
"card_last_digits": "string"
},
"blik": {
"name": "string",
"country_code": "string",
"email": "string",
"one_click": {
"consumer_reference": "string"
}
},
"eps": {
"name": "string",
"country_code": "string",
"bic": "string"
},
"giropay": {
"name": "string",
"country_code": "string",
"bic": "string"
},
"ideal": {
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string"
},
"mybank": {
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string"
},
"p24": {
"name": "string",
"email": "string",
"country_code": "string",
"payment_descriptor": "string",
"method_id": "string",
"method_description": "string"
},
"sofort": {
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string"
},
"trustly": {
"name": "string",
"country_code": "string",
"email": "string",
"bic": "string",
"iban_last_chars": "string"
},
"apple_pay": {
"id": "string",
"token": "string",
"name": "string",
"email_address": "string",
"phone_number": {
"national_number": "string"
},
"card": {
"name": "string",
"last_digits": "string",
"brand": "VISA",
"available_networks": [
"["
],
"type": "CREDIT",
"authentication_result": {
"liability_shift": null,
"three_d_secure": null
},
"attributes": {
"vault": null
},
"from_request": {
"expiry": null,
"last_digits": null
},
"expiry": "string",
"bin_details": {
"bin": null,
"issuing_bank": null,
"bin_country_code": null,
"products": null
},
"stored_credential": {
"payment_initiator": null,
"payment_type": null,
"usage": null,
"previous_network_transaction_reference": null
},
"billing_address": {
"address_line_1": null,
"address_line_2": null,
"admin_area_2": null,
"admin_area_1": null,
"postal_code": null,
"country_code": null
},
"country_code": "string"
},
"attributes": {
"vault": {
"id": null,
"status": null,
"customer": null,
"links": null
}
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "FIRST",
"previous_network_transaction_reference": {
"id": null,
"date": null,
"network": null,
"acquirer_reference_number": null
}
}
},
"google_pay": {
"name": "string",
"email_address": "string",
"phone_number": {
"country_code": "string",
"national_number": "string"
},
"card": {
"name": "string",
"last_digits": "string",
"type": "CREDIT",
"brand": "VISA",
"billing_address": {
"address_line_1": null,
"address_line_2": null,
"admin_area_2": null,
"admin_area_1": null,
"postal_code": null,
"country_code": null
},
"authentication_result": {
"liability_shift": null,
"three_d_secure": null
}
}
},
"venmo": {
"email_address": "string",
"account_id": "string",
"user_name": "string",
"name": {
"given_name": "string",
"surname": "string"
},
"phone_number": {
"national_number": "string"
},
"address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"attributes": {
"vault": {
"id": null,
"status": null,
"customer": null,
"links": null
}
}
}
},
"intent": "CAPTURE",
"payer": {
"email_address": "string",
"payer_id": "string",
"name": {
"given_name": "string",
"surname": "string"
},
"phone": {
"phone_type": "FAX",
"phone_number": {
"national_number": "string"
}
},
"birth_date": "string",
"tax_info": {
"tax_id": "string",
"tax_id_type": "BR_CPF"
},
"address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
}
},
"purchase_units": [
{
"reference_id": "string",
"amount": {
"currency_code": "string",
"value": "string",
"breakdown": {
"item_total": {},
"shipping": {},
"handling": {},
"tax_total": {},
"insurance": {},
"shipping_discount": {},
"discount": {}
}
},
"payee": {
"email_address": "string",
"merchant_id": "string"
},
"payment_instruction": {
"platform_fees": [
{
"amount": null,
"payee": null
}
],
"disbursement_mode": "INSTANT",
"payee_pricing_tier_id": "string",
"payee_receivable_fx_rate_id": "string"
},
"description": "string",
"custom_id": "string",
"invoice_id": "string",
"id": "string",
"soft_descriptor": "string",
"items": [
{
"name": "string",
"unit_amount": {
"currency_code": null,
"value": null
},
"tax": {
"currency_code": null,
"value": null
},
"quantity": "string",
"description": "string",
"sku": "string",
"url": "string",
"category": "DIGITAL_GOODS",
"image_url": "string",
"upc": {
"type": null,
"code": null
}
}
],
"shipping": {
"name": {
"full_name": "string"
},
"email_address": "string",
"phone_number": {
"country_code": "string",
"national_number": "string"
},
"type": "SHIPPING",
"options": [
{
"id": null,
"label": null,
"type": null,
"amount": null,
"selected": null
}
],
"address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"trackers": [
{
"id": null,
"status": null,
"items": null,
"links": null,
"create_time": null,
"update_time": null
}
]
},
"supplementary_data": {
"card": {
"level_2": {},
"level_3": {}
},
"risk": {
"customer": {}
}
},
"payments": {
"authorizations": [
{
"status": null,
"status_details": null,
"id": null,
"amount": null,
"invoice_id": null,
"custom_id": null,
"network_transaction_reference": null,
"seller_protection": null,
"expiration_time": null,
"links": null,
"create_time": null,
"update_time": null,
"processor_response": null
}
],
"captures": [
{
"status": null,
"status_details": null,
"id": null,
"amount": null,
"invoice_id": null,
"custom_id": null,
"network_transaction_reference": null,
"seller_protection": null,
"final_capture": null,
"seller_receivable_breakdown": null,
"disbursement_mode": null,
"links": null,
"processor_response": null,
"create_time": null,
"update_time": null
}
],
"refunds": [
{
"status": null,
"status_details": null,
"id": null,
"amount": null,
"invoice_id": null,
"custom_id": null,
"acquirer_reference_number": null,
"note_to_payer": null,
"seller_payable_breakdown": null,
"payer": null,
"links": null,
"create_time": null,
"update_time": null
}
]
},
"most_recent_errors": [
{}
]
}
],
"status": "CREATED",
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|create_time|string|false|none||none|
|update_time|string|false|none||none|
|id|string|false|none||none|
|payment_source|[PaymentSourceResponse
](#schemapaymentsourceresponse)|false|none||none|
|intent|string|false|none||none|
|payer|[Payer
](#schemapayer)|false|none||none|
|purchase_units|[
[PurchaseUnit
](#schemapurchaseunit)
]|false|none||none|
|status|string|false|none||none|
|links|[
[LinkDescription
](#schemalinkdescription)
]|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|intent|CAPTURE|
|intent|AUTHORIZE|
|intent|null|
|status|CREATED|
|status|SAVED|
|status|APPROVED|
|status|VOIDED|
|status|COMPLETED|
|status|PAYER_ACTION_REQUIRED|
|status|null|
SysOperLog
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"operId": 0,
"title": "string",
"businessType": 0,
"businessTypes": [
0
],
"method": "string",
"requestMethod": "string",
"operatorType": 0,
"operName": "string",
"deptName": "string",
"operUrl": "string",
"operIp": "string",
"operParam": "string",
"jsonResult": "string",
"status": 0,
"errorMsg": "string",
"operTime": "2019-08-24T14:15:22Z",
"costTime": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|operId|integer(int64)|false|none||none|
|title|string|false|none||none|
|businessType|integer(int32)|false|none||none|
|businessTypes|[integer
]|false|none||none|
|method|string|false|none||none|
|requestMethod|string|false|none||none|
|operatorType|integer(int32)|false|none||none|
|operName|string|false|none||none|
|deptName|string|false|none||none|
|operUrl|string|false|none||none|
|operIp|string|false|none||none|
|operParam|string|false|none||none|
|jsonResult|string|false|none||none|
|status|integer(int32)|false|none||none|
|errorMsg|string|false|none||none|
|operTime|string(date-time)|false|none||none|
|costTime|integer(int64)|false|none||none|
OrderTrackerItem
```json
{
"name": "string",
"quantity": "string",
"sku": "string",
"url": "string",
"image_url": "string",
"upc": {
"type": "UPC-A",
"code": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|quantity|string|false|none||none|
|sku|string|false|none||none|
|url|string|false|none||none|
|image_url|string|false|none||none|
|upc|[UniversalProductCode
](#schemauniversalproductcode)|false|none||none|
SysLogininfor
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"infoId": 0,
"userName": "string",
"status": "string",
"ipaddr": "string",
"msg": "string",
"accessTime": "2019-08-24T14:15:22Z"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|infoId|integer(int64)|false|none||none|
|userName|string|false|none||none|
|status|string|false|none||none|
|ipaddr|string|false|none||none|
|msg|string|false|none||none|
|accessTime|string(date-time)|false|none||none|
OrderTrackerResponse
```json
{
"id": "string",
"status": "CANCELLED",
"items": [
{
"name": "string",
"quantity": "string",
"sku": "string",
"url": "string",
"image_url": "string",
"upc": {
"type": "UPC-A",
"code": "string"
}
}
],
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
],
"create_time": "string",
"update_time": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|string|false|none||none|
|status|string|false|none||none|
|items|[
[OrderTrackerItem
](#schemaordertrackeritem)
]|false|none||none|
|links|[
[LinkDescription
](#schemalinkdescription)
]|false|none||none|
|create_time|string|false|none||none|
|update_time|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|status|CANCELLED|
|status|SHIPPED|
|status|null|
ResolveSiteLogListOpenApiVo
```json
{
"logs": [
"string"
],
"selectType": "string",
"startTime": 0,
"endTime": 0,
"filterModule": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|logs|[string
]|false|none||none|
|selectType|string|true|none||none|
|startTime|integer(int64)|true|none||none|
|endTime|integer(int64)|true|none||none|
|filterModule|string|false|none||none|
OrdersCapture
```json
{
"status": "COMPLETED",
"status_details": {
"reason": "BUYER_COMPLAINT"
},
"id": "string",
"amount": {
"currency_code": "string",
"value": "string"
},
"invoice_id": "string",
"custom_id": "string",
"network_transaction_reference": {
"id": "string",
"date": "string",
"network": "VISA",
"acquirer_reference_number": "string"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED"
]
},
"final_capture": true,
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "string",
"value": "string"
},
"paypal_fee": {
"currency_code": "string",
"value": "string"
},
"paypal_fee_in_receivable_currency": {
"currency_code": "string",
"value": "string"
},
"net_amount": {
"currency_code": "string",
"value": "string"
},
"receivable_amount": {
"currency_code": "string",
"value": "string"
},
"exchange_rate": {
"source_currency": "string",
"target_currency": "string",
"value": "string"
},
"platform_fees": [
{
"amount": {
"currency_code": "string",
"value": "string"
},
"payee": {
"email_address": "string",
"merchant_id": "string"
}
}
]
},
"disbursement_mode": "INSTANT",
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
],
"processor_response": {
"avs_code": "A",
"cvv_code": "E",
"response_code": "0000",
"payment_advice_code": "01"
},
"create_time": "string",
"update_time": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|status|string|false|none||none|
|status_details|[CaptureStatusDetails
](#schemacapturestatusdetails)|false|none||none|
|id|string|false|none||none|
|amount|[Money
](#schemamoney)|false|none||none|
|invoice_id|string|false|none||none|
|custom_id|string|false|none||none|
|network_transaction_reference|[NetworkTransactionReference
](#schemanetworktransactionreference)|false|none||none|
|seller_protection|[SellerProtection
](#schemasellerprotection)|false|none||none|
|final_capture|boolean|false|none||none|
|seller_receivable_breakdown|[SellerReceivableBreakdown
](#schemasellerreceivablebreakdown)|false|none||none|
|disbursement_mode|string|false|none||none|
|links|[
[LinkDescription
](#schemalinkdescription)
]|false|none||none|
|processor_response|[ProcessorResponse
](#schemaprocessorresponse)|false|none||none|
|create_time|string|false|none||none|
|update_time|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|status|COMPLETED|
|status|DECLINED|
|status|PARTIALLY_REFUNDED|
|status|PENDING|
|status|REFUNDED|
|status|FAILED|
|status|null|
|disbursement_mode|INSTANT|
|disbursement_mode|DELAYED|
|disbursement_mode|null|
ApGeneralConfig
```json
{
"name": "string",
"ledSetting": 0,
"tagIds": [
"string"
],
"location": {
"longitude": 0.1,
"latitude": 0.1,
"address": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|ledSetting|integer(int32)|false|none||none|
|tagIds|[string
]|false|none||none|
|location|[DeviceLocationDetailVo
](#schemadevicelocationdetailvo)|false|none||none|
P24PaymentObject
```json
{
"name": "string",
"email": "string",
"country_code": "string",
"payment_descriptor": "string",
"method_id": "string",
"method_description": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|email|string|false|none||none|
|country_code|string|false|none||none|
|payment_descriptor|string|false|none||none|
|method_id|string|false|none||none|
|method_description|string|false|none||none|
DeviceLocationDetailVo
```json
{
"longitude": 0.1,
"latitude": 0.1,
"address": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|longitude|number(double)|false|none||none|
|latitude|number(double)|false|none||none|
|address|string|false|none||none|
```json
{
"ip_address": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|ip_address|string|false|none||none|
RString
```json
{
"code": 0,
"msg": "string",
"data": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|string|false|none||none|
PayeeBase
```json
{
"email_address": "string",
"merchant_id": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|email_address|string|false|none||none|
|merchant_id|string|false|none||none|
AdoptDeviceRequest
```json
{
"username": "string",
"password": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|username|string|false|none||none|
|password|string|false|none||none|
Payer
```json
{
"email_address": "string",
"payer_id": "string",
"name": {
"given_name": "string",
"surname": "string"
},
"phone": {
"phone_type": "FAX",
"phone_number": {
"national_number": "string"
}
},
"birth_date": "string",
"tax_info": {
"tax_id": "string",
"tax_id_type": "BR_CPF"
},
"address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|email_address|string|false|none||none|
|payer_id|string|false|none||none|
|name|[Name
](#schemaname)|false|none||none|
|phone|[PhoneWithType
](#schemaphonewithtype)|false|none||none|
|birth_date|string|false|none||none|
|tax_info|[TaxInfo
](#schemataxinfo)|false|none||none|
|address|[Address
](#schemaaddress)|false|none||none|
RApGeneralConfig
```json
{
"code": 0,
"msg": "string",
"data": {
"name": "string",
"ledSetting": 0,
"tagIds": [
"string"
],
"location": {
"longitude": 0.1,
"latitude": 0.1,
"address": "string"
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[ApGeneralConfig
](#schemaapgeneralconfig)|false|none||none|
PaymentCollection
```json
{
"authorizations": [
{
"status": "CREATED",
"status_details": {
"reason": "PENDING_REVIEW"
},
"id": "string",
"amount": {
"currency_code": "string",
"value": "string"
},
"invoice_id": "string",
"custom_id": "string",
"network_transaction_reference": {
"id": "string",
"date": "string",
"network": "VISA",
"acquirer_reference_number": "string"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED"
]
},
"expiration_time": "string",
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
],
"create_time": "string",
"update_time": "string",
"processor_response": {
"avs_code": "A",
"cvv_code": "E",
"response_code": "0000",
"payment_advice_code": "01"
}
}
],
"captures": [
{
"status": "COMPLETED",
"status_details": {
"reason": "BUYER_COMPLAINT"
},
"id": "string",
"amount": {
"currency_code": "string",
"value": "string"
},
"invoice_id": "string",
"custom_id": "string",
"network_transaction_reference": {
"id": "string",
"date": "string",
"network": "VISA",
"acquirer_reference_number": "string"
},
"seller_protection": {
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED"
]
},
"final_capture": true,
"seller_receivable_breakdown": {
"gross_amount": {
"currency_code": "string",
"value": "string"
},
"paypal_fee": {
"currency_code": "string",
"value": "string"
},
"paypal_fee_in_receivable_currency": {
"currency_code": "string",
"value": "string"
},
"net_amount": {
"currency_code": "string",
"value": "string"
},
"receivable_amount": {
"currency_code": "string",
"value": "string"
},
"exchange_rate": {
"source_currency": "string",
"target_currency": "string",
"value": "string"
},
"platform_fees": [
{
"amount": null,
"payee": null
}
]
},
"disbursement_mode": "INSTANT",
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
],
"processor_response": {
"avs_code": "A",
"cvv_code": "E",
"response_code": "0000",
"payment_advice_code": "01"
},
"create_time": "string",
"update_time": "string"
}
],
"refunds": [
{
"status": "CANCELLED",
"status_details": {
"reason": "ECHECK"
},
"id": "string",
"amount": {
"currency_code": "string",
"value": "string"
},
"invoice_id": "string",
"custom_id": "string",
"acquirer_reference_number": "string",
"note_to_payer": "string",
"seller_payable_breakdown": {
"gross_amount": {
"currency_code": "string",
"value": "string"
},
"paypal_fee": {
"currency_code": "string",
"value": "string"
},
"paypal_fee_in_receivable_currency": {
"currency_code": "string",
"value": "string"
},
"net_amount": {
"currency_code": "string",
"value": "string"
},
"net_amount_in_receivable_currency": {
"currency_code": "string",
"value": "string"
},
"platform_fees": [
{
"amount": null,
"payee": null
}
],
"net_amount_breakdown": [
{
"payable_amount": null,
"converted_amount": null,
"exchange_rate": null
}
],
"total_refunded_amount": {
"currency_code": "string",
"value": "string"
}
},
"payer": {
"email_address": "string",
"merchant_id": "string"
},
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
],
"create_time": "string",
"update_time": "string"
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|authorizations|[
[AuthorizationWithAdditionalData
](#schemaauthorizationwithadditionaldata)
]|false|none||none|
|captures|[
[OrdersCapture
](#schemaorderscapture)
]|false|none||none|
|refunds|[
[Refund
](#schemarefund)
]|false|none||none|
AddDeviceBySnOpenApiVo
```json
{
"sn": "string",
"name": "string",
"username": "string",
"password": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|sn|string|false|none||none|
|name|string|false|none||none|
|username|string|false|none||none|
|password|string|false|none||none|
PaymentInstruction
```json
{
"platform_fees": [
{
"amount": {
"currency_code": "string",
"value": "string"
},
"payee": {
"email_address": "string",
"merchant_id": "string"
}
}
],
"disbursement_mode": "INSTANT",
"payee_pricing_tier_id": "string",
"payee_receivable_fx_rate_id": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|platform_fees|[
[PlatformFee
](#schemaplatformfee)
]|false|none||none|
|disbursement_mode|string|false|none||none|
|payee_pricing_tier_id|string|false|none||none|
|payee_receivable_fx_rate_id|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|disbursement_mode|INSTANT|
|disbursement_mode|DELAYED|
|disbursement_mode|null|
DeviceListAddBySnOpenApiVo
```json
{
"devices": [
{
"sn": "string",
"name": "string",
"username": "string",
"password": "string"
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|devices|[
[AddDeviceBySnOpenApiVo
](#schemaadddevicebysnopenapivo)
]|true|none||none|
PaymentSourceResponse
```json
{
"card": {
"name": "string",
"last_digits": "string",
"brand": "VISA",
"available_networks": [
"VISA"
],
"type": "CREDIT",
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": "Y",
"enrollment_status": "Y"
}
},
"attributes": {
"vault": {
"id": "string",
"status": "VAULTED",
"links": [
{}
],
"customer": {
"id": null,
"email_address": null,
"phone": null,
"merchant_customer_id": null
}
}
},
"from_request": {
"expiry": "string",
"last_digits": "string"
},
"expiry": "string",
"bin_details": {
"bin": "string",
"issuing_bank": "string",
"bin_country_code": "string",
"products": [
"string"
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "FIRST",
"previous_network_transaction_reference": {
"id": "string",
"date": "string",
"network": "VISA",
"acquirer_reference_number": "string"
}
}
},
"paypal": {
"email_address": "string",
"account_id": "string",
"account_status": "VERIFIED",
"name": {
"given_name": "string",
"surname": "string"
},
"phone_type": "FAX",
"phone_number": {
"national_number": "string"
},
"birth_date": "string",
"business_name": "string",
"tax_info": {
"tax_id": "string",
"tax_id_type": "BR_CPF"
},
"address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"attributes": {
"vault": {
"id": "string",
"status": "VAULTED",
"links": [
{}
],
"customer": {
"id": null,
"email_address": null,
"phone": null,
"merchant_customer_id": null
}
},
"cobranded_cards": [
{
"labels": [
null
],
"payee": {},
"amount": {}
}
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"charge_pattern": "IMMEDIATE",
"usage_pattern": "IMMEDIATE",
"usage": "FIRST"
}
},
"bancontact": {
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string",
"card_last_digits": "string"
},
"blik": {
"name": "string",
"country_code": "string",
"email": "string",
"one_click": {
"consumer_reference": "string"
}
},
"eps": {
"name": "string",
"country_code": "string",
"bic": "string"
},
"giropay": {
"name": "string",
"country_code": "string",
"bic": "string"
},
"ideal": {
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string"
},
"mybank": {
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string"
},
"p24": {
"name": "string",
"email": "string",
"country_code": "string",
"payment_descriptor": "string",
"method_id": "string",
"method_description": "string"
},
"sofort": {
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string"
},
"trustly": {
"name": "string",
"country_code": "string",
"email": "string",
"bic": "string",
"iban_last_chars": "string"
},
"apple_pay": {
"id": "string",
"token": "string",
"name": "string",
"email_address": "string",
"phone_number": {
"national_number": "string"
},
"card": {
"name": "string",
"last_digits": "string",
"brand": "VISA",
"available_networks": [
"VISA"
],
"type": "CREDIT",
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": null,
"enrollment_status": null
}
},
"attributes": {
"vault": {
"id": null,
"status": null,
"links": null,
"customer": null
}
},
"from_request": {
"expiry": "string",
"last_digits": "string"
},
"expiry": "string",
"bin_details": {
"bin": "string",
"issuing_bank": "string",
"bin_country_code": "string",
"products": [
"string"
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "FIRST",
"previous_network_transaction_reference": {
"id": null,
"date": null,
"network": null,
"acquirer_reference_number": null
}
},
"billing_address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"country_code": "string"
},
"attributes": {
"vault": {
"id": "string",
"status": "VAULTED",
"customer": {
"id": null
},
"links": [
{}
]
}
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"payment_type": "ONE_TIME",
"usage": "FIRST",
"previous_network_transaction_reference": {
"id": "string",
"date": "string",
"network": "VISA",
"acquirer_reference_number": "string"
}
}
},
"google_pay": {
"name": "string",
"email_address": "string",
"phone_number": {
"country_code": "string",
"national_number": "string"
},
"card": {
"name": "string",
"last_digits": "string",
"type": "CREDIT",
"brand": "VISA",
"billing_address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"authentication_result": {
"liability_shift": "NO",
"three_d_secure": {
"authentication_status": null,
"enrollment_status": null
}
}
}
},
"venmo": {
"email_address": "string",
"account_id": "string",
"user_name": "string",
"name": {
"given_name": "string",
"surname": "string"
},
"phone_number": {
"national_number": "string"
},
"address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"attributes": {
"vault": {
"id": "string",
"status": "VAULTED",
"customer": {
"id": null
},
"links": [
{}
]
}
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|card|[CardResponse
](#schemacardresponse)|false|none||none|
|paypal|[PaypalWalletResponse
](#schemapaypalwalletresponse)|false|none||none|
|bancontact|[BancontactPaymentObject
](#schemabancontactpaymentobject)|false|none||none|
|blik|[BlikPaymentObject
](#schemablikpaymentobject)|false|none||none|
|eps|[EpsPaymentObject
](#schemaepspaymentobject)|false|none||none|
|giropay|[GiropayPaymentObject
](#schemagiropaypaymentobject)|false|none||none|
|ideal|[IdealPaymentObject
](#schemaidealpaymentobject)|false|none||none|
|mybank|[MybankPaymentObject
](#schemamybankpaymentobject)|false|none||none|
|p24|[P24PaymentObject
](#schemap24paymentobject)|false|none||none|
|sofort|[SofortPaymentObject
](#schemasofortpaymentobject)|false|none||none|
|trustly|[TrustlyPaymentObject
](#schematrustlypaymentobject)|false|none||none|
|apple_pay|[ApplePayPaymentObject
](#schemaapplepaypaymentobject)|false|none||none|
|google_pay|[GooglePayWalletResponse
](#schemagooglepaywalletresponse)|false|none||none|
|venmo|[VenmoWalletResponse
](#schemavenmowalletresponse)|false|none||none|
FreeAuthClientPolicyOpenApiVo
```json
{
"idInt": 0,
"type": 0,
"clientIp": "string",
"clientMac": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|idInt|integer(int32)|false|none||none|
|type|integer(int32)|true|none||none|
|clientIp|string|false|none||none|
|clientMac|string|false|none||none|
PaypalWalletAttributesResponse
```json
{
"vault": {
"id": "string",
"status": "VAULTED",
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
],
"customer": {
"id": "string",
"email_address": "string",
"phone": {
"phone_type": "FAX",
"phone_number": {
"national_number": null
}
},
"merchant_customer_id": "string"
}
},
"cobranded_cards": [
{
"labels": [
"string"
],
"payee": {
"email_address": "string",
"merchant_id": "string"
},
"amount": {
"currency_code": "string",
"value": "string"
}
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|vault|[PaypalWalletVaultResponse
](#schemapaypalwalletvaultresponse)|false|none||none|
|cobranded_cards|[
[CobrandedCard
](#schemacobrandedcard)
]|false|none||none|
PortalAccessControlOpenApiVo
```json
{
"preAuthAccessEnable": true,
"preAuthAccessPolicies": [
{
"idInt": 0,
"type": 0,
"ip": "string",
"subnetMask": 0,
"url": "string"
}
],
"freeAuthClientEnable": true,
"freeAuthClientPolicies": [
{
"idInt": 0,
"type": 0,
"clientIp": "string",
"clientMac": "string"
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|preAuthAccessEnable|boolean|true|none||none|
|preAuthAccessPolicies|[
[PreAuthAccessPolicyOpenApiVo
](#schemapreauthaccesspolicyopenapivo)
]|false|none||none|
|freeAuthClientEnable|boolean|true|none||none|
|freeAuthClientPolicies|[
[FreeAuthClientPolicyOpenApiVo
](#schemafreeauthclientpolicyopenapivo)
]|false|none||none|
PaypalWalletCustomer
```json
{
"id": "string",
"email_address": "string",
"phone": {
"phone_type": "FAX",
"phone_number": {
"national_number": "string"
}
},
"merchant_customer_id": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|string|false|none||none|
|email_address|string|false|none||none|
|phone|[PhoneWithType
](#schemaphonewithtype)|false|none||none|
|merchant_customer_id|string|false|none||none|
PreAuthAccessPolicyOpenApiVo
```json
{
"idInt": 0,
"type": 0,
"ip": "string",
"subnetMask": 0,
"url": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|idInt|integer(int32)|false|none||none|
|type|integer(int32)|true|none||none|
|ip|string|false|none||none|
|subnetMask|integer(int32)|false|none||none|
|url|string|false|none||none|
PaypalWalletResponse
```json
{
"email_address": "string",
"account_id": "string",
"account_status": "VERIFIED",
"name": {
"given_name": "string",
"surname": "string"
},
"phone_type": "FAX",
"phone_number": {
"national_number": "string"
},
"birth_date": "string",
"business_name": "string",
"tax_info": {
"tax_id": "string",
"tax_id_type": "BR_CPF"
},
"address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"attributes": {
"vault": {
"id": "string",
"status": "VAULTED",
"links": [
{
"href": "string",
"rel": "string",
"method": "["
}
],
"customer": {
"id": "string",
"email_address": "string",
"phone": {
"phone_type": null,
"phone_number": null
},
"merchant_customer_id": "string"
}
},
"cobranded_cards": [
{
"labels": [
"string"
],
"payee": {
"email_address": "string",
"merchant_id": "string"
},
"amount": {
"currency_code": "string",
"value": "string"
}
}
]
},
"stored_credential": {
"payment_initiator": "CUSTOMER",
"charge_pattern": "IMMEDIATE",
"usage_pattern": "IMMEDIATE",
"usage": "FIRST"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|email_address|string|false|none||none|
|account_id|string|false|none||none|
|account_status|string|false|none||none|
|name|[Name
](#schemaname)|false|none||none|
|phone_type|string|false|none||none|
|phone_number|[PhoneNumber
](#schemaphonenumber)|false|none||none|
|birth_date|string|false|none||none|
|business_name|string|false|none||none|
|tax_info|[TaxInfo
](#schemataxinfo)|false|none||none|
|address|[Address
](#schemaaddress)|false|none||none|
|attributes|[PaypalWalletAttributesResponse
](#schemapaypalwalletattributesresponse)|false|none||none|
|stored_credential|[PaypalWalletStoredCredential
](#schemapaypalwalletstoredcredential)|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|account_status|VERIFIED|
|account_status|UNVERIFIED|
|account_status|null|
|phone_type|FAX|
|phone_type|HOME|
|phone_type|MOBILE|
|phone_type|OTHER|
|phone_type|PAGER|
|phone_type|null|
RListWlanSimpleOpenApiVo
```json
{
"code": 0,
"msg": "string",
"data": [
{
"wlanId": "string",
"wlanName": "string",
"ssidList": [
{
"ssidId": "string",
"ssidName": "string"
}
]
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[
[WlanSimpleOpenApiVo
](#schemawlansimpleopenapivo)
]|false|none||none|
PaypalWalletStoredCredential
```json
{
"payment_initiator": "CUSTOMER",
"charge_pattern": "IMMEDIATE",
"usage_pattern": "IMMEDIATE",
"usage": "FIRST"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|payment_initiator|string|false|none||none|
|charge_pattern|string|false|none||none|
|usage_pattern|string|false|none||none|
|usage|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|payment_initiator|CUSTOMER|
|payment_initiator|MERCHANT|
|payment_initiator|null|
|charge_pattern|IMMEDIATE|
|charge_pattern|DEFERRED|
|charge_pattern|RECURRING_PREPAID|
|charge_pattern|RECURRING_POSTPAID|
|charge_pattern|THRESHOLD_PREPAID|
|charge_pattern|THRESHOLD_POSTPAID|
|charge_pattern|SUBSCRIPTION_PREPAID|
|charge_pattern|SUBSCRIPTION_POSTPAID|
|charge_pattern|UNSCHEDULED_PREPAID|
|charge_pattern|UNSCHEDULED_POSTPAID|
|charge_pattern|INSTALLMENT_PREPAID|
|charge_pattern|INSTALLMENT_POSTPAID|
|charge_pattern|null|
|usage_pattern|IMMEDIATE|
|usage_pattern|DEFERRED|
|usage_pattern|RECURRING_PREPAID|
|usage_pattern|RECURRING_POSTPAID|
|usage_pattern|THRESHOLD_PREPAID|
|usage_pattern|THRESHOLD_POSTPAID|
|usage_pattern|SUBSCRIPTION_PREPAID|
|usage_pattern|SUBSCRIPTION_POSTPAID|
|usage_pattern|UNSCHEDULED_PREPAID|
|usage_pattern|UNSCHEDULED_POSTPAID|
|usage_pattern|INSTALLMENT_PREPAID|
|usage_pattern|INSTALLMENT_POSTPAID|
|usage_pattern|null|
|usage|FIRST|
|usage|SUBSEQUENT|
|usage|DERIVED|
|usage|null|
SsidSimpleOpenApiVo
```json
{
"ssidId": "string",
"ssidName": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|ssidId|string|false|none||none|
|ssidName|string|false|none||none|
PaypalWalletVaultResponse
```json
{
"id": "string",
"status": "VAULTED",
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
],
"customer": {
"id": "string",
"email_address": "string",
"phone": {
"phone_type": "FAX",
"phone_number": {
"national_number": "string"
}
},
"merchant_customer_id": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|string|false|none||none|
|status|string|false|none||none|
|links|[
[LinkDescription
](#schemalinkdescription)
]|false|none||none|
|customer|[PaypalWalletCustomer
](#schemapaypalwalletcustomer)|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|status|VAULTED|
|status|CREATED|
|status|APPROVED|
|status|null|
WlanSimpleOpenApiVo
```json
{
"wlanId": "string",
"wlanName": "string",
"ssidList": [
{
"ssidId": "string",
"ssidName": "string"
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|wlanId|string|false|none||none|
|wlanName|string|false|none||none|
|ssidList|[
[SsidSimpleOpenApiVo
](#schemassidsimpleopenapivo)
]|false|none||none|
PhoneNumber
```json
{
"national_number": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|national_number|string|false|none||none|
PageDataVo
```json
{
"total": 0,
"rows": [
{}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|total|integer(int64)|false|none||none|
|rows|[object
]|false|none||none|
PhoneNumberWithCountryCode
```json
{
"country_code": "string",
"national_number": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|country_code|string|false|none||none|
|national_number|string|false|none||none|
TableDataInfo
```json
{
"data": {
"total": 0,
"rows": [
{}
]
},
"code": 0,
"msg": "string",
"total": 0,
"rows": [
{}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|data|[PageDataVo
](#schemapagedatavo)|false|none||none|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|total|integer(int64)|false|write-only||none|
|rows|[object
]|false|write-only||none|
PhoneWithType
```json
{
"phone_type": "FAX",
"phone_number": {
"national_number": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|phone_type|string|false|none||none|
|phone_number|[PhoneNumber
](#schemaphonenumber)|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|phone_type|FAX|
|phone_type|HOME|
|phone_type|MOBILE|
|phone_type|OTHER|
|phone_type|PAGER|
|phone_type|null|
```json
{
"code": 0,
"msg": "string",
"data": {
"ssidId": "string",
"name": "string",
"band": 0,
"guestNetEnable": true,
"security": 0,
"broadcast": true,
"vlanEnable": true,
"vlanId": 0,
"pskSetting": {},
"entSetting": {},
"ppskSetting": {},
"mloEnable": true,
"pmfMode": 0,
"enable11r": true,
"clientRateLimit": {},
"ssidRateLimit": {},
"wlanSchedule": {
"wlanScheduleEnable": true,
"action": 0,
"scheduleId": "string"
},
"rateControl": {
"rate2gCtrlEnable": true,
"lowerDensity2g": 0,
"higherDensity2g": 0,
"cckRatesDisable": true,
"clientRatesRequire2g": true,
"sendBeacons2g": true,
"rate5gCtrlEnable": true,
"lowerDensity5g": 0,
"higherDensity5g": 0,
"clientRatesRequire5g": true,
"sendBeacons5g": true,
"rate6gCtrlEnable": true,
"lowerDensity6g": 0,
"higherDensity6g": 0,
"clientRatesRequire6g": true,
"sendBeacons6g": true
},
"macFilter": {
"macFilterEnable": true,
"policy": 0,
"macFilterId": "string",
"ouiProfileIdList": [
"string"
]
},
"multiCast": {
"multiCastEnable": true,
"channelUtil": 0,
"arpCastEnable": true,
"ipv6CastEnable": true,
"filterEnable": true,
"filterMode": 0,
"macGroupId": "string"
},
"dhcpOption82": {
"dhcpEnable": true,
"format": 0,
"delimiter": "string",
"circuitId": [
0
],
"remoteId": [
0
]
},
"deviceType": 0
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[SsidDetailOpenApiVo
](#schemassiddetailopenapivo)|false|none||none|
```json
{
"amount": {
"currency_code": "string",
"value": "string"
},
"payee": {
"email_address": "string",
"merchant_id": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|amount|[Money
](#schemamoney)|false|none||none|
|payee|[PayeeBase
](#schemapayeebase)|false|none||none|
SsidDetailOpenApiVo
```json
{
"ssidId": "string",
"name": "string",
"band": 0,
"guestNetEnable": true,
"security": 0,
"broadcast": true,
"vlanEnable": true,
"vlanId": 0,
"pskSetting": {},
"entSetting": {},
"ppskSetting": {},
"mloEnable": true,
"pmfMode": 0,
"enable11r": true,
"clientRateLimit": {},
"ssidRateLimit": {},
"wlanSchedule": {
"wlanScheduleEnable": true,
"action": 0,
"scheduleId": "string"
},
"rateControl": {
"rate2gCtrlEnable": true,
"lowerDensity2g": 0,
"higherDensity2g": 0,
"cckRatesDisable": true,
"clientRatesRequire2g": true,
"sendBeacons2g": true,
"rate5gCtrlEnable": true,
"lowerDensity5g": 0,
"higherDensity5g": 0,
"clientRatesRequire5g": true,
"sendBeacons5g": true,
"rate6gCtrlEnable": true,
"lowerDensity6g": 0,
"higherDensity6g": 0,
"clientRatesRequire6g": true,
"sendBeacons6g": true
},
"macFilter": {
"macFilterEnable": true,
"policy": 0,
"macFilterId": "string",
"ouiProfileIdList": [
"string"
]
},
"multiCast": {
"multiCastEnable": true,
"channelUtil": 0,
"arpCastEnable": true,
"ipv6CastEnable": true,
"filterEnable": true,
"filterMode": 0,
"macGroupId": "string"
},
"dhcpOption82": {
"dhcpEnable": true,
"format": 0,
"delimiter": "string",
"circuitId": [
0
],
"remoteId": [
0
]
},
"deviceType": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|ssidId|string|false|none||none|
|name|string|false|none||none|
|band|integer(int32)|false|none||none|
|guestNetEnable|boolean|false|none||none|
|security|integer(int32)|false|none||none|
|broadcast|boolean|false|none||none|
|vlanEnable|boolean|false|none||none|
|vlanId|integer(int32)|false|none||none|
|pskSetting|object|false|none||none|
|entSetting|object|false|none||none|
|ppskSetting|object|false|none||none|
|mloEnable|boolean|false|none||none|
|pmfMode|integer(int32)|false|none||none|
|enable11r|boolean|false|none||none|
|clientRateLimit|object|false|none||none|
|ssidRateLimit|object|false|none||none|
|wlanSchedule|[SsidWlanScheduleOpenApiVo
](#schemassidwlanscheduleopenapivo)|false|none||none|
|rateControl|[SsidRateControlOpenApiVo
](#schemassidratecontrolopenapivo)|false|none||none|
|macFilter|[SsidMacFilterOpenApiVo
](#schemassidmacfilteropenapivo)|false|none||none|
|multiCast|[SsidMultiCastOpenApiVo
](#schemassidmulticastopenapivo)|false|none||none|
|dhcpOption82|[SsidDhcpOptionOpenApiVo
](#schemassiddhcpoptionopenapivo)|false|none||none|
|deviceType|integer(int32)|false|none||none|
ProcessorResponse
```json
{
"avs_code": "A",
"cvv_code": "E",
"response_code": "0000",
"payment_advice_code": "01"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|avs_code|string|false|none||none|
|cvv_code|string|false|none||none|
|response_code|string|false|none||none|
|payment_advice_code|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|avs_code|A|
|avs_code|B|
|avs_code|C|
|avs_code|D|
|avs_code|E|
|avs_code|F|
|avs_code|G|
|avs_code|I|
|avs_code|M|
|avs_code|N|
|avs_code|P|
|avs_code|R|
|avs_code|S|
|avs_code|U|
|avs_code|W|
|avs_code|X|
|avs_code|Y|
|avs_code|Z|
|avs_code|Null|
|avs_code|0|
|avs_code|1|
|avs_code|2|
|avs_code|3|
|avs_code|4|
|avs_code|null|
|cvv_code|E|
|cvv_code|I|
|cvv_code|M|
|cvv_code|N|
|cvv_code|P|
|cvv_code|S|
|cvv_code|U|
|cvv_code|X|
|cvv_code|All others|
|cvv_code|0|
|cvv_code|1|
|cvv_code|2|
|cvv_code|3|
|cvv_code|4|
|cvv_code|null|
|response_code|0000|
|response_code|00N7|
|response_code|0100|
|response_code|0390|
|response_code|0500|
|response_code|0580|
|response_code|0800|
|response_code|0880|
|response_code|0890|
|response_code|0960|
|response_code|0R00|
|response_code|1000|
|response_code|10BR|
|response_code|1300|
|response_code|1310|
|response_code|1312|
|response_code|1317|
|response_code|1320|
|response_code|1330|
|response_code|1335|
|response_code|1340|
|response_code|1350|
|response_code|1352|
|response_code|1360|
|response_code|1370|
|response_code|1380|
|response_code|1382|
|response_code|1384|
|response_code|1390|
|response_code|1393|
|response_code|5100|
|response_code|5110|
|response_code|5120|
|response_code|5130|
|response_code|5135|
|response_code|5140|
|response_code|5150|
|response_code|5160|
|response_code|5170|
|response_code|5180|
|response_code|5190|
|response_code|5200|
|response_code|5210|
|response_code|5400|
|response_code|5500|
|response_code|5650|
|response_code|5700|
|response_code|5710|
|response_code|5800|
|response_code|5900|
|response_code|5910|
|response_code|5920|
|response_code|5930|
|response_code|5950|
|response_code|6300|
|response_code|7600|
|response_code|7700|
|response_code|7710|
|response_code|7800|
|response_code|7900|
|response_code|8000|
|response_code|8010|
|response_code|8020|
|response_code|8030|
|response_code|8100|
|response_code|8110|
|response_code|8220|
|response_code|9100|
|response_code|9500|
|response_code|9510|
|response_code|9520|
|response_code|9530|
|response_code|9540|
|response_code|9600|
|response_code|PCNR|
|response_code|PCVV|
|response_code|PP06|
|response_code|PPRN|
|response_code|PPAD|
|response_code|PPAB|
|response_code|PPAE|
|response_code|PPAG|
|response_code|PPAI|
|response_code|PPAR|
|response_code|PPAU|
|response_code|PPAV|
|response_code|PPAX|
|response_code|PPBG|
|response_code|PPC2|
|response_code|PPCE|
|response_code|PPCO|
|response_code|PPCR|
|response_code|PPCT|
|response_code|PPCU|
|response_code|PPD3|
|response_code|PPDC|
|response_code|PPDI|
|response_code|PPDV|
|response_code|PPDT|
|response_code|PPEF|
|response_code|PPEL|
|response_code|PPER|
|response_code|PPEX|
|response_code|PPFE|
|response_code|PPFI|
|response_code|PPFR|
|response_code|PPFV|
|response_code|PPGR|
|response_code|PPH1|
|response_code|PPIF|
|response_code|PPII|
|response_code|PPIM|
|response_code|PPIT|
|response_code|PPLR|
|response_code|PPLS|
|response_code|PPMB|
|response_code|PPMC|
|response_code|PPMD|
|response_code|PPNC|
|response_code|PPNL|
|response_code|PPNM|
|response_code|PPNT|
|response_code|PPPH|
|response_code|PPPI|
|response_code|PPPM|
|response_code|PPQC|
|response_code|PPRE|
|response_code|PPRF|
|response_code|PPRR|
|response_code|PPS0|
|response_code|PPS1|
|response_code|PPS2|
|response_code|PPS3|
|response_code|PPS4|
|response_code|PPS5|
|response_code|PPS6|
|response_code|PPSC|
|response_code|PPSD|
|response_code|PPSE|
|response_code|PPTE|
|response_code|PPTF|
|response_code|PPTI|
|response_code|PPTR|
|response_code|PPTT|
|response_code|PPTV|
|response_code|PPUA|
|response_code|PPUC|
|response_code|PPUE|
|response_code|PPUI|
|response_code|PPUP|
|response_code|PPUR|
|response_code|PPVC|
|response_code|PPVE|
|response_code|PPVT|
|response_code|null|
|payment_advice_code|01|
|payment_advice_code|02|
|payment_advice_code|03|
|payment_advice_code|04|
|payment_advice_code|21|
|payment_advice_code|22|
|payment_advice_code|24|
|payment_advice_code|25|
|payment_advice_code|26|
|payment_advice_code|27|
|payment_advice_code|28|
|payment_advice_code|29|
|payment_advice_code|30|
|payment_advice_code|40|
|payment_advice_code|43|
|payment_advice_code|null|
SsidDhcpOptionOpenApiVo
```json
{
"dhcpEnable": true,
"format": 0,
"delimiter": "string",
"circuitId": [
0
],
"remoteId": [
0
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|dhcpEnable|boolean|false|none||none|
|format|integer(int32)|false|none||none|
|delimiter|string|false|none||none|
|circuitId|[integer
]|false|none||none|
|remoteId|[integer
]|false|none||none|
PurchaseUnit
```json
{
"reference_id": "string",
"amount": {
"currency_code": "string",
"value": "string",
"breakdown": {
"item_total": {
"currency_code": "string",
"value": "string"
},
"shipping": {
"currency_code": "string",
"value": "string"
},
"handling": {
"currency_code": "string",
"value": "string"
},
"tax_total": {
"currency_code": "string",
"value": "string"
},
"insurance": {
"currency_code": "string",
"value": "string"
},
"shipping_discount": {
"currency_code": "string",
"value": "string"
},
"discount": {
"currency_code": "string",
"value": "string"
}
}
},
"payee": {
"email_address": "string",
"merchant_id": "string"
},
"payment_instruction": {
"platform_fees": [
{
"amount": {
"currency_code": "string",
"value": "string"
},
"payee": {
"email_address": "string",
"merchant_id": "string"
}
}
],
"disbursement_mode": "INSTANT",
"payee_pricing_tier_id": "string",
"payee_receivable_fx_rate_id": "string"
},
"description": "string",
"custom_id": "string",
"invoice_id": "string",
"id": "string",
"soft_descriptor": "string",
"items": [
{
"name": "string",
"unit_amount": {
"currency_code": "string",
"value": "string"
},
"tax": {
"currency_code": "string",
"value": "string"
},
"quantity": "string",
"description": "string",
"sku": "string",
"url": "string",
"category": "DIGITAL_GOODS",
"image_url": "string",
"upc": {
"type": "UPC-A",
"code": "string"
}
}
],
"shipping": {
"name": {
"full_name": "string"
},
"email_address": "string",
"phone_number": {
"country_code": "string",
"national_number": "string"
},
"type": "SHIPPING",
"options": [
{
"id": "string",
"label": "string",
"type": "SHIPPING",
"amount": {
"currency_code": "string",
"value": "string"
},
"selected": true
}
],
"address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"trackers": [
{
"id": "string",
"status": "CANCELLED",
"items": [
{
"name": null,
"quantity": null,
"sku": null,
"url": null,
"image_url": null,
"upc": null
}
],
"links": [
{
"href": null,
"rel": null,
"method": null
}
],
"create_time": "string",
"update_time": "string"
}
]
},
"supplementary_data": {
"card": {
"level_2": {
"invoice_id": "string",
"tax_total": {
"currency_code": null,
"value": null
}
},
"level_3": {
"shipping_amount": {
"currency_code": null,
"value": null
},
"duty_amount": {
"currency_code": null,
"value": null
},
"discount_amount": {
"currency_code": null,
"value": null
},
"shipping_address": {
"address_line_1": null,
"address_line_2": null,
"admin_area_2": null,
"admin_area_1": null,
"postal_code": null,
"country_code": null
},
"ships_from_postal_code": "string",
"line_items": [
{}
]
}
},
"risk": {
"customer": {
"ip_address": "string"
}
}
},
"payments": {
"authorizations": [
{
"status": "CREATED",
"status_details": {
"reason": "["
},
"id": "string",
"amount": {
"currency_code": "string",
"value": "string"
},
"invoice_id": "string",
"custom_id": "string",
"network_transaction_reference": {
"id": "string",
"date": "string",
"network": "[",
"acquirer_reference_number": "string"
},
"seller_protection": {
"status": "[",
"dispute_categories": [
null
]
},
"expiration_time": "string",
"links": [
{
"href": null,
"rel": null,
"method": null
}
],
"create_time": "string",
"update_time": "string",
"processor_response": {
"avs_code": "[",
"cvv_code": "[",
"response_code": "[",
"payment_advice_code": "["
}
}
],
"captures": [
{
"status": "COMPLETED",
"status_details": {
"reason": "["
},
"id": "string",
"amount": {
"currency_code": "string",
"value": "string"
},
"invoice_id": "string",
"custom_id": "string",
"network_transaction_reference": {
"id": "string",
"date": "string",
"network": "[",
"acquirer_reference_number": "string"
},
"seller_protection": {
"status": "[",
"dispute_categories": [
null
]
},
"final_capture": true,
"seller_receivable_breakdown": {
"gross_amount": {},
"paypal_fee": {},
"paypal_fee_in_receivable_currency": {},
"net_amount": {},
"receivable_amount": {},
"exchange_rate": {},
"platform_fees": [
null
]
},
"disbursement_mode": "INSTANT",
"links": [
{
"href": null,
"rel": null,
"method": null
}
],
"processor_response": {
"avs_code": "[",
"cvv_code": "[",
"response_code": "[",
"payment_advice_code": "["
},
"create_time": "string",
"update_time": "string"
}
],
"refunds": [
{
"status": "CANCELLED",
"status_details": {
"reason": "["
},
"id": "string",
"amount": {
"currency_code": "string",
"value": "string"
},
"invoice_id": "string",
"custom_id": "string",
"acquirer_reference_number": "string",
"note_to_payer": "string",
"seller_payable_breakdown": {
"gross_amount": {},
"paypal_fee": {},
"paypal_fee_in_receivable_currency": {},
"net_amount": {},
"net_amount_in_receivable_currency": {},
"platform_fees": [
null
],
"net_amount_breakdown": [
null
],
"total_refunded_amount": {}
},
"payer": {
"email_address": "string",
"merchant_id": "string"
},
"links": [
{
"href": null,
"rel": null,
"method": null
}
],
"create_time": "string",
"update_time": "string"
}
]
},
"most_recent_errors": [
{}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|reference_id|string|false|none||none|
|amount|[AmountWithBreakdown
](#schemaamountwithbreakdown)|false|none||none|
|payee|[PayeeBase
](#schemapayeebase)|false|none||none|
|payment_instruction|[PaymentInstruction
](#schemapaymentinstruction)|false|none||none|
|description|string|false|none||none|
|custom_id|string|false|none||none|
|invoice_id|string|false|none||none|
|id|string|false|none||none|
|soft_descriptor|string|false|none||none|
|items|[
[Item
](#schemaitem)
]|false|none||none|
|shipping|[ShippingWithTrackingDetails
](#schemashippingwithtrackingdetails)|false|none||none|
|supplementary_data|[SupplementaryData
](#schemasupplementarydata)|false|none||none|
|payments|[PaymentCollection
](#schemapaymentcollection)|false|none||none|
|most_recent_errors|[
[JsonNode
](#schemajsonnode)
]|false|none||none|
SsidMacFilterOpenApiVo
```json
{
"macFilterEnable": true,
"policy": 0,
"macFilterId": "string",
"ouiProfileIdList": [
"string"
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|macFilterEnable|boolean|false|none||none|
|policy|integer(int32)|false|none||none|
|macFilterId|string|false|none||none|
|ouiProfileIdList|[string
]|false|none||none|
ROrder
```json
{
"code": 0,
"msg": "string",
"data": {
"create_time": "string",
"update_time": "string",
"id": "string",
"payment_source": {
"card": {
"name": "string",
"last_digits": "string",
"brand": "VISA",
"available_networks": [
"["
],
"type": "CREDIT",
"authentication_result": {
"liability_shift": null,
"three_d_secure": null
},
"attributes": {
"vault": null
},
"from_request": {
"expiry": null,
"last_digits": null
},
"expiry": "string",
"bin_details": {
"bin": null,
"issuing_bank": null,
"bin_country_code": null,
"products": null
},
"stored_credential": {
"payment_initiator": null,
"payment_type": null,
"usage": null,
"previous_network_transaction_reference": null
}
},
"paypal": {
"email_address": "string",
"account_id": "string",
"account_status": "VERIFIED",
"name": {
"given_name": null,
"surname": null
},
"phone_type": "FAX",
"phone_number": {
"national_number": null
},
"birth_date": "string",
"business_name": "string",
"tax_info": {
"tax_id": null,
"tax_id_type": null
},
"address": {
"address_line_1": null,
"address_line_2": null,
"admin_area_2": null,
"admin_area_1": null,
"postal_code": null,
"country_code": null
},
"attributes": {
"vault": null,
"cobranded_cards": null
},
"stored_credential": {
"payment_initiator": null,
"charge_pattern": null,
"usage_pattern": null,
"usage": null
}
},
"bancontact": {
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string",
"card_last_digits": "string"
},
"blik": {
"name": "string",
"country_code": "string",
"email": "string",
"one_click": {
"consumer_reference": null
}
},
"eps": {
"name": "string",
"country_code": "string",
"bic": "string"
},
"giropay": {
"name": "string",
"country_code": "string",
"bic": "string"
},
"ideal": {
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string"
},
"mybank": {
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string"
},
"p24": {
"name": "string",
"email": "string",
"country_code": "string",
"payment_descriptor": "string",
"method_id": "string",
"method_description": "string"
},
"sofort": {
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string"
},
"trustly": {
"name": "string",
"country_code": "string",
"email": "string",
"bic": "string",
"iban_last_chars": "string"
},
"apple_pay": {
"id": "string",
"token": "string",
"name": "string",
"email_address": "string",
"phone_number": {
"national_number": null
},
"card": {
"name": null,
"last_digits": null,
"brand": null,
"available_networks": null,
"type": null,
"authentication_result": null,
"attributes": null,
"from_request": null,
"expiry": null,
"bin_details": null,
"stored_credential": null,
"billing_address": null,
"country_code": null
},
"attributes": {
"vault": null
},
"stored_credential": {
"payment_initiator": null,
"payment_type": null,
"usage": null,
"previous_network_transaction_reference": null
}
},
"google_pay": {
"name": "string",
"email_address": "string",
"phone_number": {
"country_code": null,
"national_number": null
},
"card": {
"name": null,
"last_digits": null,
"type": null,
"brand": null,
"billing_address": null,
"authentication_result": null
}
},
"venmo": {
"email_address": "string",
"account_id": "string",
"user_name": "string",
"name": {
"given_name": null,
"surname": null
},
"phone_number": {
"national_number": null
},
"address": {
"address_line_1": null,
"address_line_2": null,
"admin_area_2": null,
"admin_area_1": null,
"postal_code": null,
"country_code": null
},
"attributes": {
"vault": null
}
}
},
"intent": "CAPTURE",
"payer": {
"email_address": "string",
"payer_id": "string",
"name": {
"given_name": "string",
"surname": "string"
},
"phone": {
"phone_type": "FAX",
"phone_number": {
"national_number": null
}
},
"birth_date": "string",
"tax_info": {
"tax_id": "string",
"tax_id_type": "BR_CPF"
},
"address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
}
},
"purchase_units": [
{
"reference_id": "string",
"amount": {
"currency_code": "string",
"value": "string",
"breakdown": {}
},
"payee": {
"email_address": "string",
"merchant_id": "string"
},
"payment_instruction": {
"platform_fees": [
null
],
"disbursement_mode": "[",
"payee_pricing_tier_id": "string",
"payee_receivable_fx_rate_id": "string"
},
"description": "string",
"custom_id": "string",
"invoice_id": "string",
"id": "string",
"soft_descriptor": "string",
"items": [
{
"name": null,
"unit_amount": null,
"tax": null,
"quantity": null,
"description": null,
"sku": null,
"url": null,
"category": null,
"image_url": null,
"upc": null
}
],
"shipping": {
"name": {},
"email_address": "string",
"phone_number": {},
"type": "[",
"options": [
null
],
"address": {},
"trackers": [
null
]
},
"supplementary_data": {
"card": {},
"risk": {}
},
"payments": {
"authorizations": [
null
],
"captures": [
null
],
"refunds": [
null
]
},
"most_recent_errors": [
{}
]
}
],
"status": "CREATED",
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
]
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[Order
](#schemaorder)|false|none||none|
SsidMultiCastOpenApiVo
```json
{
"multiCastEnable": true,
"channelUtil": 0,
"arpCastEnable": true,
"ipv6CastEnable": true,
"filterEnable": true,
"filterMode": 0,
"macGroupId": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|multiCastEnable|boolean|false|none||none|
|channelUtil|integer(int32)|false|none||none|
|arpCastEnable|boolean|false|none||none|
|ipv6CastEnable|boolean|false|none||none|
|filterEnable|boolean|false|none||none|
|filterMode|integer(int32)|false|none||none|
|macGroupId|string|false|none||none|
Refund
```json
{
"status": "CANCELLED",
"status_details": {
"reason": "ECHECK"
},
"id": "string",
"amount": {
"currency_code": "string",
"value": "string"
},
"invoice_id": "string",
"custom_id": "string",
"acquirer_reference_number": "string",
"note_to_payer": "string",
"seller_payable_breakdown": {
"gross_amount": {
"currency_code": "string",
"value": "string"
},
"paypal_fee": {
"currency_code": "string",
"value": "string"
},
"paypal_fee_in_receivable_currency": {
"currency_code": "string",
"value": "string"
},
"net_amount": {
"currency_code": "string",
"value": "string"
},
"net_amount_in_receivable_currency": {
"currency_code": "string",
"value": "string"
},
"platform_fees": [
{
"amount": {
"currency_code": "string",
"value": "string"
},
"payee": {
"email_address": "string",
"merchant_id": "string"
}
}
],
"net_amount_breakdown": [
{
"payable_amount": {
"currency_code": "string",
"value": "string"
},
"converted_amount": {
"currency_code": "string",
"value": "string"
},
"exchange_rate": {
"source_currency": "string",
"target_currency": "string",
"value": "string"
}
}
],
"total_refunded_amount": {
"currency_code": "string",
"value": "string"
}
},
"payer": {
"email_address": "string",
"merchant_id": "string"
},
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
],
"create_time": "string",
"update_time": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|status|string|false|none||none|
|status_details|[RefundStatusDetails
](#schemarefundstatusdetails)|false|none||none|
|id|string|false|none||none|
|amount|[Money
](#schemamoney)|false|none||none|
|invoice_id|string|false|none||none|
|custom_id|string|false|none||none|
|acquirer_reference_number|string|false|none||none|
|note_to_payer|string|false|none||none|
|seller_payable_breakdown|[SellerPayableBreakdown
](#schemasellerpayablebreakdown)|false|none||none|
|payer|[PayeeBase
](#schemapayeebase)|false|none||none|
|links|[
[LinkDescription
](#schemalinkdescription)
]|false|none||none|
|create_time|string|false|none||none|
|update_time|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|status|CANCELLED|
|status|FAILED|
|status|PENDING|
|status|COMPLETED|
|status|null|
SsidRateControlOpenApiVo
```json
{
"rate2gCtrlEnable": true,
"lowerDensity2g": 0,
"higherDensity2g": 0,
"cckRatesDisable": true,
"clientRatesRequire2g": true,
"sendBeacons2g": true,
"rate5gCtrlEnable": true,
"lowerDensity5g": 0,
"higherDensity5g": 0,
"clientRatesRequire5g": true,
"sendBeacons5g": true,
"rate6gCtrlEnable": true,
"lowerDensity6g": 0,
"higherDensity6g": 0,
"clientRatesRequire6g": true,
"sendBeacons6g": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|rate2gCtrlEnable|boolean|false|none||none|
|lowerDensity2g|number|false|none||none|
|higherDensity2g|integer(int32)|false|none||none|
|cckRatesDisable|boolean|false|none||none|
|clientRatesRequire2g|boolean|false|none||none|
|sendBeacons2g|boolean|false|none||none|
|rate5gCtrlEnable|boolean|false|none||none|
|lowerDensity5g|integer(int32)|false|none||none|
|higherDensity5g|integer(int32)|false|none||none|
|clientRatesRequire5g|boolean|false|none||none|
|sendBeacons5g|boolean|false|none||none|
|rate6gCtrlEnable|boolean|false|none||none|
|lowerDensity6g|integer(int32)|false|none||none|
|higherDensity6g|integer(int32)|false|none||none|
|clientRatesRequire6g|boolean|false|none||none|
|sendBeacons6g|boolean|false|none||none|
RefundStatusDetails
```json
{
"reason": "ECHECK"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|reason|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|reason|ECHECK|
|reason|null|
SsidWlanScheduleOpenApiVo
```json
{
"wlanScheduleEnable": true,
"action": 0,
"scheduleId": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|wlanScheduleEnable|boolean|false|none||none|
|action|integer(int32)|false|none||none|
|scheduleId|string|false|none||none|
RiskSupplementaryData
```json
{
"customer": {
"ip_address": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|customer|[ParticipantMetadata
](#schemaparticipantmetadata)|false|none||none|
RListWlanGroupOpenApiVo
```json
{
"code": 0,
"msg": "string",
"data": [
{
"wlanId": "string",
"name": "string",
"primary": true
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[
[WlanGroupOpenApiVo
](#schemawlangroupopenapivo)
]|false|none||none|
SellerPayableBreakdown
```json
{
"gross_amount": {
"currency_code": "string",
"value": "string"
},
"paypal_fee": {
"currency_code": "string",
"value": "string"
},
"paypal_fee_in_receivable_currency": {
"currency_code": "string",
"value": "string"
},
"net_amount": {
"currency_code": "string",
"value": "string"
},
"net_amount_in_receivable_currency": {
"currency_code": "string",
"value": "string"
},
"platform_fees": [
{
"amount": {
"currency_code": "string",
"value": "string"
},
"payee": {
"email_address": "string",
"merchant_id": "string"
}
}
],
"net_amount_breakdown": [
{
"payable_amount": {
"currency_code": "string",
"value": "string"
},
"converted_amount": {
"currency_code": "string",
"value": "string"
},
"exchange_rate": {
"source_currency": "string",
"target_currency": "string",
"value": "string"
}
}
],
"total_refunded_amount": {
"currency_code": "string",
"value": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|gross_amount|[Money
](#schemamoney)|false|none||none|
|paypal_fee|[Money
](#schemamoney)|false|none||none|
|paypal_fee_in_receivable_currency|[Money
](#schemamoney)|false|none||none|
|net_amount|[Money
](#schemamoney)|false|none||none|
|net_amount_in_receivable_currency|[Money
](#schemamoney)|false|none||none|
|platform_fees|[
[PlatformFee
](#schemaplatformfee)
]|false|none||none|
|net_amount_breakdown|[
[NetAmountBreakdownItem
](#schemanetamountbreakdownitem)
]|false|none||none|
|total_refunded_amount|[Money
](#schemamoney)|false|none||none|
WlanGroupOpenApiVo
```json
{
"wlanId": "string",
"name": "string",
"primary": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|wlanId|string|false|none||none|
|name|string|false|none||none|
|primary|boolean|false|none||none|
SellerProtection
```json
{
"status": "ELIGIBLE",
"dispute_categories": [
"ITEM_NOT_RECEIVED"
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|status|string|false|none||none|
|dispute_categories|[string
]|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|status|ELIGIBLE|
|status|PARTIALLY_ELIGIBLE|
|status|NOT_ELIGIBLE|
|status|null|
UDept
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{}
]
}
]
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|deptId|integer(int64)|false|none||none|
|parentId|integer(int64)|false|none||none|
|ancestors|string|false|none||none|
|deptName|string|true|none||none|
|orderNum|integer(int32)|true|none||none|
|leader|string|false|none||none|
|phone|string|false|none||none|
|email|string|false|none||none|
|status|string|false|none||none|
|delFlag|string|false|none||none|
|parentName|string|false|none||none|
|children|[
[UDept
](#schemaudept)
]|false|none||none|
SellerReceivableBreakdown
```json
{
"gross_amount": {
"currency_code": "string",
"value": "string"
},
"paypal_fee": {
"currency_code": "string",
"value": "string"
},
"paypal_fee_in_receivable_currency": {
"currency_code": "string",
"value": "string"
},
"net_amount": {
"currency_code": "string",
"value": "string"
},
"receivable_amount": {
"currency_code": "string",
"value": "string"
},
"exchange_rate": {
"source_currency": "string",
"target_currency": "string",
"value": "string"
},
"platform_fees": [
{
"amount": {
"currency_code": "string",
"value": "string"
},
"payee": {
"email_address": "string",
"merchant_id": "string"
}
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|gross_amount|[Money
](#schemamoney)|false|none||none|
|paypal_fee|[Money
](#schemamoney)|false|none||none|
|paypal_fee_in_receivable_currency|[Money
](#schemamoney)|false|none||none|
|net_amount|[Money
](#schemamoney)|false|none||none|
|receivable_amount|[Money
](#schemamoney)|false|none||none|
|exchange_rate|[ExchangeRate
](#schemaexchangerate)|false|none||none|
|platform_fees|[
[PlatformFee
](#schemaplatformfee)
]|false|none||none|
URole
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|roleId|integer(int64)|false|none||none|
|roleName|string|true|none||none|
|roleKey|string|true|none||none|
|roleSort|integer(int32)|true|none||none|
|dataScope|string|false|none||none|
|menuCheckStrictly|boolean|false|none||none|
|deptCheckStrictly|boolean|false|none||none|
|status|string|false|none||none|
|delFlag|string|false|none||none|
|flag|boolean|false|none||none|
|menuIds|[integer
]|false|none||none|
|deptIds|[integer
]|false|none||none|
|permissions|[string
]|false|none||none|
|admin|boolean|false|none||none|
ShippingName
```json
{
"full_name": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|full_name|string|false|none||none|
UUser
```json
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"birthDate": "2019-08-24T14:15:22Z",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": null,
"createTime": null,
"updateBy": null,
"updateTime": null,
"remark": null,
"params": null,
"deptId": null,
"parentId": null,
"ancestors": null,
"deptName": null,
"orderNum": null,
"leader": null,
"phone": null,
"email": null,
"status": null,
"delFlag": null,
"parentName": null,
"children": null
}
]
}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"kycStatus": "string",
"admin": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|createBy|string|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|string|false|none||none|
|updateTime|string(date-time)|false|none||none|
|remark|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|object|false|none||none|
|userId|integer(int64)|false|none||none|
|deptId|integer(int64)|false|none||none|
|userName|string|true|none||none|
|birthDate|string(date-time)|false|none||none|
|nickName|string|false|none||none|
|email|string|false|none||none|
|phonenumber|string|false|none||none|
|sex|string|false|none||none|
|avatar|string|false|none||none|
|password|string|false|none||none|
|fullName|string|false|none||none|
|age|integer(int32)|false|none||none|
|address|string|false|none||none|
|status|string|false|none||none|
|delFlag|string|false|none||none|
|loginIp|string|false|none||none|
|loginDate|string(date-time)|false|none||none|
|dept|[UDept
](#schemaudept)|false|none||none|
|roles|[
[URole
](#schemaurole)
]|false|none||none|
|roleIds|[integer
]|false|none||none|
|postIds|[integer
]|false|none||none|
|roleId|integer(int64)|false|none||none|
|kycStatus|string|false|none||none|
|admin|boolean|false|none||none|
ShippingOption
```json
{
"id": "string",
"label": "string",
"type": "SHIPPING",
"amount": {
"currency_code": "string",
"value": "string"
},
"selected": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|string|false|none||none|
|label|string|false|none||none|
|type|string|false|none||none|
|amount|[Money
](#schemamoney)|false|none||none|
|selected|boolean|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|type|SHIPPING|
|type|PICKUP|
|type|PICKUP_IN_STORE|
|type|PICKUP_FROM_PERSON|
|type|null|
LoginUserSysUser
```json
{
"token": "string",
"userid": 0,
"username": "string",
"loginTime": 0,
"expireTime": 0,
"ipaddr": "string",
"permissions": [
"string"
],
"roles": [
"string"
],
"user": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"code": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
null
]
}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
0
],
"deptIds": [
0
],
"permissions": [
"string"
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"admin": true
},
"wanFiRedirectParams": {
"clientMac": "string",
"clientIp": "string",
"t": 0,
"site": "string",
"redirectUrl": "string",
"apMac": "string",
"ssidName": "string",
"radioId": 0
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|token|string|false|none||none|
|userid|integer(int64)|false|none||none|
|username|string|false|none||none|
|loginTime|integer(int64)|false|none||none|
|expireTime|integer(int64)|false|none||none|
|ipaddr|string|false|none||none|
|permissions|[string
]|false|none||none|
|roles|[string
]|false|none||none|
|user|[SysUser
](#schemasysuser)|false|none||none|
|wanFiRedirectParams|[WANFiRedirectParams
](#schemawanfiredirectparams)|false|none||none|
ShippingWithTrackingDetails
```json
{
"name": {
"full_name": "string"
},
"email_address": "string",
"phone_number": {
"country_code": "string",
"national_number": "string"
},
"type": "SHIPPING",
"options": [
{
"id": "string",
"label": "string",
"type": "SHIPPING",
"amount": {
"currency_code": "string",
"value": "string"
},
"selected": true
}
],
"address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"trackers": [
{
"id": "string",
"status": "CANCELLED",
"items": [
{
"name": "string",
"quantity": "string",
"sku": "string",
"url": "string",
"image_url": "string",
"upc": {
"type": null,
"code": null
}
}
],
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
],
"create_time": "string",
"update_time": "string"
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|[ShippingName
](#schemashippingname)|false|none||none|
|email_address|string|false|none||none|
|phone_number|[PhoneNumberWithCountryCode
](#schemaphonenumberwithcountrycode)|false|none||none|
|type|string|false|none||none|
|options|[
[ShippingOption
](#schemashippingoption)
]|false|none||none|
|address|[Address
](#schemaaddress)|false|none||none|
|trackers|[
[OrderTrackerResponse
](#schemaordertrackerresponse)
]|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|type|SHIPPING|
|type|PICKUP_IN_PERSON|
|type|PICKUP_IN_STORE|
|type|PICKUP_FROM_PERSON|
|type|null|
RLoginUserSysUser
```json
{
"code": 0,
"msg": "string",
"data": {
"token": "string",
"userid": 0,
"username": "string",
"loginTime": 0,
"expireTime": 0,
"ipaddr": "string",
"permissions": [
"string"
],
"roles": [
"string"
],
"user": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"userId": 0,
"deptId": 0,
"userName": "string",
"nickName": "string",
"email": "string",
"phonenumber": "string",
"sex": "string",
"avatar": "string",
"password": "string",
"fullName": "string",
"age": 0,
"address": "string",
"code": "string",
"status": "string",
"delFlag": "string",
"loginIp": "string",
"loginDate": "2019-08-24T14:15:22Z",
"dept": {
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {
"property1": {},
"property2": {}
},
"deptId": 0,
"parentId": 0,
"ancestors": "string",
"deptName": "string",
"orderNum": 0,
"leader": "string",
"phone": "string",
"email": "string",
"status": "string",
"delFlag": "string",
"parentName": "string",
"children": [
{}
]
},
"roles": [
{
"createBy": "string",
"createTime": "2019-08-24T14:15:22Z",
"updateBy": "string",
"updateTime": "2019-08-24T14:15:22Z",
"remark": "string",
"params": {},
"roleId": 0,
"roleName": "string",
"roleKey": "string",
"roleSort": 0,
"dataScope": "string",
"menuCheckStrictly": true,
"deptCheckStrictly": true,
"status": "string",
"delFlag": "string",
"flag": true,
"menuIds": [
null
],
"deptIds": [
null
],
"permissions": [
null
],
"admin": true
}
],
"roleIds": [
0
],
"postIds": [
0
],
"roleId": 0,
"admin": true
},
"wanFiRedirectParams": {
"clientMac": "string",
"clientIp": "string",
"t": 0,
"site": "string",
"redirectUrl": "string",
"apMac": "string",
"ssidName": "string",
"radioId": 0
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[LoginUserSysUser
](#schemaloginusersysuser)|false|none||none|
SofortPaymentObject
```json
{
"name": "string",
"country_code": "string",
"bic": "string",
"iban_last_chars": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|country_code|string|false|none||none|
|bic|string|false|none||none|
|iban_last_chars|string|false|none||none|
SupplementaryData
```json
{
"card": {
"level_2": {
"invoice_id": "string",
"tax_total": {
"currency_code": "string",
"value": "string"
}
},
"level_3": {
"shipping_amount": {
"currency_code": "string",
"value": "string"
},
"duty_amount": {
"currency_code": "string",
"value": "string"
},
"discount_amount": {
"currency_code": "string",
"value": "string"
},
"shipping_address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"ships_from_postal_code": "string",
"line_items": [
{
"name": "string",
"quantity": "string",
"description": "string",
"sku": "string",
"url": "string",
"image_url": "string",
"upc": {},
"unit_amount": {},
"tax": {},
"commodity_code": "string",
"discount_amount": {},
"total_amount": {},
"unit_of_measure": "string"
}
]
}
},
"risk": {
"customer": {
"ip_address": "string"
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|card|[CardSupplementaryData
](#schemacardsupplementarydata)|false|none||none|
|risk|[RiskSupplementaryData
](#schemarisksupplementarydata)|false|none||none|
DstDto
```json
{
"enable": true,
"start": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"end": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"status": true,
"startTime": 0,
"endTime": 0,
"offset": 0,
"nextStart": 0,
"nextEnd": 0,
"timeZone": "string",
"lastStart": 0,
"lastEnd": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|enable|boolean|false|none||none|
|start|[DstTimeDto
](#schemadsttimedto)|false|none||none|
|end|[DstTimeDto
](#schemadsttimedto)|false|none||none|
|status|boolean|false|none||none|
|startTime|integer(int64)|false|none||none|
|endTime|integer(int64)|false|none||none|
|offset|integer(int64)|false|none||none|
|nextStart|integer(int64)|false|none||none|
|nextEnd|integer(int64)|false|none||none|
|timeZone|string|false|none||none|
|lastStart|integer(int64)|false|none||none|
|lastEnd|integer(int64)|false|none||none|
TaxInfo
```json
{
"tax_id": "string",
"tax_id_type": "BR_CPF"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|tax_id|string|false|none||none|
|tax_id_type|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|tax_id_type|BR_CPF|
|tax_id_type|BR_CNPJ|
|tax_id_type|null|
DstTimeDto
```json
{
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|month|integer(int32)|true|none||none|
|serial|integer(int32)|true|none||none|
|day|integer(int32)|true|none||none|
|hour|integer(int32)|true|none||none|
|minute|integer(int32)|true|none||none|
ThreeDSecureAuthenticationResponse
```json
{
"authentication_status": "Y",
"enrollment_status": "Y"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|authentication_status|string|false|none||none|
|enrollment_status|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|authentication_status|Y|
|authentication_status|N|
|authentication_status|U|
|authentication_status|A|
|authentication_status|C|
|authentication_status|R|
|authentication_status|D|
|authentication_status|I|
|authentication_status|null|
|enrollment_status|Y|
|enrollment_status|N|
|enrollment_status|U|
|enrollment_status|B|
|enrollment_status|null|
RSiteEntity
```json
{
"code": 0,
"msg": "string",
"data": {
"siteId": "string",
"name": "string",
"type": 0,
"tagIds": [
"string"
],
"region": "string",
"timeZone": "string",
"ntpEnable": true,
"ntpServers": [
"string"
],
"dst": {
"enable": true,
"start": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"end": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"status": true,
"startTime": 0,
"endTime": 0,
"offset": 0,
"nextStart": 0,
"nextEnd": 0,
"timeZone": "string",
"lastStart": 0,
"lastEnd": 0
},
"scenario": "string",
"longitude": 0.1,
"latitude": 0.1,
"address": "string",
"supportES": true,
"supportL2": true
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[SiteEntity
](#schemasiteentity)|false|none||none|
TrustlyPaymentObject
```json
{
"name": "string",
"country_code": "string",
"email": "string",
"bic": "string",
"iban_last_chars": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|name|string|false|none||none|
|country_code|string|false|none||none|
|email|string|false|none||none|
|bic|string|false|none||none|
|iban_last_chars|string|false|none||none|
SiteEntity
```json
{
"siteId": "string",
"name": "string",
"type": 0,
"tagIds": [
"string"
],
"region": "string",
"timeZone": "string",
"ntpEnable": true,
"ntpServers": [
"string"
],
"dst": {
"enable": true,
"start": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"end": {
"month": 0,
"serial": 0,
"day": 0,
"hour": 0,
"minute": 0
},
"status": true,
"startTime": 0,
"endTime": 0,
"offset": 0,
"nextStart": 0,
"nextEnd": 0,
"timeZone": "string",
"lastStart": 0,
"lastEnd": 0
},
"scenario": "string",
"longitude": 0.1,
"latitude": 0.1,
"address": "string",
"supportES": true,
"supportL2": true
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|siteId|string|false|none||none|
|name|string|false|none||none|
|type|integer(int32)|false|none||none|
|tagIds|[string
]|false|none||none|
|region|string|false|none||none|
|timeZone|string|false|none||none|
|ntpEnable|boolean|false|none||none|
|ntpServers|[string
]|false|none||none|
|dst|[DstDto
](#schemadstdto)|false|none||none|
|scenario|string|false|none||none|
|longitude|number(double)|false|none||none|
|latitude|number(double)|false|none||none|
|address|string|false|none||none|
|supportES|boolean|false|none||none|
|supportL2|boolean|false|none||none|
UniversalProductCode
```json
{
"type": "UPC-A",
"code": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|type|string|false|none||none|
|code|string|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|type|UPC-A|
|type|UPC-B|
|type|UPC-C|
|type|UPC-D|
|type|UPC-E|
|type|UPC-2|
|type|UPC-5|
|type|null|
RSiteRoamingSetting
```json
{
"code": 0,
"msg": "string",
"data": {
"roaming": {
"fastRoamingEnable": true,
"aiRoamingEnable": true,
"dualBand11kReportEnable": true,
"forceDisassociationEnable": true,
"nonStickRoamingEnable": true
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[SiteRoamingSetting
](#schemasiteroamingsetting)|false|none||none|
VaultCustomer
```json
{
"id": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|string|false|none||none|
RSiteMeshSetting
```json
{
"code": 0,
"msg": "string",
"data": {
"mesh": {
"meshEnable": true,
"autoFailoverEnable": true,
"defGatewayEnable": true,
"gateway": "string",
"fullSector": true
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[SiteMeshSetting
](#schemasitemeshsetting)|false|none||none|
VaultResponse
```json
{
"id": "string",
"status": "VAULTED",
"customer": {
"id": "string"
},
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
]
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|string|false|none||none|
|status|string|false|none||none|
|customer|[VaultCustomer
](#schemavaultcustomer)|false|none||none|
|links|[
[LinkDescription
](#schemalinkdescription)
]|false|none||none|
#### 枚举值
|属性|值|
|---|---|
|status|VAULTED|
|status|CREATED|
|status|APPROVED|
|status|null|
AuthTimeOpenApiVo
```json
{
"authTimeout": 0,
"customTimeout": 0,
"customTimeoutUnit": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|authTimeout|integer(int32)|true|none||none|
|customTimeout|integer(int32)|false|none||none|
|customTimeoutUnit|integer(int32)|false|none||none|
VenmoWalletAttributesResponse
```json
{
"vault": {
"id": "string",
"status": "VAULTED",
"customer": {
"id": "string"
},
"links": [
{
"href": "string",
"rel": "string",
"method": "GET"
}
]
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|vault|[VaultResponse
](#schemavaultresponse)|false|none||none|
ExternalRadiusSettingResOpenApiVo
```json
{
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string",
"disconnectReq": true,
"receiverPort": 0,
"receiverPortStatus": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|radiusProfileId|string|false|none||none|
|authMode|integer(int32)|false|none||none|
|nasId|string|false|none||none|
|portalCustom|integer(int32)|false|none||none|
|externalUrlScheme|string|false|none||none|
|externalUrl|string|false|none||none|
|disconnectReq|boolean|false|none||none|
|receiverPort|integer(int32)|false|none||none|
|receiverPortStatus|integer(int32)|false|none||none|
VenmoWalletResponse
```json
{
"email_address": "string",
"account_id": "string",
"user_name": "string",
"name": {
"given_name": "string",
"surname": "string"
},
"phone_number": {
"national_number": "string"
},
"address": {
"address_line_1": "string",
"address_line_2": "string",
"admin_area_2": "string",
"admin_area_1": "string",
"postal_code": "string",
"country_code": "string"
},
"attributes": {
"vault": {
"id": "string",
"status": "VAULTED",
"customer": {
"id": "string"
},
"links": [
{
"href": "string",
"rel": "string",
"method": "["
}
]
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|email_address|string|false|none||none|
|account_id|string|false|none||none|
|user_name|string|false|none||none|
|name|[Name
](#schemaname)|false|none||none|
|phone_number|[PhoneNumber
](#schemaphonenumber)|false|none||none|
|address|[Address
](#schemaaddress)|false|none||none|
|attributes|[VenmoWalletAttributesResponse
](#schemavenmowalletattributesresponse)|false|none||none|
HotspotRadiusSettingResOpenApiVo
```json
{
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"authTimeout": {
"authTimeout": 0,
"customTimeout": 0,
"customTimeoutUnit": 0
},
"disconnectReq": true,
"receiverPort": 0,
"receiverPortStatus": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|radiusProfileId|string|false|none||none|
|authMode|integer(int32)|false|none||none|
|nasId|string|false|none||none|
|authTimeout|[AuthTimeOpenApiVo
](#schemaauthtimeopenapivo)|false|none||none|
|disconnectReq|boolean|false|none||none|
|receiverPort|integer(int32)|false|none||none|
|receiverPortStatus|integer(int32)|false|none||none|
RefundRequest
```json
{
"transactionId": "string",
"amount": 0.1,
"reason": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|transactionId|string|false|none||none|
|amount|number(double)|false|none||none|
|reason|string|false|none||none|
PortalDetailResOpenApiVo
```json
{
"id": "string",
"name": "string",
"enable": true,
"ssidList": [
"string"
],
"networkList": [
"string"
],
"authType": 0,
"authTimeout": {
"authTimeout": 0,
"customTimeout": 0,
"customTimeoutUnit": 0
},
"httpsRedirectEnable": true,
"landingPage": 0,
"landingUrlScheme": "string",
"landingUrl": "string",
"noAuth": {},
"simplePassword": {},
"hotspot": {},
"sms": {
"sid": "string",
"authToken": "string",
"phoneNum": "string",
"maxVerificationCodeEnable": true,
"maxVerificationCodeTimes": 0,
"authTimeout": {
"authTimeout": 0,
"customTimeout": 0,
"customTimeoutUnit": 0
},
"countryCode": "string"
},
"portalFormId": "string",
"hotspotRadius": {
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"authTimeout": {
"authTimeout": 0,
"customTimeout": 0,
"customTimeoutUnit": 0
},
"disconnectReq": true,
"receiverPort": 0,
"receiverPortStatus": 0
},
"externalPortal": {},
"externalRadius": {
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string",
"disconnectReq": true,
"receiverPort": 0,
"receiverPortStatus": 0
},
"ldap": {
"ldapProfileId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string"
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|string|false|none||none|
|name|string|false|none||none|
|enable|boolean|false|none||none|
|ssidList|[string
]|false|none||none|
|networkList|[string
]|false|none||none|
|authType|integer(int32)|false|none||none|
|authTimeout|[AuthTimeOpenApiVo
](#schemaauthtimeopenapivo)|false|none||none|
|httpsRedirectEnable|boolean|false|none||none|
|landingPage|integer(int32)|false|none||none|
|landingUrlScheme|string|false|none||none|
|landingUrl|string|false|none||none|
|noAuth|object|false|none||none|
|simplePassword|object|false|none||none|
|hotspot|object|false|none||none|
|sms|[SmsSettingResOpenApiVo
](#schemasmssettingresopenapivo)|false|none||none|
|portalFormId|string|false|none||none|
|hotspotRadius|[HotspotRadiusSettingResOpenApiVo
](#schemahotspotradiussettingresopenapivo)|false|none||none|
|externalPortal|object|false|none||none|
|externalRadius|[ExternalRadiusSettingResOpenApiVo
](#schemaexternalradiussettingresopenapivo)|false|none||none|
|ldap|[LdapSetting
](#schemaldapsetting)|false|none||none|
RefundResponse
```json
{
"status": "string",
"message": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|status|string|false|none||none|
|message|string|false|none||none|
RPortalDetailResOpenApiVo
```json
{
"code": 0,
"msg": "string",
"data": {
"id": "string",
"name": "string",
"enable": true,
"ssidList": [
"string"
],
"networkList": [
"string"
],
"authType": 0,
"authTimeout": {
"authTimeout": 0,
"customTimeout": 0,
"customTimeoutUnit": 0
},
"httpsRedirectEnable": true,
"landingPage": 0,
"landingUrlScheme": "string",
"landingUrl": "string",
"noAuth": {},
"simplePassword": {},
"hotspot": {},
"sms": {
"sid": "string",
"authToken": "string",
"phoneNum": "string",
"maxVerificationCodeEnable": true,
"maxVerificationCodeTimes": 0,
"authTimeout": {
"authTimeout": 0,
"customTimeout": 0,
"customTimeoutUnit": 0
},
"countryCode": "string"
},
"portalFormId": "string",
"hotspotRadius": {
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"authTimeout": {
"authTimeout": 0,
"customTimeout": 0,
"customTimeoutUnit": 0
},
"disconnectReq": true,
"receiverPort": 0,
"receiverPortStatus": 0
},
"externalPortal": {},
"externalRadius": {
"radiusProfileId": "string",
"authMode": 0,
"nasId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string",
"disconnectReq": true,
"receiverPort": 0,
"receiverPortStatus": 0
},
"ldap": {
"ldapProfileId": "string",
"portalCustom": 0,
"externalUrlScheme": "string",
"externalUrl": "string"
}
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[PortalDetailResOpenApiVo
](#schemaportaldetailresopenapivo)|false|none||none|
PaymentRequest
```json
{
"userId": 0,
"cardNumber": "string",
"cardLastFour": "string",
"cardHolderName": "string",
"expirationDate": "string",
"cvv": "string",
"amount": 0.1,
"token": "string",
"cardType": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|userId|integer(int64)|false|none||none|
|cardNumber|string|false|none||none|
|cardLastFour|string|false|none||none|
|cardHolderName|string|false|none||none|
|expirationDate|string|false|none||none|
|cvv|string|false|none||none|
|amount|number(double)|false|none||none|
|token|string|false|none||none|
|cardType|string|false|none||none|
SmsSettingResOpenApiVo
```json
{
"sid": "string",
"authToken": "string",
"phoneNum": "string",
"maxVerificationCodeEnable": true,
"maxVerificationCodeTimes": 0,
"authTimeout": {
"authTimeout": 0,
"customTimeout": 0,
"customTimeoutUnit": 0
},
"countryCode": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|sid|string|false|none||none|
|authToken|string|false|none||none|
|phoneNum|string|false|none||none|
|maxVerificationCodeEnable|boolean|false|none||none|
|maxVerificationCodeTimes|integer(int32)|false|none||none|
|authTimeout|[AuthTimeOpenApiVo
](#schemaauthtimeopenapivo)|false|none||none|
|countryCode|string|false|none||none|
PaymentResponse
```json
{
"success": true,
"message": "string",
"transactionId": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|success|boolean|false|none||none|
|message|string|false|none||none|
|transactionId|string|false|none||none|
UOrder
```json
{
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"userId": 0,
"packageId": 0,
"paymentId": 0,
"orderNo": "string",
"type": 0,
"orderAmount": 0,
"status": 0,
"currency": "string",
"upackage": {
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitId": 0,
"packageName": "string",
"periodNum": 0,
"periodType": 0,
"price": 0,
"traffic": 0,
"duration": 0,
"clientNum": 0,
"remark": "string",
"rateLimitEnable": true,
"trafficEnable": true,
"durationEnable": true,
"clientNumEnable": true,
"packageEnable": true,
"rateLimits": {
"id": 0,
"delFlag": true,
"createBy": 0,
"createTime": "2019-08-24T14:15:22Z",
"updateBy": 0,
"updateTime": "2019-08-24T14:15:22Z",
"rateLimitName": "string",
"downLimit": 0,
"downLimitEnable": true,
"upLimit": 0,
"upLimitEnable": true
}
}
}
```
用户平台-订单表
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|id|integer(int64)|false|none||none|
|delFlag|boolean|false|none||none|
|createBy|integer(int64)|false|none||none|
|createTime|string(date-time)|false|none||none|
|updateBy|integer(int64)|false|none||none|
|updateTime|string(date-time)|false|none||none|
|userId|integer(int64)|false|none||用户ID|
|packageId|integer(int64)|false|none||套餐ID|
|paymentId|integer(int64)|false|none||支付ID|
|orderNo|string|false|none||订单编号|
|type|integer(int32)|false|none||订单类型(0套餐 1充值)|
|orderAmount|number|false|none||订单金额|
|status|integer(int32)|false|none||订单状态(0待支付 1已支付 2已取消)|
|currency|string|false|none||none|
|upackage|[UPackage
](#schemaupackage)|false|none||用户平台-套餐表|
AlipayFundAuthOrderFreezeResponse
```json
{
"code": "string",
"msg": "string",
"subCode": "string",
"subMsg": "string",
"body": "string",
"params": {
"property1": "string",
"property2": "string"
},
"amount": "string",
"authNo": "string",
"creditAmount": "string",
"fundAmount": "string",
"gmtTrans": "2019-08-24T14:15:22Z",
"operationId": "string",
"outOrderNo": "string",
"outRequestNo": "string",
"payerLogonId": "string",
"payerOpenId": "string",
"payerUserId": "string",
"preAuthType": "string",
"status": "string",
"transCurrency": "string",
"success": true,
"errorCode": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|string|false|none||none|
|msg|string|false|none||none|
|subCode|string|false|none||none|
|subMsg|string|false|none||none|
|body|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|string|false|none||none|
|amount|string|false|none||none|
|authNo|string|false|none||none|
|creditAmount|string|false|none||none|
|fundAmount|string|false|none||none|
|gmtTrans|string(date-time)|false|none||none|
|operationId|string|false|none||none|
|outOrderNo|string|false|none||none|
|outRequestNo|string|false|none||none|
|payerLogonId|string|false|none||none|
|payerOpenId|string|false|none||none|
|payerUserId|string|false|none||none|
|preAuthType|string|false|none||none|
|status|string|false|none||none|
|transCurrency|string|false|none||none|
|success|boolean|false|none||none|
|errorCode|string|false|none||none|
UKycUserBo
```json
{
"userId": 0,
"realName": "string",
"status": 0,
"createTimeStart": "string",
"createTimeEnd": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|userId|integer(int64)|false|none||none|
|realName|string|false|none||none|
|status|integer(int32)|false|none||none|
|createTimeStart|string|false|none||none|
|createTimeEnd|string|false|none||none|
AlipayFundCouponOrderAgreementPayResponse
```json
{
"code": "string",
"msg": "string",
"subCode": "string",
"subMsg": "string",
"body": "string",
"params": {
"property1": "string",
"property2": "string"
},
"amount": "string",
"authNo": "string",
"gmtTrans": "2019-08-24T14:15:22Z",
"operationId": "string",
"outOrderNo": "string",
"outRequestNo": "string",
"status": "string",
"success": true,
"errorCode": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|string|false|none||none|
|msg|string|false|none||none|
|subCode|string|false|none||none|
|subMsg|string|false|none||none|
|body|string|false|none||none|
|params|object|false|none||none|
|» **additionalProperties**|string|false|none||none|
|amount|string|false|none||none|
|authNo|string|false|none||none|
|gmtTrans|string(date-time)|false|none||none|
|operationId|string|false|none||none|
|outOrderNo|string|false|none||none|
|outRequestNo|string|false|none||none|
|status|string|false|none||none|
|success|boolean|false|none||none|
|errorCode|string|false|none||none|
RVoid
```json
{
"code": 0,
"msg": "string",
"data": {}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|object|false|none||none|
WxPayBean
```json
{
"appId": "string",
"appSecret": "string",
"mchId": "string",
"partnerKey": "string",
"certPath": "string",
"domain": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|appId|string|false|none||none|
|appSecret|string|false|none||none|
|mchId|string|false|none||none|
|partnerKey|string|false|none||none|
|certPath|string|false|none||none|
|domain|string|false|none||none|
RSysPayConfigBo
```json
{
"code": 0,
"msg": "string",
"data": {
"currency": "string",
"currencySymbol": "string",
"paymentMethods": [
"string"
]
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[SysPayConfigBo
](#schemasyspayconfigbo)|false|none||none|
AliPayApiConfig
```json
{
"privateKey": "string",
"aliPayPublicKey": "string",
"appId": "string",
"serviceUrl": "string",
"charset": "string",
"signType": "string",
"format": "string",
"certModel": true,
"appCertPath": "string",
"appCertContent": "string",
"aliPayCertPath": "string",
"aliPayCertContent": "string",
"aliPayRootCertPath": "string",
"aliPayRootCertContent": "string",
"exParams": {},
"domain": "string",
"aliPayClient": {}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|privateKey|string|false|none||none|
|aliPayPublicKey|string|false|none||none|
|appId|string|false|none||none|
|serviceUrl|string|false|none||none|
|charset|string|false|none||none|
|signType|string|false|none||none|
|format|string|false|none||none|
|certModel|boolean|false|none||none|
|appCertPath|string|false|none||none|
|appCertContent|string|false|none||none|
|aliPayCertPath|string|false|none||none|
|aliPayCertContent|string|false|none||none|
|aliPayRootCertPath|string|false|none||none|
|aliPayRootCertContent|string|false|none||none|
|exParams|object|false|none||none|
|domain|string|false|none||none|
|aliPayClient|[AlipayClient
](#schemaalipayclient)|false|none||none|
UCdrHistoryUserBo
```json
{
"userId": 0,
"userName": "string",
"clientName": "string",
"clientMac": "string",
"startTimeS": 0,
"startTimeE": 0,
"endTimeS": 0,
"endTimeE": 0
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|userId|integer(int64)|false|none||none|
|userName|string|false|none||none|
|clientName|string|false|none||none|
|clientMac|string|false|none||none|
|startTimeS|integer(int64)|false|none||none|
|startTimeE|integer(int64)|false|none||none|
|endTimeS|integer(int64)|false|none||none|
|endTimeE|integer(int64)|false|none||none|
AlipayClient
```json
{}
```
### 属性
*None*
RPortalAccessControlOpenApiVo
```json
{
"code": 0,
"msg": "string",
"data": {
"preAuthAccessEnable": true,
"preAuthAccessPolicies": [
{
"idInt": 0,
"type": 0,
"ip": "string",
"subnetMask": 0,
"url": "string"
}
],
"freeAuthClientEnable": true,
"freeAuthClientPolicies": [
{
"idInt": 0,
"type": 0,
"clientIp": "string",
"clientMac": "string"
}
]
}
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|code|integer(int32)|false|none||none|
|msg|string|false|none||none|
|data|[PortalAccessControlOpenApiVo
](#schemaportalaccesscontrolopenapivo)|false|none||none|
JdPayBean
```json
{
"mchId": "string",
"rsaPrivateKey": "string",
"desKey": "string",
"rsaPublicKey": "string",
"certPath": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|mchId|string|false|none||none|
|rsaPrivateKey|string|false|none||none|
|desKey|string|false|none||none|
|rsaPublicKey|string|false|none||none|
|certPath|string|false|none||none|
DeleteSiteAlertLogListOpenApiVo
```json
{
"logs": [
"string"
],
"selectType": "string",
"startTime": 0,
"endTime": 0,
"filterModule": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|logs|[string
]|false|none||none|
|selectType|string|true|none||none|
|startTime|integer(int64)|true|none||none|
|endTime|integer(int64)|true|none||none|
|filterModule|string|false|none||none|
UnionPayBean
```json
{
"machId": "string",
"key": "string",
"serverUrl": "string",
"domain": "string"
}
```
### 属性
|名称|类型|必选|约束|中文名|说明|
|---|---|---|---|---|---|
|machId|string|false|none||none|
|key|string|false|none||none|
|serverUrl|string|false|none||none|
|domain|string|false|none||none|