施工员管理

施工员管理，施工员可登录智慧工程APP或施工sdk，对房屋进行施工、设备配网、设备维修等操作。

API列表

请求方式	API	描述
GET	/v1.0/osaas/construction/workers	分页查询施工员列表
POST	/v1.0/osaas/construction/worker	新增施工员
DELETE	/v1.0/osaas/construction/workers/{worker_id}	删除施工员

分页查询施工员列表

接口描述

调用该接口分页查询施工员列表

接口地址

GET /v1.0/osaas/construction/workers

请求参数

参数名	类型	参数类型	说明	是否必需
page_no	Integer	URL	页码(page_no>0)(默认1)	否
page_size	Integer	URL	页条数(0<page_size<100)(默认20)	否

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Object	施工人员分页结果

result参数说明

参数名	类型	说明
total	Integer	总条数
page_no	Integer	页码
page_size	Integer	页条数
workers	Arrays	施工员列表

workers参数说明

参数名	类型	说明
worker_id	String	施工员唯一标识
username	String	施工员用户名
nickname	String	施工员昵称

请求示例

GET {url}/v1.0/osaas/construction/workers?page_no=1&page_size=20

响应成功示例

{
  "result": {
    "total": 1,
    "page_no": 1,
    "page_size": 20,
    "workers": [
      {
        "worker_id": "130641181272348xxxx",
        "username": "test@tuya.com",
        "nickname": "Test worker"
      }
    ]
  },
  "success": true,
  "t": 1572936751228
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

新增施工员

接口描述

调用该接口新增施工员

接口地址

POST /v1.0/osaas/construction/worker

请求参数

参数名	类型	参数类型	说明	是否必需
country_code	String	BODY	国家码(中国:86)	是
username	String	BODY	用户名(最大28个字符)	是
nickname	String	BODY	昵称(最大20个字符)	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	String	施工人员唯一标识

请求示例

POST {url}/v1.0/osaas/construction/worker

{
  "country_code": "86",
  "username": "test@tuya.com",
  "nickname": "张三"
}

响应成功示例

{
  "success": true,
  "result": "1112382396505******",
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

删除施工员

接口描述

调用该接口删除施工员

接口地址

DELETE /v1.0/osaas/construction/workers/{worker_id}

请求参数

参数名	类型	参数类型	说明	是否必需
worker_id	String	URI	施工员唯一标识	是

响应参数

参数名	类型	说明
code	Integer	响应码（详情见错误码章节），成功时为空
success	Boolean	是否成功：（true：成功，false：失败）
msg	String	请求失败的信息，成功时为空
t	Long	返回时间戳，13位
result	Boolean	操作结果

请求示例

DELETE {url}/v1.0/osaas/construction/workers/130641181272348******

响应成功示例

{
  "success": true,
  "result": true,
  "t": 1566053034624
}

响应失败示例

{
  "code": 500,
  "msg": "system error,please contact the admin",
  "success": false,
  "t": 1561378856383
}

错误码

以下为该接口常见的业务异常，更多的异常错误，请参见全局错误码。

错误码	说明
500	系统错误