com.hp.message.interfaces

接口 IRetrofitApiService

@RetrofitClient(baseUrl="https://cloud.hpiot.cn/",
                converterFactories=FastJsonConverterFactory.class,
                logLevel=INFO,
                logStrategy=BASIC)
 @ApiSign(include="/api/sdk/**")
public interface IRetrofitApiService

作者:

尚肖磊 2021-06-22 17:01 平台API接口类定义

方法概要

限定符和类型	方法和说明
ApiResp<AddEquiResult>	addEqui(AddEquiParam addEquiParam) 添加设备
ApiResp<List<AddEquiResult>>	addEquiByList(List<AddEquiParam> addEquiParamList) 批量添加设备
ApiResp	addGroup(int projectId, String groupName, int groupSort, String groupDesc) 创建项目分组接口
ApiResp	addProject(String projectName, String projectDesc) 新增项目接口
ApiResp	alterEquiBySno(String equiSno, int projectId, int groupId, String equiName, String equiPassword) 修改设备信息接口
ApiResp	alterGroup(int groupId, String groupName, int groupSort, String groupDesc) 修改项目分组接口
ApiResp	alterProject(int projectId, String projectName) 修改项目名称接口
ApiResp	alterProjectTransferStatus(int projectId, boolean enableTransfer) 修改项目透传状态接口
ApiResp<List<ProjectResult>>	getAppProjectList() 获取应用 绑定项目列表接口
ApiResp<EquiResult>	getEquiInfo(String equiSno) 获取设备详情接口
ApiResp	getEquiInfoBySno(String equiSno) 获取设备详情
ApiResp<List<EquiResult>>	getEquiList(int projectId, int groupId, int equiStatus, String dataHandleType) 获取设备列表接口
ApiResp<List<StatusResult>>	getEquiWorkStatusList() 获取设备状态列表接口
ApiResp<List<GroupResult>>	getGroupList(int projectId, String groupName) 获取分组列表接口
ApiResp	removeEquiBySno(String equiSno) 删除设备接口
ApiResp	removeEquiBySnos(String equiSnos) 批量删除设备接口
ApiResp	removeGroupById(int groupId) 删除项目分组
ApiResp	removeProjectById(int projectId) 删除项目
ApiResp	unbindProject(int projectId) 解绑应用与项目接口

方法详细资料

addProject

@FormUrlEncoded
 @POST(value="api/sdk/project/addProject")
ApiResp addProject(@Field(value="projectName")
                                                                                String projectName,
                                                                                @Field(value="projectDesc")
                                                                                String projectDesc)

新增项目接口

参数:

projectName - 项目名称

返回:

alterProject

@FormUrlEncoded
 @POST(value="api/sdk/project/alterProject")
ApiResp alterProject(@Field(value="projectId")
                                                                                    int projectId,
                                                                                    @Field(value="projectName")
                                                                                    String projectName)

修改项目名称接口

参数:

projectId - 项目id

projectName - 修改后项目名称

返回:

removeProjectById

@FormUrlEncoded
 @POST(value="api/sdk/project/removeProjectById")
ApiResp removeProjectById(@Field(value="projectId")
                                                                                              int projectId)

删除项目

参数:

projectId - 项目id

返回:

getAppProjectList

@GET(value="api/sdk/project/getAppProjectList")
ApiResp<List<ProjectResult>> getAppProjectList()

获取应用 绑定项目列表接口

返回:

alterProjectTransferStatus

@FormUrlEncoded
 @POST(value="api/sdk/project/alterProjectTransferStatus")
ApiResp alterProjectTransferStatus(@Field(value="projectId")
                                                                                                                int projectId,
                                                                                                                @Field(value="enableTransfer")
                                                                                                                boolean enableTransfer)

修改项目透传状态接口

参数:

projectId - 项目id

enableTransfer - 透传状态 true 开启 false 关闭

返回:

unbindProject

@FormUrlEncoded
 @POST(value="api/sdk/project/unbindProject")
ApiResp unbindProject(@Field(value="projectId")
                                                                                      int projectId)

解绑应用与项目接口

参数:

projectId - 项目id

返回:

getGroupList

@GET(value="api/sdk/group/getGroupList")
ApiResp<List<GroupResult>> getGroupList(@Query(value="projectId")
                                                                                  int projectId,
                                                                                  @Query(value="groupName")
                                                                                  String groupName)

获取分组列表接口

参数:

projectId - 项目id

groupName - 查询分组名称(模糊匹配)

返回:

addGroup

@FormUrlEncoded
 @POST(value="api/sdk/group/addGroup")
