二维码门禁的通行权限配置

路径 /entrance/paas/perm/qrcode/config
版本号 1.0.1
协议 HTTPS
请求方法 POST
是否需要用户身份鉴权 可选
超时时间 20000

请求参数

名称 类型 是否必选 示例值 描述
qrCode String 二维码
iotIds List 待配置权限的门禁设备iotId
identityId String 待分配二维码权限的人的统一身份ID
expiryTime String 2020-03-04 18:00:00 二维码有效期,时间格式 yyyy-MM-dd HH:mm:ss",不能超过生效时间+24小时
effectiveTime String 2020-03-04 18:00:00 二维码生效期,时间格式 yyyy-MM-dd HH:mm:ss
maxScanTimes Int 二维码权限配置
maxScanScope String DEVICE 最大刷码次数作用范围,默认为每个设备独立计数 SHARE – 共享 DEVICE – 设备

返回数据

名称 类型 示例值 描述
code Int

响应码, 200: 成功

message String

错误消息

localizedMsg String

本地语言错误消息

data JSON

响应结果

code Int

返回码

message String

错误消息

iotId String

设备iotId

示例

请求示例

{
	"id": "1509086454180",
	"version": "1.0",
	"request":{
		"apiVer": "1.0.1"
	},
	"params":{
		"qrCode": "value0",
		"iotIds": "value1",
		"identityId": "value2",
		"expiryTime": "2020-03-04 18:00:00",
		"effectiveTime": "2020-03-04 18:00:00",
		"maxScanTimes": "value5",
		"maxScanScope": "DEVICE"
	}
}

正常返回示例

JSON 格式

{
    "id": "4de2c367-c1db-417c-aa15-8c585e595d92",
    "code": 200,
    "message": null,
    "localizedMsg": null,
    "data": [
        {
          "iotId": "p2OsgId2N2kXMWThRCQP******",
          "code": "200"
        }
      ]
}

异常返回示例

JSON 格式

{
    "id": "37f7e5fa-d6a5-4efe-8abf-5bf23dca6284",
    "code": 403,
    "message": "request forbidden.",
    "localizedMsg": "请求被禁止",
    "data": null
}

错误码

HttpCode 错误码 错误信息 描述
500 500 Internal Error Internal Error
503 503 Service Unavailable Service Unavailable
403 403 Request Limited Request Limited
401 401 Empty Signature Empty Signature
400 400 Request Format Error Request Format Error
200 20003 Find Backend Error Find Backend Error
200 20004 Backend Service Error Backend Service Error
200 20055 Backend Service Invalid Request Format Error
200 20056 Hsf Invoke Timeout Hsf Invoke Timeout
200 401 Request Authorized Error Request Authorized Error
200 403 Request Forbidden Request Forbidden
200 500 Server Error Server Error
200 2459 oa error message 会话Id不存在
200 2459 oa error message 会话Id不存在
200 2402 iotToken not exist
200 2402 iotToken not exist
200 2401 refreshToken invalid refreshToken已经失效
200 2401 refreshToken invalid refreshToken已经失效
200 460 identityIds need between 1-50 入参错误
200 460 identityIds need between 1-50 入参错误
200 403 request forbidden. 请求被禁止
200 403 request forbidden. 请求被禁止
200 403 request forbidden. 请求被禁止
200 403 request forbidden. 请求被禁止
200 403 request forbidden. 请求被禁止
200 460 request parameter error. 入参不正确
200 403 request forbidden 访问被禁止
200 460 dingdingbind employee not exist 请求参数错误
200 2442 employee is not exist 未找到绑定的员工信息
200 403 request forbidden 访问被禁止
200 460 dingdingbind employee not exist 请求参数错误
200 2442 employee is not exist 未找到绑定的员工信息
200 403 request forbidden 访问被禁止
200 460 dingdingbind employee not exist 请求参数错误
200 2442 employee is not exist 未找到绑定的员工信息
200 403 request forbidden 访问被禁止
200 460 dingdingbind employee not exist 请求参数错误
200 2442 employee is not exist 未找到绑定的员工信息
200 2402 registerAccount failed 账号注册失败
200 2404 oa error message 手机号格式不正确
200 2402 registerAccount failed 账号注册失败
200 2404 oa error message 手机号格式不正确
200 2402 registerAccount failed 账号注册失败
200 2404 oa error message 手机号格式不正确
200 403 request forbidden. 请求被禁止
200 403 request forbidden. 请求被禁止
200 2405 identity is not existed 公司未初始化
200 2441 employee is already existed 该手机号对应的员工已经存在
200 2405 identity is not existed 公司未初始化
200 2441 employee is already existed 该手机号对应的员工已经存在
200 460 request parameter error. 入参错误
200 460 request parameter error. 入参错误
200 20008 token invalid token已失效