| Version | Update Time | Status | Author | Description |
|---|---|---|---|---|
1.0.0 | 2023-10-23 15:00 | create | 杨宁 | 创建项目 |
1.0.1 | 2024-03-14 15:00 | update | 杨宁 | 修改已知问题 |
1. 账本服务接口
1.1. 添加账单
URL: /accountBook/addBill
Type: POST
Content-Type: application/json
Description: 添加账单
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
billType | int32 | false | 账单类型 1.收入 2.支出 |
billBizType | int32 | false | 账单业务类型 1.作业 2.记账 |
title | string | false | 作业名称或标题 |
jobPlotId | int64 | false | 作业地块ID |
customerName | string | false | 客户姓名 |
customerPhone | string | false | 客户电话 |
unitPrice | string | false | 单价(元/亩) |
jobArea | string | false | 作业面积 |
billDate | string | false | 记账日期 |
receivables | string | false | 应收款 |
amount | string | false | 金额 |
remark | string | false | 备注 |
Request-body:
{
"billType": 285,
"billBizType": 781,
"title": "mehyaf",
"jobPlotId": 251,
"customerName": "kelli.kunde",
"customerPhone": "501.714.6254",
"unitPrice": "hm1thb",
"jobArea": "ltqqhq",
"billDate": "2025-02-27",
"receivables": "atlhum",
"amount": "8myreu",
"remark": "q2xs1d"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | 账单ID | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 178
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /accountBook/addBill --data '{
"billType": 285,
"billBizType": 781,
"title": "mehyaf",
"jobPlotId": 251,
"customerName": "kelli.kunde",
"customerPhone": "501.714.6254",
"unitPrice": "hm1thb",
"jobArea": "ltqqhq",
"billDate": "2025-02-27",
"receivables": "atlhum",
"amount": "8myreu",
"remark": "q2xs1d"
}'1.2. 查询账单列表并分页
Type: POST
Content-Type: application/json
Description: 查询账单列表并分页
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
page | int32 | true | 页码 |
pageSize | int32 | true | 每页条数 |
startTime | string | false | 开始时间 不填为全部 |
endTime | string | false | 结束时间 不填为全部 |
Request-body:
{
"page": 1,
"pageSize": 20,
"startTime": "2025-02-27 09:46:08",
"endTime": "2025-02-27"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数据量 | - |
└─rows | array | 数据行 | - |
└─id | int64 | 账单ID | - |
└─billType | int32 | 账单类型 1.收入 2.支出 | - |
└─billBizType | int32 | 账单业务类型 1.作业 2.记账 | - |
└─title | string | 作业名称或标题 | - |
└─customerName | string | 客户姓名 | - |
└─customerPhone | string | 客户电话 | - |
└─unitPrice | string | 单价(元/亩) | - |
└─jobArea | string | 作业面积 | - |
└─billDate | string | 记账日期 | - |
└─receivables | string | 应收款 | - |
└─amount | string | 金额 | - |
└─remark | string | 备注 | - |
└─jobPlotId | int64 | 作业地块ID | - |
└─plotThumbUrl | string | 地块缩略图 | - |
└─address | string | 地址 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"total": 15,
"rows": [
{
"id": 621,
"billType": 109,
"billBizType": 914,
"title": "ldft5r",
"customerName": "kelli.kunde",
"customerPhone": "501.714.6254",
"unitPrice": "xm8vyq",
"jobArea": "9ovyns",
"billDate": "2025-02-27",
"receivables": "i3t453",
"amount": "jy61nm",
"remark": "gyhqy9",
"jobPlotId": 208,
"plotThumbUrl": "www.kevin-raynor.us",
"address": "Suite 125 93484 Hessel Meadows, Port Edison, VA 04830"
}
]
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /accountBook/queryBillListByPage --data '{
"page": 1,
"pageSize": 20,
"startTime": "2025-02-27 09:46:08",
"endTime": "2025-02-27"
}'1.3. 获取账单详情
Type: POST
Content-Type: application/json
Description: 获取账单详情
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | true | 账单ID |
Request-body:
{
"id": 63
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | 账单ID | - |
└─billType | int32 | 账单类型 1.收入 2.支出 | - |
└─billBizType | int32 | 账单业务类型 1.作业 2.记账 | - |
└─title | string | 作业名称或标题 | - |
└─customerName | string | 客户姓名 | - |
└─customerPhone | string | 客户电话 | - |
└─unitPrice | string | 单价(元/亩) | - |
└─jobArea | string | 作业面积 | - |
└─billDate | string | 记账日期 | - |
└─receivables | string | 应收款 | - |
└─amount | string | 金额 | - |
└─remark | string | 备注 | - |
└─jobPlotId | int64 | 作业地块ID | - |
└─plotThumbUrl | string | 地块缩略图 | - |
└─address | string | 地址 | - |
└─cropTypeId | int64 | 作物类型ID | - |
└─cropTypeName | string | 作物类型名称 | - |
└─jobType | int32 | 作业类型 1.耕地 2.种植 3.管理 4.收获 | - |
└─jobTypeName | string | 作业类型名称 1.耕地 2.种植 3.管理 4.收获 | - |
└─jobEquipment | int32 | 作业机具 按字典 | - |
└─jobEquipmentName | string | 作业机具名称 按字典 | - |
└─outlinePoint | string | 轮廓点 | - |
└─wktData | string | WKT数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 773,
"billType": 851,
"billBizType": 735,
"title": "wqgkln",
"customerName": "kelli.kunde",
"customerPhone": "501.714.6254",
"unitPrice": "kz898o",
"jobArea": "q753t4",
"billDate": "2025-02-27",
"receivables": "d55hlv",
"amount": "xsf7b4",
"remark": "7ibifj",
"jobPlotId": 404,
"plotThumbUrl": "www.kevin-raynor.us",
"address": "Suite 125 93484 Hessel Meadows, Port Edison, VA 04830",
"cropTypeId": 33,
"cropTypeName": "kelli.kunde",
"jobType": 941,
"jobTypeName": "kelli.kunde",
"jobEquipment": 747,
"jobEquipmentName": "kelli.kunde",
"outlinePoint": "8k7e36",
"wktData": "i8v0e9"
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /accountBook/getBillDetail --data '{
"id": 63
}'1.4. 删除账单
Type: POST
Content-Type: application/json
Description: 删除账单
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | array | true | 账单ID组 |
Request-body:
{
"id": [
57
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /accountBook/deleteBill --data '{
"id": [
57
]
}'1.5. 获取账单统计
Type: POST
Content-Type: application/json
Description: 获取账单统计
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
startTime | string | false | 开始时间 不填为全部 |
endTime | string | false | 结束时间 不填为全部 |
Request-body:
{
"startTime": "2025-02-27 09:46:08",
"endTime": "2025-02-27"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─incomeTotal | double | 总收入 | - |
└─expenditureTotal | double | 总支出 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"incomeTotal": 37.16,
"expenditureTotal": 20.77
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /accountBook/getBillStat --data '{
"startTime": "2025-02-27 09:46:08",
"endTime": "2025-02-27"
}'2. 农机服务接口
2.1. 检查绑定农机信息
===此接口暂时不用,请调用慧农接口===
URL: /am/checkBindAm
Type: POST
Content-Type: application/json
Description: 检查绑定农机信息
===此接口暂时不用,请调用慧农接口===
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
did | string | true | 终端编号 |
Request-body:
{
"did": "168"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─amId | int64 | 农机ID | - |
└─orgId | int64 | 机构ID | - |
└─did | string | 终端编号 | - |
└─slotNumber | string | 板卡号 | - |
└─terminalType | int32 | 终端类型 1.TBOX 2.自动驾驶 3.打点器 | - |
└─lpn | string | 车牌号 | - |
└─amModel | string | 农机型号 | - |
└─amCategory | string | 农机类别 | - |
└─amOwnerName | string | 机主姓名 | - |
└─installDate | string | 安装日期 | - |
└─bindFlag | int32 | 绑定标志 0.未绑定 1.已绑定 2.已解绑 | - |
└─mainBindMobile | string | 主绑手机号 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"amId": 708,
"orgId": 142,
"did": "168",
"slotNumber": "sllz3i",
"terminalType": 778,
"lpn": "zvxrnh",
"amModel": "bdycdm",
"amCategory": "k3wwqu",
"amOwnerName": "kelli.kunde",
"installDate": "2025-02-27",
"bindFlag": 8,
"mainBindMobile": "(603) 260-1149"
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /am/checkBindAm --data '{
"did": "168"
}'2.2. 获取主绑手机号
Type: POST
Content-Type: application/json
Description: 获取主绑手机号
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
did | string | true | 终端编号 |
Request-body:
{
"did": "168"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─mainBindMobile | string | 主绑手机号 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"mainBindMobile": "(603) 260-1149"
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /am/getMainBindMobile --data '{
"did": "168"
}'2.3. 绑定农机
URL: /am/bindAm
Type: POST
Content-Type: application/json
Description: 绑定农机
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
did | string | true | 终端编号 |
slotNumber | string | false | 板卡号 |
terminalType | int32 | false | 终端类型 1.TBOX 2.自动驾驶 3.打点器 |
lpn | string | false | 车牌号 |
amModel | string | false | 农机型号 |
amCategory | string | false | 农机类别 |
amOwnerName | string | false | 机主姓名 |
installDate | string | false | 安装日期 |
amAlias | string | true | 农机别名 |
Request-body:
{
"did": "168",
"slotNumber": "fsudmu",
"terminalType": 356,
"lpn": "j4apvg",
"amModel": "449rkj",
"amCategory": "235ok7",
"amOwnerName": "kelli.kunde",
"installDate": "2025-02-27",
"amAlias": "vjpr2n"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /am/bindAm --data '{
"did": "168",
"slotNumber": "fsudmu",
"terminalType": 356,
"lpn": "j4apvg",
"amModel": "449rkj",
"amCategory": "235ok7",
"amOwnerName": "kelli.kunde",
"installDate": "2025-02-27",
"amAlias": "vjpr2n"
}'2.4. 解绑农机
URL: /am/unbindAm
Type: POST
Content-Type: application/json
Description: 解绑农机
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
amId | int64 | true | 农机ID |
mainBindFlag | int32 | false | 是否主绑 0.副绑 1.主绑 |
Request-body:
{
"amId": 420,
"mainBindFlag": 8
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /am/unbindAm --data '{
"amId": 420,
"mainBindFlag": 8
}'2.5. 查询农机列表并分页
Type: POST
Content-Type: application/json
Description: 查询农机列表并分页
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
page | int32 | true | 页码 |
pageSize | int32 | true | 每页条数 |
amSignalAuthExpiresQueryFlag | string | false | 农机信号授权到期查询标志 0.查询全部 1.只查询即将到期的 不填为全部 Validate[regexp: ^[0,1]$; ] |
Request-body:
{
"page": 1,
"pageSize": 20,
"amSignalAuthExpiresQueryFlag": "ict4ye"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数据量 | - |
└─rows | array | 数据行 | - |
└─id | int64 | 用户绑定农机ID | - |
└─amId | int64 | 农机ID | - |
└─did | string | 终端编号 | - |
└─slotNumber | string | 板卡号 | - |
└─terminalType | int32 | 终端类型 1.TBOX 2.自动驾驶 3.打点器 | - |
└─lpn | string | 车牌号 | - |
└─amModel | string | 农机型号 | - |
└─amCategory | string | 农机类别 | - |
└─manufacturerModel | string | 厂商型号 | - |
└─amOwnerName | string | 机主姓名 | - |
└─amOwnerPhone | string | 机主电话 | - |
└─installDate | string | 安装日期 | - |
└─installAddress | string | 安装地址 | - |
└─mainBindFlag | int32 | 是否主绑 0.副绑 1.主绑 | - |
└─mobile | string | 手机号 | - |
└─signalActivationStatus | int32 | 信号激活状态 0.未激活 1.已激活 | - |
└─signalAuthExpiresTime | string | 信号授权过期时间 | - |
└─signalAuthResidueDays | int32 | 信号授权剩余天数 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"total": 163,
"rows": [
{
"id": 457,
"amId": 903,
"did": "168",
"slotNumber": "gnjpit",
"terminalType": 363,
"lpn": "xpxy96",
"amModel": "xrb4gj",
"amCategory": "biec4p",
"manufacturerModel": "52j5k9",
"amOwnerName": "kelli.kunde",
"amOwnerPhone": "501.714.6254",
"installDate": "2025-02-27",
"installAddress": "Suite 125 93484 Hessel Meadows, Port Edison, VA 04830",
"mainBindFlag": 8,
"mobile": "(603) 260-1149",
"signalActivationStatus": 723,
"signalAuthExpiresTime": "2025-02-27 09:46:08",
"signalAuthResidueDays": 721
}
]
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /am/queryAmListByPage --data '{
"page": 1,
"pageSize": 20,
"amSignalAuthExpiresQueryFlag": "ict4ye"
}'2.6. 获取农机详情
URL: /am/getAmDetail
Type: POST
Content-Type: application/json
Description: 获取农机详情
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | true | 用户绑定农机ID |
Request-body:
{
"id": 115
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | 用户绑定农机ID | - |
└─amId | int64 | 农机ID | - |
└─did | string | 终端编号 | - |
└─slotNumber | string | 板卡号 | - |
└─terminalType | int32 | 终端类型 1.TBOX 2.自动驾驶 3.打点器 | - |
└─lpn | string | 车牌号 | - |
└─amModel | string | 农机型号 | - |
└─amCategory | string | 农机类别 | - |
└─manufacturerModel | string | 厂商型号 | - |
└─amOwnerName | string | 机主姓名 | - |
└─amOwnerPhone | string | 机主电话 | - |
└─installDate | string | 安装日期 | - |
└─installAddress | string | 安装地址 | - |
└─mainBindFlag | int32 | 是否主绑 0.副绑 1.主绑 | - |
└─mobile | string | 手机号 | - |
└─signalActivationStatus | int32 | 信号激活状态 0.未激活 1.已激活 | - |
└─signalAuthExpiresTime | string | 信号授权过期时间 | - |
└─signalAuthResidueDays | int32 | 信号授权剩余天数 | - |
└─terminalTypeName | string | 终端类型名称 1.TBOX 2.自动驾驶 3.打点器 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 916,
"amId": 345,
"did": "168",
"slotNumber": "66ia4q",
"terminalType": 500,
"lpn": "5i1sqv",
"amModel": "ojozso",
"amCategory": "z15a06",
"manufacturerModel": "at2snr",
"amOwnerName": "kelli.kunde",
"amOwnerPhone": "501.714.6254",
"installDate": "2025-02-27",
"installAddress": "Suite 125 93484 Hessel Meadows, Port Edison, VA 04830",
"mainBindFlag": 8,
"mobile": "(603) 260-1149",
"signalActivationStatus": 4,
"signalAuthExpiresTime": "2025-02-27 09:46:08",
"signalAuthResidueDays": 603,
"terminalTypeName": "kelli.kunde"
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /am/getAmDetail --data '{
"id": 115
}'2.7. 修改农机别名
URL: /am/updateAmAlias
Type: POST
Content-Type: application/json
Description: 修改农机别名
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
amId | int64 | true | 农机ID |
amAlias | string | true | 农机别名 |
Request-body:
{
"amId": 819,
"amAlias": "1klums"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /am/updateAmAlias --data '{
"amId": 819,
"amAlias": "1klums"
}'2.8. 获取农机信号授权即将到期信息
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取农机信号授权即将到期信息
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─amSignalAuthExpiresInfo | string | 农机信号授权即将到期信息 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"amSignalAuthExpiresInfo": "vh3v3w"
}
}Curl-example:
curl -X POST -i /am/getAmSignalAuthExpiresInfo3. 对象存储服务接口
3.1. 上传图片
URL: /cos/uploadFile
Type: POST
Content-Type: multipart/form-data
Description: 上传图片
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
folder | string | false | 文件夹 此处可填写业务名称,如:头像(avatar),作业地块图片(job_plot_images) 会在业务名称下再建立用户ID文件夹 如:某用户头像会放到:桶/avatar/用户ID 下面 | ||
uploadFile | file | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─bucketName | string | 桶名 | - |
└─fileName | string | 文件名 | - |
└─pathName | string | 路径名 | - |
└─url | string | URL地址 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"bucketName": "ylny",
"fileName": "abc.jpg",
"pathName": "/image/abc.jpg",
"url": "http://IP:PORT/ylny/image/abc.jpg"
}
}Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -F 'uploadFile=' -i /cos/uploadFile --data 'folder=image'4. H5页面服务接口
4.1. 用户协议
URL: /h5/userAgreement
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 用户协议
Response-example:
Forward or redirect to a page view.Curl-example:
curl -X GET -i /h5/userAgreement4.2. 首页banner
URL: /h5/homepageBanner
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 首页banner
Response-example:
Forward or redirect to a page view.Curl-example:
curl -X GET -i /h5/homepageBanner4.3. 打点器教程
URL: /h5/puncherTutorial
Type: GET
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 打点器教程
Response-example:
Forward or redirect to a page view.Curl-example:
curl -X GET -i /h5/puncherTutorial5. 注册登录服务接口
5.1. 登录-手机号密码
URL: /login/loginByMw
Type: POST
Content-Type: application/json
Description: 登录-手机号密码
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
mobile | string | true | 手机号 Validate[regexp: [1]([3-9])[0-9]{9}$; ] |
password | string | true | 密码 需要对密码MD5后传参 |
Request-body:
{
"mobile": "(603) 260-1149",
"password": "pjhe9j"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─userId | int64 | 用户ID | - |
└─token | string | token | - |
└─nickname | string | 昵称 | - |
└─gender | int32 | 性别 1 男 2 女 | - |
└─avatar | string | 头像 | - |
└─mobile | string | 手机号 | - |
└─hasPassword | int32 | 是否设置过密码 0 未设置 1 已设置 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"userId": 90,
"token": "zzaa0u",
"nickname": "kerrie.glover",
"gender": 0,
"avatar": "ufv3hc",
"mobile": "(603) 260-1149",
"hasPassword": 475
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /login/loginByMw --data '{
"mobile": "(603) 260-1149",
"password": "pjhe9j"
}'5.2. 注册
URL: /login/register
Type: POST
Content-Type: application/json
Description: 注册
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
mobile | string | true | 手机号 Validate[regexp: [1]([3-9])[0-9]{9}$; ] |
password | string | true | 密码 需要对密码MD5后传参 |
Request-body:
{
"mobile": "(603) 260-1149",
"password": "mnnetw"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─userId | int64 | 用户ID | - |
└─token | string | token | - |
└─nickname | string | 昵称 | - |
└─gender | int32 | 性别 1 男 2 女 | - |
└─avatar | string | 头像 | - |
└─mobile | string | 手机号 | - |
└─hasPassword | int32 | 是否设置过密码 0 未设置 1 已设置 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"userId": 41,
"token": "0dip3j",
"nickname": "kerrie.glover",
"gender": 0,
"avatar": "qd050m",
"mobile": "(603) 260-1149",
"hasPassword": 588
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /login/register --data '{
"mobile": "(603) 260-1149",
"password": "mnnetw"
}'5.3. 忘记密码,重置密码
URL: /login/resetPassword
Type: POST
Content-Type: application/json
Description: 忘记密码,重置密码
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
mobile | string | true | 手机号 Validate[regexp: [1]([3-9])[0-9]{9}$; ] |
newPassword | string | true | 新密码 |
Request-body:
{
"mobile": "(603) 260-1149",
"newPassword": "22adt7"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─userId | int64 | 用户ID | - |
└─token | string | token | - |
└─nickname | string | 昵称 | - |
└─gender | int32 | 性别 1 男 2 女 | - |
└─avatar | string | 头像 | - |
└─mobile | string | 手机号 | - |
└─hasPassword | int32 | 是否设置过密码 0 未设置 1 已设置 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"userId": 155,
"token": "yd7f9s",
"nickname": "kerrie.glover",
"gender": 0,
"avatar": "x2giiw",
"mobile": "(603) 260-1149",
"hasPassword": 569
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /login/resetPassword --data '{
"mobile": "(603) 260-1149",
"newPassword": "22adt7"
}'6. 测亩服务接口
6.1. 添加作业地块
Type: POST
Content-Type: multipart/form-data
Description: 添加作业地块
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
folder | string | false | 文件夹 此处可填写业务名称,如:头像(avatar),作业地块图片(job_plot_images) 会在业务名称下再建立用户ID文件夹 如:某用户头像会放到:桶/avatar/用户ID 下面 | ||
plotGroupId | int64 | false | 地块分组ID | ||
plotGroupName | string | false | 地块分组名称 | ||
cropTypeId | int64 | false | 作物类型ID | ||
cropTypeName | string | false | 作物类型名称 | ||
did | string | false | 终端编号 | ||
amId | int64 | false | 农机ID | ||
terminalType | int32 | false | 终端类型 1.TBOX 2.自动驾驶 3.打点器 | ||
measureType | int32 | false | 测量类型 1.打点器 2.车载设备 3.绕地测量 4.画地块 | ||
measureUses | int32 | false | 测量用途 1.记亩 2.路网 | ||
plotName | string | false | 地块名称 | ||
jobType | int32 | false | 作业类型 1.耕地 2.种植 3.管理 4.收获 | ||
jobEquipment | int32 | false | 作业机具 按字典 | ||
jobWidth | double | false | 作业宽幅 | ||
customerName | string | false | 客户姓名 | ||
customerPhone | string | false | 客户电话 | ||
remark | string | false | 备注 | ||
plotArea | double | false | 地块面积(亩) | ||
plotCenterLon | double | false | 地块中心经度 | ||
plotCenterLat | double | false | 地块中心纬度 | ||
regionCode | string | false | 地区编码 | ||
regionName | string | false | 地区名称 | ||
address | string | false | 地址 | ||
outlinePoint | string | false | 轮廓点 | ||
wktData | string | false | WKT数据 | ||
uploadFilePlotThumb | file | false | No comments found. | ||
uploadFileImageA | file | false | No comments found. | ||
uploadFileImageB | file | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | 作业地块ID | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 462
}
}Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -F 'uploadFilePlotThumb=' -F 'uploadFileImageA=' -F 'uploadFileImageB=' -i /measureMu/addJobPlot --data 'folder=image&plotGroupId=213&plotGroupName=kelli.kunde&cropTypeId=762&cropTypeName=kelli.kunde&did=168&amId=707&terminalType=195&measureType=400&measureUses=871&plotName=kelli.kunde&jobType=116&jobEquipment=305&jobWidth=13.80&customerName=kelli.kunde&customerPhone=501.714.6254&remark=hx00j0&plotArea=33.37&plotCenterLon=20.07&plotCenterLat=3.93®ionCode=1300®ionName=kelli.kunde&address=Suite 125 93484 Hessel Meadows, Port Edison, VA 04830&outlinePoint=2tvfoq&wktData=5oo5dn'6.2. 修改作业地块
Type: POST
Content-Type: multipart/form-data
Description: 修改作业地块
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
folder | string | false | 文件夹 此处可填写业务名称,如:头像(avatar),作业地块图片(job_plot_images) 会在业务名称下再建立用户ID文件夹 如:某用户头像会放到:桶/avatar/用户ID 下面 | ||
plotGroupId | int64 | false | 地块分组ID | ||
plotGroupName | string | false | 地块分组名称 | ||
cropTypeId | int64 | false | 作物类型ID | ||
cropTypeName | string | false | 作物类型名称 | ||
did | string | false | 终端编号 | ||
amId | int64 | false | 农机ID | ||
terminalType | int32 | false | 终端类型 1.TBOX 2.自动驾驶 3.打点器 | ||
measureType | int32 | false | 测量类型 1.打点器 2.车载设备 3.绕地测量 4.画地块 | ||
measureUses | int32 | false | 测量用途 1.记亩 2.路网 | ||
plotName | string | false | 地块名称 | ||
jobType | int32 | false | 作业类型 1.耕地 2.种植 3.管理 4.收获 | ||
jobEquipment | int32 | false | 作业机具 按字典 | ||
jobWidth | double | false | 作业宽幅 | ||
customerName | string | false | 客户姓名 | ||
customerPhone | string | false | 客户电话 | ||
remark | string | false | 备注 | ||
plotArea | double | false | 地块面积(亩) | ||
plotCenterLon | double | false | 地块中心经度 | ||
plotCenterLat | double | false | 地块中心纬度 | ||
regionCode | string | false | 地区编码 | ||
regionName | string | false | 地区名称 | ||
address | string | false | 地址 | ||
outlinePoint | string | false | 轮廓点 | ||
wktData | string | false | WKT数据 | ||
id | int64 | false | 作业地块ID | ||
uploadFilePlotThumb | file | false | No comments found. | ||
uploadFileImageA | file | false | No comments found. | ||
uploadFileImageB | file | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -F 'uploadFilePlotThumb=' -F 'uploadFileImageA=' -F 'uploadFileImageB=' -i /measureMu/updateJobPlot --data 'folder=image&plotGroupId=598&plotGroupName=kelli.kunde&cropTypeId=12&cropTypeName=kelli.kunde&did=168&amId=854&terminalType=408&measureType=629&measureUses=391&plotName=kelli.kunde&jobType=968&jobEquipment=135&jobWidth=55.22&customerName=kelli.kunde&customerPhone=501.714.6254&remark=3b2mux&plotArea=56.61&plotCenterLon=3.75&plotCenterLat=30.08®ionCode=1300®ionName=kelli.kunde&address=Suite 125 93484 Hessel Meadows, Port Edison, VA 04830&outlinePoint=2cxvqf&wktData=whtypo&id=576'6.3. 删除作业地块
Type: POST
Content-Type: application/json
Description: 删除作业地块
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | array | true | 作业地块ID组 |
Request-body:
{
"id": [
636
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/deleteJobPlot --data '{
"id": [
636
]
}'6.4. 查询作业地块列表并分页
Type: POST
Content-Type: application/json
Description: 查询作业地块列表并分页
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
page | int32 | true | 页码 |
pageSize | int32 | true | 每页条数 |
measureUses | int32 | false | 测量用途 1.记亩 2.路网 |
plotName | string | false | 地块名称 |
plotGroupId | int64 | false | 地块分组ID 不填为全部 |
cropTypeId | int64 | false | 作物类型ID 不填为全部 |
regionCode | string | false | 地区编码 不填为全部 |
Request-body:
{
"page": 1,
"pageSize": 20,
"measureUses": 455,
"plotName": "kelli.kunde",
"plotGroupId": 101,
"cropTypeId": 382,
"regionCode": "1300"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数据量 | - |
└─rows | array | 数据行 | - |
└─id | int64 | 作业地块ID | - |
└─plotGroupId | int64 | 地块分组ID | - |
└─plotGroupName | string | 地块分组名称 | - |
└─measureType | int32 | 测量类型 1.打点器 2.车载设备 3.绕地测量 4.画地块 | - |
└─measureTypeName | string | 测量类型名称 1.打点器 2.车载设备 3.绕地测量 4.画地块 | - |
└─measureUses | int32 | 测量用途 1.记亩 2.路网 | - |
└─plotName | string | 地块名称 | - |
└─plotThumbUrl | string | 地块缩略图 | - |
└─plotArea | double | 地块面积(亩) | - |
└─plotCenterLon | double | 地块中心经度 | - |
└─plotCenterLat | double | 地块中心纬度 | - |
└─regionCode | string | 地区编码 | - |
└─regionName | string | 地区名称 | - |
└─address | string | 地址 | - |
└─outlinePoint | string | 轮廓点 | - |
└─wktData | string | WKT数据 | - |
└─createTime | string | 创建时间 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"total": 575,
"rows": [
{
"id": 74,
"plotGroupId": 476,
"plotGroupName": "kelli.kunde",
"measureType": 232,
"measureTypeName": "kelli.kunde",
"measureUses": 85,
"plotName": "kelli.kunde",
"plotThumbUrl": "www.kevin-raynor.us",
"plotArea": 33.77,
"plotCenterLon": 40.17,
"plotCenterLat": 79.27,
"regionCode": "1300",
"regionName": "kelli.kunde",
"address": "Suite 125 93484 Hessel Meadows, Port Edison, VA 04830",
"outlinePoint": "2t1urm",
"wktData": "wlyv51",
"createTime": "2025-02-27 09:46:08"
}
]
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/queryJobPlotListByPage --data '{
"page": 1,
"pageSize": 20,
"measureUses": 455,
"plotName": "kelli.kunde",
"plotGroupId": 101,
"cropTypeId": 382,
"regionCode": "1300"
}'6.5. 获取作业地块详情
Type: POST
Content-Type: application/json
Description: 获取作业地块详情
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | true | 作业地块ID |
Request-body:
{
"id": 202
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | 作业地块ID | - |
└─plotGroupId | int64 | 地块分组ID | - |
└─plotGroupName | string | 地块分组名称 | - |
└─cropTypeId | int64 | 作物类型ID | - |
└─cropTypeName | string | 作物类型名称 | - |
└─amId | int64 | 农机ID | - |
└─terminalType | int32 | 终端类型 1.TBOX 2.自动驾驶 3.打点器 | - |
└─terminalTypeName | string | 终端类型名称 1.TBOX 2.自动驾驶 3.打点器 | - |
└─measureType | int32 | 测量类型 1.打点器 2.车载设备 3.绕地测量 4.画地块 | - |
└─measureTypeName | string | 测量类型名称 1.打点器 2.车载设备 3.绕地测量 4.画地块 | - |
└─measureUses | int32 | 测量用途 1.记亩 2.路网 | - |
└─measureUsesName | string | 测量用途名称 1.记亩 2.路网 | - |
└─plotName | string | 地块名称 | - |
└─jobType | int32 | 作业类型 1.耕地 2.种植 3.管理 4.收获 | - |
└─jobTypeName | string | 作业类型名称 1.耕地 2.种植 3.管理 4.收获 | - |
└─jobEquipment | int32 | 作业机具 按字典 | - |
└─jobEquipmentName | string | 作业机具名称 按字典 | - |
└─jobWidth | double | 作业宽幅 | - |
└─plotThumbUrl | string | 地块缩略图 | - |
└─customerName | string | 客户姓名 | - |
└─customerPhone | string | 客户电话 | - |
└─remark | string | 备注 | - |
└─imageUrlA | string | 图片a | - |
└─imageUrlB | string | 图片b | - |
└─plotArea | double | 地块面积(亩) | - |
└─plotCenterLon | double | 地块中心经度 | - |
└─plotCenterLat | double | 地块中心纬度 | - |
└─regionCode | string | 地区编码 | - |
└─regionName | string | 地区名称 | - |
└─address | string | 地址 | - |
└─outlinePoint | string | 轮廓点 | - |
└─wktData | string | WKT数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 821,
"plotGroupId": 887,
"plotGroupName": "kelli.kunde",
"cropTypeId": 835,
"cropTypeName": "kelli.kunde",
"amId": 27,
"terminalType": 258,
"terminalTypeName": "kelli.kunde",
"measureType": 358,
"measureTypeName": "kelli.kunde",
"measureUses": 878,
"measureUsesName": "kelli.kunde",
"plotName": "kelli.kunde",
"jobType": 141,
"jobTypeName": "kelli.kunde",
"jobEquipment": 52,
"jobEquipmentName": "kelli.kunde",
"jobWidth": 89.33,
"plotThumbUrl": "www.kevin-raynor.us",
"customerName": "kelli.kunde",
"customerPhone": "501.714.6254",
"remark": "1zhx3n",
"imageUrlA": "ix3y1h",
"imageUrlB": "qy6ger",
"plotArea": 14.58,
"plotCenterLon": 49.67,
"plotCenterLat": 52.91,
"regionCode": "1300",
"regionName": "kelli.kunde",
"address": "Suite 125 93484 Hessel Meadows, Port Edison, VA 04830",
"outlinePoint": "0tt790",
"wktData": "rzftj3"
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/getJobPlotDetail --data '{
"id": 202
}'6.6. 添加地块分组
Type: POST
Content-Type: application/json
Description: 添加地块分组
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
plotGroupName | string | false | 地块分组名称 |
Request-body:
{
"plotGroupName": "kelli.kunde"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/addPlotGroup --data '{
"plotGroupName": "kelli.kunde"
}'6.7. 删除地块分组
Type: POST
Content-Type: application/json
Description: 删除地块分组
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | array | true | 地块分组ID组 |
Request-body:
{
"id": [
89
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/deletePlotGroup --data '{
"id": [
89
]
}'6.8. 查询地块分组列表
Type: POST
Content-Type: application/json
Description: 查询地块分组列表
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
page | int32 | true | 页码 |
pageSize | int32 | true | 每页条数 |
Request-body:
{
"page": 1,
"pageSize": 20
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | array | 响应数据 | - |
└─id | int64 | 地块分组ID | - |
└─plotGroupName | string | 地块分组名称 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": [
{
"id": 845,
"plotGroupName": "kelli.kunde"
}
]
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/queryPlotGroupList --data '{
"page": 1,
"pageSize": 20
}'6.9. 添加作物类型
Type: POST
Content-Type: application/json
Description: 添加作物类型
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
cropTypeName | string | false | 作物类型名称 |
Request-body:
{
"cropTypeName": "kelli.kunde"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/addCropType --data '{
"cropTypeName": "kelli.kunde"
}'6.10. 删除作物类型
Type: POST
Content-Type: application/json
Description: 删除作物类型
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | array | true | 作物类型ID组 |
Request-body:
{
"id": [
691
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/deleteCropType --data '{
"id": [
691
]
}'6.11. 查询作物类型列表
Type: POST
Content-Type: application/json
Description: 查询作物类型列表
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
page | int32 | true | 页码 |
pageSize | int32 | true | 每页条数 |
Request-body:
{
"page": 1,
"pageSize": 20
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | array | 响应数据 | - |
└─id | int64 | 作物类型ID | - |
└─cropTypeName | string | 作物类型名称 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": [
{
"id": 298,
"cropTypeName": "kelli.kunde"
}
]
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/queryCropTypeList --data '{
"page": 1,
"pageSize": 20
}'6.12. 获取作业地块统计
Type: POST
Content-Type: application/json
Description: 获取作业地块统计
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
plotGroupId | int64 | false | 地块分组ID 不填为全部 |
cropTypeId | int64 | false | 作物类型ID 不填为全部 |
regionCode | string | false | 地区编码 不填为全部 |
Request-body:
{
"plotGroupId": 969,
"cropTypeId": 668,
"regionCode": "1300"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─plotCountTotal | int32 | 总地块数 | - |
└─plotAreaTotal | double | 总地块面积(亩) | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"plotCountTotal": 862,
"plotAreaTotal": 76.09
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/getJobPlotStat --data '{
"plotGroupId": 969,
"cropTypeId": 668,
"regionCode": "1300"
}'6.13. 添加AB线
URL: /measureMu/addAbLine
Type: POST
Content-Type: application/json
Description: 添加AB线
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
abLineName | string | false | AB线名称 |
aLon | double | false | A点经度 |
aLat | double | false | A点纬度 |
aRegionCode | string | false | A点地区编码 |
aRegionName | string | false | A点地区名称 |
bLon | double | false | B点经度 |
bLat | double | false | B点纬度 |
bRegionCode | string | false | B点地区编码 |
bRegionName | string | false | B点地区名称 |
abDistance | double | false | AB点距离(米) |
Request-body:
{
"abLineName": "kelli.kunde",
"aLon": 95.01,
"aLat": 28.96,
"aRegionCode": "1300",
"aRegionName": "kelli.kunde",
"bLon": 33.86,
"bLat": 51.35,
"bRegionCode": "1300",
"bRegionName": "kelli.kunde",
"abDistance": 36.98
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | AB线ID | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 588
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/addAbLine --data '{
"abLineName": "kelli.kunde",
"aLon": 95.01,
"aLat": 28.96,
"aRegionCode": "1300",
"aRegionName": "kelli.kunde",
"bLon": 33.86,
"bLat": 51.35,
"bRegionCode": "1300",
"bRegionName": "kelli.kunde",
"abDistance": 36.98
}'6.14. 修改AB线
Type: POST
Content-Type: application/json
Description: 修改AB线
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
abLineName | string | false | AB线名称 |
aLon | double | false | A点经度 |
aLat | double | false | A点纬度 |
aRegionCode | string | false | A点地区编码 |
aRegionName | string | false | A点地区名称 |
bLon | double | false | B点经度 |
bLat | double | false | B点纬度 |
bRegionCode | string | false | B点地区编码 |
bRegionName | string | false | B点地区名称 |
abDistance | double | false | AB点距离(米) |
id | int64 | false | AB线ID |
Request-body:
{
"abLineName": "kelli.kunde",
"aLon": 73.74,
"aLat": 36.51,
"aRegionCode": "1300",
"aRegionName": "kelli.kunde",
"bLon": 10.83,
"bLat": 51.63,
"bRegionCode": "1300",
"bRegionName": "kelli.kunde",
"abDistance": 78.83,
"id": 162
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/updateAbLine --data '{
"abLineName": "kelli.kunde",
"aLon": 73.74,
"aLat": 36.51,
"aRegionCode": "1300",
"aRegionName": "kelli.kunde",
"bLon": 10.83,
"bLat": 51.63,
"bRegionCode": "1300",
"bRegionName": "kelli.kunde",
"abDistance": 78.83,
"id": 162
}'6.15. 删除AB线
Type: POST
Content-Type: application/json
Description: 删除AB线
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | array | true | AB线ID组 |
Request-body:
{
"id": [
985
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/deleteAbLine --data '{
"id": [
985
]
}'6.16. 查询AB线列表并分页
Type: POST
Content-Type: application/json
Description: 查询AB线列表并分页
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
page | int32 | true | 页码 |
pageSize | int32 | true | 每页条数 |
abLineName | string | false | AB线名称 不填为全部 |
regionCode | string | false | 地区编码 不填为全部 |
Request-body:
{
"page": 1,
"pageSize": 20,
"abLineName": "kelli.kunde",
"regionCode": "1300"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数据量 | - |
└─rows | array | 数据行 | - |
└─id | int64 | AB线ID | - |
└─abLineName | string | AB线名称 | - |
└─aLon | double | A点经度 | - |
└─aLat | double | A点纬度 | - |
└─aRegionCode | string | A点地区编码 | - |
└─aRegionName | string | A点地区名称 | - |
└─bLon | double | B点经度 | - |
└─bLat | double | B点纬度 | - |
└─bRegionCode | string | B点地区编码 | - |
└─bRegionName | string | B点地区名称 | - |
└─abDistance | double | AB点距离(米) | - |
└─createTime | string | 创建时间 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"total": 849,
"rows": [
{
"id": 156,
"abLineName": "kelli.kunde",
"aLon": 60.59,
"aLat": 80.25,
"aRegionCode": "1300",
"aRegionName": "kelli.kunde",
"bLon": 21.00,
"bLat": 70.92,
"bRegionCode": "1300",
"bRegionName": "kelli.kunde",
"abDistance": 61.70,
"createTime": "2025-02-27 09:46:09"
}
]
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/queryAbLineListByPage --data '{
"page": 1,
"pageSize": 20,
"abLineName": "kelli.kunde",
"regionCode": "1300"
}'6.17. 获取AB线详情
Type: POST
Content-Type: application/json
Description: 获取AB线详情
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | true | AB线ID |
Request-body:
{
"id": 128
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | AB线ID | - |
└─abLineName | string | AB线名称 | - |
└─aLon | double | A点经度 | - |
└─aLat | double | A点纬度 | - |
└─aRegionCode | string | A点地区编码 | - |
└─aRegionName | string | A点地区名称 | - |
└─bLon | double | B点经度 | - |
└─bLat | double | B点纬度 | - |
└─bRegionCode | string | B点地区编码 | - |
└─bRegionName | string | B点地区名称 | - |
└─abDistance | double | AB点距离(米) | - |
└─createTime | string | 创建时间 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 779,
"abLineName": "kelli.kunde",
"aLon": 88.39,
"aLat": 24.37,
"aRegionCode": "1300",
"aRegionName": "kelli.kunde",
"bLon": 21.07,
"bLat": 28.44,
"bRegionCode": "1300",
"bRegionName": "kelli.kunde",
"abDistance": 25.36,
"createTime": "2025-02-27 09:46:09"
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/getAbLineDetail --data '{
"id": 128
}'6.18. 添加标记物
Type: POST
Content-Type: application/json
Description: 添加标记物
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
markObjectName | string | false | 标记物名称 |
markObjectType | int32 | false | 标记物类型 1.出水桩 2.树 3.坑洞 4.电线杆 5.障碍物 |
lon | double | false | 经度 |
lat | double | false | 纬度 |
regionCode | string | false | 地区编码 |
regionName | string | false | 地区名称 |
Request-body:
{
"markObjectName": "kelli.kunde",
"markObjectType": 674,
"lon": 8.15,
"lat": 54.99,
"regionCode": "1300",
"regionName": "kelli.kunde"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | 标记物ID | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 825
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/addMarkObject --data '{
"markObjectName": "kelli.kunde",
"markObjectType": 674,
"lon": 8.15,
"lat": 54.99,
"regionCode": "1300",
"regionName": "kelli.kunde"
}'6.19. 批量添加标记物
Type: POST
Content-Type: application/json
Description: 批量添加标记物
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
markObjectName | string | false | 标记物名称 |
markObjectType | int32 | false | 标记物类型 1.出水桩 2.树 3.坑洞 4.电线杆 5.障碍物 |
lon | double | false | 经度 |
lat | double | false | 纬度 |
regionCode | string | false | 地区编码 |
regionName | string | false | 地区名称 |
Request-body:
[
{
"markObjectName": "kelli.kunde",
"markObjectType": 146,
"lon": 16.14,
"lat": 33.44,
"regionCode": "1300",
"regionName": "kelli.kunde"
}
]Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | array | 响应数据 | - |
└─id | int64 | 标记物ID | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": [
{
"id": 826
}
]
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/addMarkObjectBatch --data '[
{
"markObjectName": "kelli.kunde",
"markObjectType": 146,
"lon": 16.14,
"lat": 33.44,
"regionCode": "1300",
"regionName": "kelli.kunde"
}
]'6.20. 修改标记物
Type: POST
Content-Type: application/json
Description: 修改标记物
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
markObjectName | string | false | 标记物名称 |
markObjectType | int32 | false | 标记物类型 1.出水桩 2.树 3.坑洞 4.电线杆 5.障碍物 |
lon | double | false | 经度 |
lat | double | false | 纬度 |
regionCode | string | false | 地区编码 |
regionName | string | false | 地区名称 |
id | int64 | false | 标记物ID |
Request-body:
{
"markObjectName": "kelli.kunde",
"markObjectType": 475,
"lon": 24.98,
"lat": 68.61,
"regionCode": "1300",
"regionName": "kelli.kunde",
"id": 794
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/updateMarkObject --data '{
"markObjectName": "kelli.kunde",
"markObjectType": 475,
"lon": 24.98,
"lat": 68.61,
"regionCode": "1300",
"regionName": "kelli.kunde",
"id": 794
}'6.21. 删除标记物
Type: POST
Content-Type: application/json
Description: 删除标记物
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | array | true | 标记物ID组 |
Request-body:
{
"id": [
984
]
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/deleteMarkObject --data '{
"id": [
984
]
}'6.22. 查询标记物列表并分页
Type: POST
Content-Type: application/json
Description: 查询标记物列表并分页
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
page | int32 | true | 页码 |
pageSize | int32 | true | 每页条数 |
markObjectName | string | false | 标记物名称 不填为全部 |
regionCode | string | false | 地区编码 不填为全部 |
Request-body:
{
"page": 1,
"pageSize": 20,
"markObjectName": "kelli.kunde",
"regionCode": "1300"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数据量 | - |
└─rows | array | 数据行 | - |
└─id | int64 | 标记物ID | - |
└─markObjectName | string | 标记物名称 | - |
└─markObjectType | int32 | 标记物类型 1.出水桩 2.树 3.坑洞 4.电线杆 5.障碍物 | - |
└─lon | double | 经度 | - |
└─lat | double | 纬度 | - |
└─regionCode | string | 地区编码 | - |
└─regionName | string | 地区名称 | - |
└─createTime | string | 创建时间 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"total": 55,
"rows": [
{
"id": 657,
"markObjectName": "kelli.kunde",
"markObjectType": 418,
"lon": 16.20,
"lat": 65.48,
"regionCode": "1300",
"regionName": "kelli.kunde",
"createTime": "2025-02-27 09:46:09"
}
]
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/queryMarkObjectListByPage --data '{
"page": 1,
"pageSize": 20,
"markObjectName": "kelli.kunde",
"regionCode": "1300"
}'6.23. 获取标记物详情
Type: POST
Content-Type: application/json
Description: 获取标记物详情
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | true | 标记物ID |
Request-body:
{
"id": 775
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | 标记物ID | - |
└─markObjectName | string | 标记物名称 | - |
└─markObjectType | int32 | 标记物类型 1.出水桩 2.树 3.坑洞 4.电线杆 5.障碍物 | - |
└─lon | double | 经度 | - |
└─lat | double | 纬度 | - |
└─regionCode | string | 地区编码 | - |
└─regionName | string | 地区名称 | - |
└─createTime | string | 创建时间 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 990,
"markObjectName": "kelli.kunde",
"markObjectType": 538,
"lon": 72.28,
"lat": 71.88,
"regionCode": "1300",
"regionName": "kelli.kunde",
"createTime": "2025-02-27 09:46:09"
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /measureMu/getMarkObjectDetail --data '{
"id": 775
}'7. 消息服务接口
7.1. 查询消息列表并分页
Type: POST
Content-Type: application/json
Description: 查询消息列表并分页
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
page | int32 | true | 页码 |
pageSize | int32 | true | 每页条数 |
messageCategory | int32 | false | 消息类别 1.系统 2.告警 3.服务 4.授权 5.续费 不填为全部 |
Request-body:
{
"page": 1,
"pageSize": 20,
"messageCategory": 27
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数据量 | - |
└─rows | array | 数据行 | - |
└─id | int64 | 消息ID | - |
└─messageCategory | int32 | 消息类别 1.系统 2.告警 3.服务 4.授权 5.续费 | - |
└─messageType | int32 | 消息细分类型 | - |
└─title | string | 标题 | - |
└─content | string | 内容 | - |
└─icon | string | 图标 | - |
└─extra | string | 扩展数据 | - |
└─fromUid | int64 | 发送人ID | - |
└─toUid | int64 | 接收人ID | - |
└─readFlag | int32 | 已读标志 0.未读 1.已读 | - |
└─sendTime | string | 发送时间 | - |
└─readTime | string | 阅读时间 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"total": 590,
"rows": [
{
"id": 643,
"messageCategory": 721,
"messageType": 649,
"title": "as2bdu",
"content": "l6ke09",
"icon": "kbq0j5",
"extra": "pnxc8k",
"fromUid": 198,
"toUid": 381,
"readFlag": 8,
"sendTime": "2025-02-27",
"readTime": "2025-02-27 09:46:09"
}
]
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /message/queryMessageListByPage --data '{
"page": 1,
"pageSize": 20,
"messageCategory": 27
}'7.2. 获取消息详情
Type: POST
Content-Type: application/json
Description: 获取消息详情
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | true | 消息ID |
Request-body:
{
"id": 801
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | 消息ID | - |
└─messageCategory | int32 | 消息类别 1.系统 2.告警 3.服务 4.授权 5.续费 | - |
└─messageType | int32 | 消息细分类型 | - |
└─title | string | 标题 | - |
└─content | string | 内容 | - |
└─icon | string | 图标 | - |
└─extra | string | 扩展数据 | - |
└─fromUid | int64 | 发送人ID | - |
└─toUid | int64 | 接收人ID | - |
└─readFlag | int32 | 已读标志 0.未读 1.已读 | - |
└─sendTime | string | 发送时间 | - |
└─readTime | string | 阅读时间 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 840,
"messageCategory": 30,
"messageType": 816,
"title": "7ct5zz",
"content": "1wyi1i",
"icon": "7nd8y2",
"extra": "bica2v",
"fromUid": 498,
"toUid": 459,
"readFlag": 8,
"sendTime": "2025-02-27",
"readTime": "2025-02-27 09:46:09"
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /message/getMessageDetail --data '{
"id": 801
}'7.3. 标记已读
Type: POST
Content-Type: application/json
Description: 标记已读
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | true | 消息ID |
Request-body:
{
"id": 575
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /message/updateReadFlag --data '{
"id": 575
}'7.4. 全部标记已读
Type: POST
Content-Type: application/json
Description: 全部标记已读
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
messageCategory | int32 | false | 消息类别 1.系统 2.告警 3.服务 4.授权 5.续费 不填为全部 |
Request-body:
{
"messageCategory": 195
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /message/updateReadFlagAll --data '{
"messageCategory": 195
}'7.5. 获取全部未读消息数量
Type: POST
Content-Type: application/json
Description: 获取全部未读消息数量
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
messageCategory | int32 | false | 消息类别 1.系统 2.告警 3.服务 4.授权 5.续费 不填为全部 |
Request-body:
{
"messageCategory": 2
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─total | int64 | 全部未读数量 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"total": 633
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /message/getMessageCountUnreadAll --data '{
"messageCategory": 2
}'8. 续费服务接口
8.1. 查询续费期限列表
Type: POST
Content-Type: application/json
Description: 查询续费期限列表
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
productId | string | true | 商品ID |
Request-body:
{
"productId": "168"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | array | 响应数据 | - |
└─id | int64 | 主键 | - |
└─productId | int64 | 商品ID | - |
└─specName | string | 规格名称 | - |
└─serviceDuration | int32 | 服务时长(天) | - |
└─amount | string | 金额 | - |
└─taxRate | string | 税率 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": [
{
"id": 512,
"productId": 540,
"specName": "kelli.kunde",
"serviceDuration": 264,
"amount": "vgjw8v",
"taxRate": "txlc6n"
}
]
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /renew/queryRenewTermList --data '{
"productId": "168"
}'8.2. 添加续费订单
URL: /renew/addRenewOrder
Type: POST
Content-Type: application/json
Description: 添加续费订单
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
productId | int64 | true | 商品ID |
skuId | int64 | true | 库存单位ID |
amId | int64 | true | 农机ID |
signalActivationFlag | int32 | true | 信号激活标志 1.免费激活 2.续费 |
signalAuthDate | string | true | 信号授权日期 |
totalPrice | double | false | 总价 |
paidAmount | double | false | 实付 |
payType | int32 | false | 支付类型 1.微信 2.支付宝 |
payNo | string | false | 支付流水号 |
payTime | string | false | 支付时间 |
Request-body:
{
"productId": 114,
"skuId": 339,
"amId": 217,
"signalActivationFlag": 8,
"signalAuthDate": "2025-02-27",
"totalPrice": 3.14,
"paidAmount": 75.83,
"payType": 147,
"payNo": "0arbe7",
"payTime": "2025-02-27 09:46:09"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | 订单ID | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 133
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /renew/addRenewOrder --data '{
"productId": 114,
"skuId": 339,
"amId": 217,
"signalActivationFlag": 8,
"signalAuthDate": "2025-02-27",
"totalPrice": 3.14,
"paidAmount": 75.83,
"payType": 147,
"payNo": "0arbe7",
"payTime": "2025-02-27 09:46:09"
}'8.3. 查询续费订单列表并分页
Type: POST
Content-Type: application/json
Description: 查询续费订单列表并分页
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
page | int32 | true | 页码 |
pageSize | int32 | true | 每页条数 |
Request-body:
{
"page": 1,
"pageSize": 20
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─total | int64 | 总数据量 | - |
└─rows | array | 数据行 | - |
└─id | int64 | 订单ID | - |
└─orderNo | string | 订单编号 | - |
└─totalPrice | string | 总价 | - |
└─paidAmount | string | 实付 | - |
└─amAlias | string | 农机别名 | - |
└─did | string | 终端编号 | - |
└─terminalType | int32 | 终端类型 1.TBOX 2.自动驾驶 3.打点器 | - |
└─terminalTypeName | string | 终端类型名称 1.TBOX 2.自动驾驶 3.打点器 | - |
└─specName | string | 规格名称 | - |
└─signalAuthExpiresTime | string | 信号授权过期时间 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"total": 3,
"rows": [
{
"id": 589,
"orderNo": "bpcmhj",
"totalPrice": "g7uw08",
"paidAmount": "fmfz4u",
"amAlias": "y45xbj",
"did": "168",
"terminalType": 448,
"terminalTypeName": "kelli.kunde",
"specName": "kelli.kunde",
"signalAuthExpiresTime": "2025-02-27 09:46:09"
}
]
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /renew/queryRenewOrderListByPage --data '{
"page": 1,
"pageSize": 20
}'8.4. 获取续费订单详情
Type: POST
Content-Type: application/json
Description: 获取续费订单详情
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
id | int64 | true | 订单ID |
Request-body:
{
"id": 509
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | 订单ID | - |
└─orderNo | string | 订单编号 | - |
└─orderType | int32 | 订单类型 1.虚拟 2.实物 | - |
└─productCount | int32 | 商品总数 | - |
└─totalPrice | string | 总价 | - |
└─taxRate | string | 税率 | - |
└─paidAmount | string | 实付 | - |
└─orderStatus | int32 | 订单状态 1.已支付 | - |
└─payType | int32 | 支付类型 1.微信 2.支付宝 | - |
└─payTypeName | string | 支付类型名称 | - |
└─payNo | string | 支付流水号 | - |
└─payTime | string | 支付时间 | - |
└─productId | int64 | 商品ID | - |
└─skuId | int64 | 库存单位ID | - |
└─specName | string | 规格名称 | - |
└─serviceDuration | int32 | 服务时长(天) | - |
└─amId | int64 | 农机ID | - |
└─amAlias | string | 农机别名 | - |
└─did | string | 终端编号 | - |
└─slotNumber | string | 板卡号 | - |
└─terminalType | int32 | 终端类型 1.TBOX 2.自动驾驶 3.打点器 | - |
└─terminalTypeName | string | 终端类型名称 | - |
└─lpn | string | 车牌号 | - |
└─amModel | string | 农机型号 | - |
└─amCategory | string | 农机类别 | - |
└─manufacturerModel | string | 厂商型号 | - |
└─amOwnerName | string | 机主姓名 | - |
└─amOwnerPhone | string | 机主电话 | - |
└─installDate | string | 安装日期 | - |
└─installAddress | string | 安装地址 | - |
└─signalAuthDate | string | 信号授权日期 | - |
└─signalAuthExpiresTime | string | 信号授权过期时间 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 448,
"orderNo": "cadcv6",
"orderType": 265,
"productCount": 398,
"totalPrice": "gg988z",
"taxRate": "xtgp4b",
"paidAmount": "w2zcow",
"orderStatus": 276,
"payType": 683,
"payTypeName": "kelli.kunde",
"payNo": "6m0irz",
"payTime": "2025-02-27 09:46:09",
"productId": 447,
"skuId": 75,
"specName": "kelli.kunde",
"serviceDuration": 184,
"amId": 230,
"amAlias": "orbe4f",
"did": "168",
"slotNumber": "23tsqb",
"terminalType": 419,
"terminalTypeName": "kelli.kunde",
"lpn": "lxe1s6",
"amModel": "96si3d",
"amCategory": "sh3j61",
"manufacturerModel": "g7p9s2",
"amOwnerName": "kelli.kunde",
"amOwnerPhone": "501.714.6254",
"installDate": "2025-02-27",
"installAddress": "Suite 125 93484 Hessel Meadows, Port Edison, VA 04830",
"signalAuthDate": "2025-02-27",
"signalAuthExpiresTime": "2025-02-27 09:46:09"
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /renew/getRenewOrderDetail --data '{
"id": 509
}'9. 短信服务接口
9.1. 发送未登录短信验证码
0.手机号登录 1.注册 2.重置登录密码
URL: /sms/sendCode
Type: POST
Content-Type: application/json
Description: 发送未登录短信验证码
0.手机号登录 1.注册 2.重置登录密码
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
mobile | string | true | 手机号 Validate[regexp: [1]([3-9])[0-9]{9}$; ] |
smsBizType | int32 | false | 短信业务类型 0.手机号登录 1.注册 2.重置登录密码 3.更换手机号 4.绑定农机 5.解绑农机 默认不传为登录验证码 |
Request-body:
{
"mobile": "(603) 260-1149",
"smsBizType": 470
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /sms/sendCode --data '{
"mobile": "(603) 260-1149",
"smsBizType": 470
}'9.2. 发送已登录短信验证码
3.更换手机号 4.绑定农机 5.解绑农机
Type: POST
Content-Type: application/json
Description: 发送已登录短信验证码
3.更换手机号 4.绑定农机 5.解绑农机
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
mobile | string | true | 手机号 Validate[regexp: [1]([3-9])[0-9]{9}$; ] |
smsBizType | int32 | false | 短信业务类型 0.手机号登录 1.注册 2.重置登录密码 3.更换手机号 4.绑定农机 5.解绑农机 默认不传为登录验证码 |
Request-body:
{
"mobile": "(603) 260-1149",
"smsBizType": 358
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /sms/sendCodeByLoggedIn --data '{
"mobile": "(603) 260-1149",
"smsBizType": 358
}'9.3. 校验验证码是否正确
URL: /sms/verifyCode
Type: POST
Content-Type: application/json
Description: 校验验证码是否正确
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
mobile | string | true | 手机号 Validate[regexp: [1]([3-9])[0-9]{9}$; ] |
smsBizType | int32 | false | 短信业务类型 0.手机号登录 1.注册 2.重置登录密码 3.更换手机号 4.绑定农机 5.解绑农机 默认不传为登录验证码 |
code | string | true | 验证码 |
Request-body:
{
"mobile": "(603) 260-1149",
"smsBizType": 924,
"code": "1300"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /sms/verifyCode --data '{
"mobile": "(603) 260-1149",
"smsBizType": 924,
"code": "1300"
}'10. app下载
10.1. 根据文件名获取下载链接
Type: POST
Content-Type: application/json
Description: 根据文件名获取下载链接
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
fileName | string | true | No comments found. |
Request-body:
{
"fileName": "kelli.kunde"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | string | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": "6dm5cq"
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /software/getDownloadUrl --data '{
"fileName": "kelli.kunde"
}'11. 系统服务接口
11.1. 查询字典列表
Type: POST
Content-Type: application/json
Description: 查询字典列表
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
dictTypeCode | string | true | 字典类型编码 |
Request-body:
{
"dictTypeCode": "1300"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | array | 响应数据 | - |
└─id | int64 | ID | - |
└─dictTypeCode | string | 字典类型编码 | - |
└─dictCode | string | 字典编码 | - |
└─dictName | string | 字典名称 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": [
{
"id": 223,
"dictTypeCode": "1300",
"dictCode": "1300",
"dictName": "kelli.kunde"
}
]
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /system/queryDictList --data '{
"dictTypeCode": "1300"
}'11.2. 刷新字典列表到缓存
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 刷新字典列表到缓存
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -i /system/refreshDictListIntoCache12. 用户相关服务接口
12.1. 获取用户详情
URL: /user/getUserDetail
Type: POST
Content-Type: application/x-www-form-urlencoded;charset=UTF-8
Description: 获取用户详情
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─id | int64 | 用户ID | - |
└─nickName | string | 昵称 | - |
└─avatarUrl | string | 头像 | - |
└─realName | string | 姓名 | - |
└─gender | int32 | 性别 1.男 2.女 | - |
└─age | int32 | 年龄 | - |
└─regionCode | string | 地区编码 | - |
└─regionName | string | 地区名称 | - |
└─orgType | int32 | 机构类型 1.个人 2.合作社 3.公司 | - |
└─orgName | string | 机构名称 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"id": 892,
"nickName": "kerrie.glover",
"avatarUrl": "www.kevin-raynor.us",
"realName": "kelli.kunde",
"gender": 0,
"age": 15,
"regionCode": "1300",
"regionName": "kelli.kunde",
"orgType": 73,
"orgName": "kelli.kunde"
}
}Curl-example:
curl -X POST -i /user/getUserDetail12.2. 修改用户
URL: /user/updateUser
Type: POST
Content-Type: multipart/form-data
Description: 修改用户
Query-parameters:
| Parameter | Value | Type | Required | Description | |
|---|---|---|---|---|---|
folder | string | false | 文件夹 此处可填写业务名称,如:头像(avatar),作业地块图片(job_plot_images) 会在业务名称下再建立用户ID文件夹 如:某用户头像会放到:桶/avatar/用户ID 下面 | ||
nickName | string | false | 昵称 Validate[max: 10; ] | ||
realName | string | false | 姓名 Validate[max: 10; ] | ||
gender | int32 | false | 性别 1.男 2.女 Validate[max: 2; ] | ||
age | int32 | false | 年龄 | ||
regionCode | string | false | 地区编码 Validate[max: 6; ] | ||
regionName | string | false | 地区名称 | ||
orgType | int32 | false | 机构类型 1.个人 2.合作社 3.公司 Validate[max: 3; ] | ||
orgName | string | false | 机构名称 Validate[max: 30; ] | ||
uploadFile | file | false | No comments found. |
Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: multipart/form-data' -F 'uploadFile=' -i /user/updateUser --data 'folder=image&nickName=kerrie.glover&realName=kelli.kunde&gender=0&age=15®ionCode=1300®ionName=kelli.kunde&orgType=904&orgName=kelli.kunde'12.3. 修改密码
URL: /user/changePassword
Type: POST
Content-Type: application/json
Description: 修改密码
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
oldPassword | string | true | 旧密码 |
newPassword | string | true | 新密码 |
Request-body:
{
"oldPassword": "ilsq0c",
"newPassword": "0g802s"
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /user/changePassword --data '{
"oldPassword": "ilsq0c",
"newPassword": "0g802s"
}'13. 版本服务接口
13.1. 获取最新版本信息
Type: POST
Content-Type: application/json
Description: 获取最新版本信息
Body-parameters:
| Parameter | Type | Required | Description |
|---|---|---|---|
versionCode | int32 | false | 当前版本 |
Request-body:
{
"versionCode": 151
}Response-fields:
| Field | Type | Description | Since |
|---|---|---|---|
status | int32 | 响应状态;成功返回0,非0代表失败 | - |
message | string | 描述 | - |
timestamp | string | 接口调用开始时间 | - |
end | string | 接口调用结束时间 | - |
execution | int64 | 接口调用执行时间 | - |
trace | string | 错误堆栈 | - |
data | object | 响应数据 | - |
└─lastVersion | string | 最新版本编号 | - |
└─versionCode | int32 | 最新版本code | - |
└─minVersionCode | int32 | 强制升级版本 当前版本低于该版本时,需要强制升级 | - |
└─downloadUrl | string | 下载地址 | - |
└─description | string | 升级说明 | - |
Response-example:
{
"status": 0,
"message": "响应描述",
"timestamp": "2021-04-22 08:01:01",
"end": "2021-04-22 08:02:01",
"execution": 100,
"trace": "错误堆栈信息",
"data": {
"lastVersion": "8.7",
"versionCode": 54,
"minVersionCode": 748,
"downloadUrl": "www.kevin-raynor.us",
"description": "thkbtx"
}
}Curl-example:
curl -X POST -H 'Content-Type: application/json' -i /version/getLatestVersion --data '{
"versionCode": 151
}'