ApiResp addGroup(@Field(value="projectId")
                                                                          int projectId,
                                                                          @Field(value="groupName")
                                                                          String groupName,
                                                                          @Field(value="groupSort")
                                                                          int groupSort,
                                                                          @Field(value="groupDesc")
                                                                          String groupDesc)

创建项目分组接口

参数:

projectId - 项目id

groupName - 项目分组名称

groupSort - 项目分组排序值

groupDesc - 项目分组描述

返回:

alterGroup

@FormUrlEncoded
 @POST(value="api/sdk/group/alterGroup")
ApiResp alterGroup(@Field(value="groupId")
                                                                              int groupId,
                                                                              @Field(value="groupName")
                                                                              String groupName,
                                                                              @Field(value="groupSort")
                                                                              int groupSort,
                                                                              @Field(value="groupDesc")
                                                                              String groupDesc)

修改项目分组接口

参数:

groupId - 项目分组id

groupName - 项目分组名称

groupSort - 项目分组排序值

groupDesc - 项目分组描述

返回:

removeGroupById

@FormUrlEncoded
 @POST(value="api/sdk/group/removeGroupById")
ApiResp removeGroupById(@Field(value="groupId")
                                                                                        int groupId)

删除项目分组

参数:

groupId - 项目分组id

返回:

getEquiInfo

@GET(value="api/sdk/equi/getEquiInfoBySno")
ApiResp<EquiResult> getEquiInfo(@Query(value="equiSno")
                                                                             String equiSno)

获取设备详情接口

参数:

equiSno - 设备sno

返回:

getEquiList

@GET(value="api/sdk/equi/getEquiList")
ApiResp<List<EquiResult>> getEquiList(@Query(value="projectId")
                                                                              int projectId,
                                                                              @Query(value="groupId")
                                                                              int groupId,
                                                                              @Query(value="equiStatus")
                                                                              int equiStatus,
                                                                              @Query(value="dataHandleType")
                                                                              String dataHandleType)

获取设备列表接口

参数:

projectId - 项目id

groupId - 项目分组id

equiStatus - 设备状态(状态接口获取)

dataHandleType - 数据处理方式(数据处理方式接口获取)

返回:

getEquiWorkStatusList

@GET(value="api/sdk/equi/getEquiWorkStatusList")
ApiResp<List<StatusResult>> getEquiWorkStatusList()

获取设备状态列表接口

返回:

addEqui

@POST(value="api/sdk/equi/addEqui")
ApiResp<AddEquiResult> addEqui(@Body
                                                                    AddEquiParam addEquiParam)

添加设备

参数:

addEquiParam - 注册设备JSON对象

返回:

addEquiByList

@POST(value="api/sdk/equi/addEquiByList")
ApiResp<List<AddEquiResult>> addEquiByList(@Body
                                                                                      List<AddEquiParam> addEquiParamList)

批量添加设备

参数:

addEquiParamList - 注册设备JSON对象列表

返回:

alterEquiBySno

@FormUrlEncoded
 @POST(value="api/sdk/equi/alterEquiBySno")
ApiResp alterEquiBySno(@Field(value="equiSno")
                                                                                     String equiSno,
                                                                                     @Field(value="projectId")
                                                                                     int projectId,
                                                                                     @Field(value="groupId")
                                                                                     int groupId,
                                                                                     @Field(value="equiName")
                                                                                     String equiName,
                                                                                     @Field(value="equiPassword")
                                                                                     String equiPassword)

修改设备信息接口

参数:

equiSno - 设备sno

projectId - 项目id

groupId - 分组id

equiName - 设备名称

equiPassword - 设备通讯密码

返回:

removeEquiBySno

@FormUrlEncoded
 @POST(value="api/sdk/equi/removeEquiBySno")
ApiResp removeEquiBySno(@Field(value="equiSno")
                                                                                       String equiSno)

删除设备接口

参数:

equiSno - 设备sno

返回:

removeEquiBySnos

@FormUrlEncoded
 @POST(value="api/sdk/equi/removeEquiBySnos")
ApiResp removeEquiBySnos(@Field(value="equiSnos")
                                                                                         String equiSnos)

批量删除设备接口

参数:

equiSnos - 设备ids(格式 1,2,3,4)

返回:

getEquiInfoBySno

@FormUrlEncoded
 @POST(value="api/sdk/equi/getEquiInfoBySno")
ApiResp getEquiInfoBySno(@Field(value="equiSno")
                                                                                         String equiSno)

获取设备详情

参数:

equiSno -

返回: