更新时间:2024-05-21 GMT+08:00
分享

获取巡航轨迹列表

功能介绍

获取巡航轨迹列表(目前只支持好望设备)

URI

GET /v1/{user_id}/devices/{device_id}/channels/{channel_id}/cruise-track/list

表1 路径参数

参数

是否必选

参数类型

描述

channel_id

String

通道ID校验:目前只支持好望设备,取值范围[-1,999]

device_id

String

设备ID:

好望设备:大小写字母、数字组成,长度范围[8,32],可在设备外壳或者设备web页面上获取

user_id

String

用户ID:由数字组成,长度范围[15,25],获取方式参考获取user ID与下载AK/SK

请求参数

表2 请求Header参数

参数

是否必选

参数类型

描述

Access-Token

String

用户认证AccessToken:从获取用户北向接口认证AccessToken中获取

响应参数

状态码: 200

表3 响应Body参数

参数

参数类型

描述

device_id

String

设备ID

channel_id

String

通道ID

cruises_ids

Array of GetCruiseTracksItem objects

巡航轨迹ID列表

表4 GetCruiseTracksItem

参数

参数类型

描述

cruises_id

Integer

巡航轨迹ID

cruises_name

String

巡航轨迹名称

enable_cruise

String

启停状态,枚举值:

  • OPEN:开启
  • CLOSE:关闭

请求示例

获取巡航轨迹列表

GET /v1/2562572829***/devices/952352LWXT***/channels/1/cruise-track/list

响应示例

状态码: 200

OK

{
  "device_id" : "952352LWXT***",
  "channel_id" : "1",
  "cruises_ids" : [ {
    "cruises_id" : 1,
    "cruises_name" : "巡航轨迹名称",
    "enable_cruise" : "OPEN"
  } ]
}

状态码

请参见状态码

错误码

请参见错误码

相关文档