ES Documentation
手册
API
手册
API
简体中文

添加共享

OpenAPI 文档点击此处查阅中心服务器数据服务在设备类别下的 OpenAPI 文档。

以下内容为提升开发效率，在代码开发前，提供请求与响应的示例示意，助力开发人员深入理解业务需求。同时，这也是对代码注释生成的 OpenAPI 文档的补充说明，会对代码注释未覆盖的部分展开详细阐释，从而减轻代码开发的工作量。

请求路径

/main-service/main-api/v1/retail/device/data-acquisition-device/share

请求结构 (Api request)

字段

TIP
  • deviceId: 设备标识, 设备列表中包含
  • deviceManage: 共享者用户名
  • targetUsername 被共享者的用户名(targetUsername, targetEmail, targetPhoneNumber 三者至少有一个不为空)
  • targetEmail 被共享者的邮箱名(targetUsername, targetEmail, targetPhoneNumber 三者至少有一个不为空)
  • targetPhoneNumber 被共享者的手机号码(targetUsername, targetEmail, targetPhoneNumber 三者至少有一个不为空)

示例

HTTP: request body application/json
1{
2  "deviceId": "123456",
3  "deviceManage": "admin",
4  "targetUsername": "user1",
5  "targetEmail": "user1@example.com",
6  "targetPhoneNumber": "1234567890"
7}

示意

TIP

原型设计

响应结构 (Api response)

字段

  • data: 响应数据，此为可选字段，仅在实际有数据需要返回时，才会呈现相应的内容。
TIP
  • error: 错误信息，此为可选字段, 以下为可能的错误信息：
    • Unable to share with oneself: 无法对自己分享
    • The user corresponding to the shared username does not exist: 分享用户名对应的用户不存在
    • The user corresponding to the shared email does not exist: 分享邮箱对应的用户不存在
    • The user corresponding to the shared phone number does not exist: 分享手机号对应的用户不存在
    • Sharing users have no personal space: 分享用户没有个人空间
    • Device sharing already exists: 设备分享已存在
    • The data collection device does not exist: 数据采集设备不存在
    • The data collection device shared with the user already exists: 分享给用户的数据采集设备已存在
    • Incorrect email: 电子邮件不正确
    • Incorrect phone number: 手机号码不正确
    • At least one of targetUsername, targetEmail, and targetPhoneNumber is not empty: targetUsername、targetEmail和targetPhoneNumber中至少有一个不为空

示例

HTTP: response application/json
1{
2  "status": 422,
3  "path": "/main-service/main-api/v1/retail/device/data-acquisition-device/share",
4  "error": "At least one of targetUsername, targetEmail, and targetPhoneNumber is not empty"
5}

示意

目录