获取企业地图列表
概述
- 此 API 用于获取企业下的地图列表；
授权方式
| 数据维度授权 | 企业级授权 | 此 API 为企业级授权，企业级授权和代理商级授权的授权账号均可以调用此 API。请参考 授权方式。 |
|---|
| 接口维度授权 | 默认授权 | 此 API 为默认授权，您无需为您的授权账号额外申请接口维度授权就可以调用。请参考 授权方式。 |
|---|
请求
请求域名
请求协议
| HTTP URL 路径 | /v1/corp/map_list |
|---|---|
| HTTP Method | GET |
请求 URL 参数
| 参数 | 类型 | 必填 | 参数说明 |
|---|---|---|---|
| ov_corpid | string | 是 | 企业 id。 |
| map_name | string | 否 | 地图名称，完全匹配。不传递则不限制。 |
| page | int | 否 | 分页参数。当前是第几页，从 1 开始，默认是 1。 |
| page_rows | int | 否 | 分页参数。每页多少条数据，默认是 1。 |
请求 cURL 示例
# 请根据您的区域替换域名 curl --location 'https://openapi.orionstar.com/v1/corp/map_list?ov_corpid=test_ov_corpid' \ --header 'Authorization: Bearer YOUR-ACCESS-TOKEN'
响应
公共响应体
| 参数 | 类型 | 参数说明 |
|---|---|---|
| code | int | 错误代码。0 是成功，非 0 是失败，请参考 错误代码。 |
| msg | string | 错误描述，当失败的时候会给出具体的错误描述。 |
| req_id | string | 日志跟踪 id，当遇到问题需要猎户星空协助查问题时候，请提供此跟踪 id 值。 |
| data | object | 业务数据 data 对象，详见下述 响应体 data 对象。 |
响应体 data 对象
| 参数 | 类型 | 参数说明 |
|---|---|---|
| total_count | string | 分页参数。一共有多少条数据。 |
| map_list | array | 地图信息对象列表数组，此数组中的每个元素都是一个地图信息对象。 |
| map_list[].map | object | 地图信息对象，请参考 map - 机器人地图信息对象。 |
map - 机器人地图信息对象
| 参数 | 类型 | 参数说明 |
|---|---|---|
| map_id | string | 地图 id |
| map_name | string | 地图名称 |
| create_time | string | 创建时间，整数时间戳，单位是秒。 |
| update_time | string | 最后修改时间，整数时间戳，单位是秒。 |
响应体示例
{ "code": 0, "msg": "", "data": { "total_count": "1", "map_list" : [ { "map" : { "map_id": "test_id", "map_name": "测试地图-0107152028", "create_time": "1547021774", "update_time": "1562222558" }, }, // ... 其他地图信息 ] } }