农场信息管理

说明

针对项目交付的农业项目，定义统一的数据模型，项目isv交付实施时需要将相关业务数据对接到SI工作台中，由集成商进行订阅和使用。

集成方式

使用方式

申请开通物联网应用服务平台：点此申请开通
创建自定义项目
添加能力，选择“农场信息管理”
添加后通知对接小二进行审批，审批后即可进行调用

1. 基地管理

1.1 添加基地

path: /solution/farm/base/add
版本：1.0.0

入参：

参数	类型	是否必填	备注
baseType	Integer	是	基地类型，0种植，1养殖
baseName	String	是	基地名称
outBaseId	String	是	外部合作伙伴基地Id
areaId	String	否	行政区域id
areaName	String	否	行政区域名
villagesAreaId	String	否	乡镇id
villagesAreaName	String	否	乡镇名称
ruralId	String	否	村镇id
ruralName	String	否	村镇名称
contactName	String	否	联系人
contactPhone	String	否	联系电话
address	String	否	地址
email	String	否	邮箱
longitude	String	否	高德坐标经度
latitude	String	否	高德坐标纬度
boundaryCoordinates	String	否	边界坐标
realArea	String	否	实际可用面积
viewColor	String	否	颜色
altitude	String	否	海拔
persistSupply	String	否	主要作物
baseCode	String	否	基地编号
buildDate	Long	否	建设时间
description	String	否	描述
propagandaVideo	String	否	宣传视频url
picture	String	否	基地实景图url

出参：
String类型, data字段 value表示在阿里内部保存的唯一的IoT基地ID。

出参示例：

{
    "code": 200,
    "data": "ecaf24330bdf4e18ba8a969b7e82fe6d",
    "message": "success"
}

1.2 更新基地

path: /solution/farm/base/update
版本：1.0.0

入参：

参数	类型	是否必填	备注
baseType	Integer	是	基地类型，0种植，1养殖
baseName	String	是	基地名称
outBaseId	String	否	外部合作伙伴基地Id,和baseId二选一必填
baseId	String	否	阿里内部保存的唯一基地ID，与outBaseId二选一必填
areaId	String	否	行政区域id
areaName	String	否	行政区域名
villagesAreaId	String	否	乡镇id
villagesAreaName	String	否	乡镇名称
ruralId	String	否	村镇id
ruralName	String	否	村镇名称
contactName	String	否	联系人
contactPhone	String	否	联系电话
address	String	否	地址
email	String	否	邮箱
longitude	String	否	经度
latitude	String	否	纬度
boundaryCoordinates	String	否	边界坐标
realArea	String	否	实际可用面积
viewColor	String	否	颜色
altitude	String	否	海拔
persistSupply	String	否	主要作物
baseCode	String	否	基地编号
buildDate	Long	否	建设时间
description	String	否	描述
propagandaVideo	String	否	宣传视频url
picture	String	否	基地实景图url

出参：
String类型，baseId, 表示在阿里内部保存的唯一的基地ID。

出参示例：

{
    "code": 200,
    "data": "ecaf24330bdf4e18ba8a969b7e82fe6d",
    "message": "success"
}

1.3 删除基地

path: /solution/farm/base/delete
版本：1.0.0

入参：

参数	类型	是否必填	备注
outBaseId	String	否	外部合作伙伴基地Id,和base Id二选一必填
baseId	String	否	阿里内部保存的唯一基地ID，与outBaseId二选一必填

出参：
无

出参示例：

{
    "code": 200,
    "message": "success"
}

1.4 基地分页查询

path: /solution/farm/base/query
版本：1.0.0

入参：

参数	类型	是否必填	备注
pageSize	Integer	是	页面大小
pageNo	Integer	是	页号

出参data字段：

参数		类型	备注
total		Integer	基地总数
pageSize		Integer	页面大小
pageNo		Integer	页号
data	baseId	String	阿里内部保存的唯一基地ID
	areaId	String	行政区域id
	areaName	String	行政区域名
	villagesAreaId	String	乡镇id
	villagesAreaName	String	乡镇名称
	ruralId	String	村镇id
	ruralName	String	村镇名称
	outBaseId	String	外部合作伙伴基地Id
	baseName	String	基地名称
	contactName	String	联系人
	contactPhone	String	联系电话
	address	String	地址
	email	String	邮箱
	longitude	Decimal	经度
	latitude	Decimal	纬度
	boundaryCoordinates	String	边界坐标
	realArea	Decimal	实际可用面积
	viewColor	String	颜色
	altitude	Decimal	海拔
	persistSupply	String	主要作物
	baseCode	String	基地编号
	buildDate	Long	建设时间
	description	String	描述
	propagandaVideo	String	宣传视频url
	picture	String	基地实景图url
	baseType	Integer	基地类型，0种植，1养殖

出参示例

{
    "code": 200,
    "data":
    {
        "total": 1,
        "pageNo": 1,
        "pageSize": 10,
        "data": [
        {
            "altitude": 28.20,
            "latitude": 28.1000000,
            "outBaseId": "outbaseId2",
            "baseId": "uniqueId2",
            "baseType": 1,
            "baseName": "baseName2",
            "longitude": 42.1000000,
            "address": "address1"
        }]
    },
    "message": "success"
}

1.5 基地单个查询

path: /solution/farm/base/get
版本：1.0.0

入参：

参数	类型	是否必填	备注
outBaseId	String	否	外部合作伙伴基地Id,和baseId二选一必填
baseId	String	否	阿里内部保存的唯一基地ID，与outBaseId二选一必填

出参data字段：

参数	类型	备注
baseId	String	阿里内部保存的唯一基地ID
areaId	String	行政区域id
areaName	String	行政区域名
villagesAreaId	String	乡镇id
villagesAreaName	String	乡镇名称
ruralId	String	村镇id
ruralName	String	村镇名称
outBaseId	String	外部合作伙伴基地Id
baseName	String	基地名称
contactName	String	联系人
contactPhone	String	联系电话
address	String	地址
email	String	邮箱
longitude	String	经度
latitude	String	纬度
boundaryCoordinates	String	边界坐标
realArea	String	实际可用面积
viewColor	String	颜色
altitude	String	海拔
persistSupply	String	主要作物
baseCode	String	基地编号
buildDate	Long	建设时间
description	String	描述
propagandaVideo	String	宣传视频url
picture	String	基地实景图url
baseType	Integer	基地类型，0种植，1养殖

出参示例：

{
    "code": 200,
    "message": "success",
    "data":
        {
            "altitude": 28.20,
            "latitude": 28.1000000,
            "baseId": "baseId2",
            "OutBaseId": "outbaseId2",
            "baseType": 1,
            "baseName": "baseName2",
            "longitude": 42.1000000,
            "address": "address1"
        }
}

2. 地块管理

2.1 添加地块

path：/solution/farm/tunnel/add
版本：1.0.0

入参

注意，baseId和outBaseId至少要有一个非空，如果两个非空要保证所属同一个基地。

参数		类型	是否必填	备注
tunnel	outTunnelId	String	是	外部合作伙伴地块Id
	tunnelName	String	是	地块名称
	outBaseId	String	否	外部合作伙伴基地Id
	baseId	String	否	IoT基地Id
	littleStar	Integer	否	星级
	description	String	否	介绍
	tunnelCode	String	否	编号
	plantEnvType	Integer	否	地块类型，1-加热温室/2-日光温室/3-连栋温室/4-春秋棚/5-农田/6-果园/7-水面/8-养殖/9-伐林地/10-开荒地/11-草场地
	longitude	String	否	位置经度
	latitude	String	否	位置维度
	boundaryCoordinates	String	否	边界，高德地图多边形
	realArea	String	否	面积，单位亩
	farmerName	String	否	农户姓名
	farmerPhone	String	否	农户电话
	instructorName	String	否	指导员姓名
	instructorPhone	String	否	指导员电话
	viewColor	String	否	地图展示地块颜色
	opacity	Integer	否	地图展示透明度

出参

参数	类型	备注
tunnelId	String	IoT地块Id

示例

入参示例

{
  "tunnel":
  {    
    "tunnelName": "tunnelId-0010",
    "littleStar": 1,
    "latitude": "1.0993",
    "description": "description",
    "farmerPhone": "13423231112",
    "outBaseId": "outBaseId2",
    "baseId": "baseId2",
    "farmerName": "farmerName",
    "viewColor": "#ccc",
    "instructorPhone": "13423231113",
    "outTunnelId": "tunnelId-001",
    "tunnelCode": "JJ213",
    "longitude": "1.0233",
    "instructorName": "instructorName",
    "partitionId": "123",
    "boundaryCoordinates": "{\"type\":\"Feature\", \"properties\":{},\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[120.00018962106981,30.294554257460305],[119.99970749399938,30.274193330717893],[120.02397612116614,30.273929837974492],[120.02397276840486,30.295096184972877],[120.00018962106981,30.294554257460305]]]}}",
    "realArea": "123.2",
    "opacity": 20,
    "plantEnvType": 1
  }
}

出参示例

{
    "code": 200,
    "message": "success",
    "data":"ecaf24330bdf4e18ba8a969b7e82fe6d"
}

2.2 更新地块

path：/solution/farm/tunnel/update
版本：1.0.0

入参

注意，tunnelId和outTunnelId至少要有一个非空，如果两个非空要保证所属同一个地块。

参数		类型	是否必填	备注
tunnel	tunnelId	String	否	IoT地块Id
	outTunnelId	String	否	外部合作伙伴地块Id
	tunnelName	String	是	地块名称
	littleStar	Integer	否	星级
	description	String	否	介绍
	tunnelCode	String	否	编号
	plantEnvType	Integer	否	地块类型，1-加热温室/2-日光温室/3-连栋温室/4-春秋棚/5-农田/6-果园/7-水面/8-养殖/9-伐林地/10-开荒地/11-草场地
	longitude	String	否	位置经度
	latitude	String	否	位置维度
	boundaryCoordinates	String	否	边界
	realArea	String	否	面积，单位亩
	farmerName	String	否	农户姓名
	farmerPhone	String	否	农户电话
	instructorName	String	否	指导员姓名
	instructorPhone	String	否	指导员电话
	viewColor	String	否	地图展示地块颜色
	opacity	Integer	否	地图展示透明度

出参

参数	类型	备注
tunnelId	String	IoT地块Id

示例

入参示例

{
  "tunnel":
  {
    "tunnelId": "ecaf24330bdf4e18ba8a969b7e82fe6d",
    "outTunnelId": "tunnelId-001",
    "tunnelName": "tunnelId-0010",
    "littleStar": 1,
    "latitude": "1.0993",
    "description": "description",
    "farmerPhone": "13423231112",
    "farmerName": "farmerName",
    "viewColor": "#ccc",
    "instructorPhone": "13423231113",
    "tunnelCode": "JJ213",
    "longitude": "1.0233",
    "instructorName": "instructorName",
    "partitionId": "123",
    "boundaryCoordinates": "{\"type\":\"Feature\", \"properties\":{},\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[120.00018962106981,30.294554257460305],[119.99970749399938,30.274193330717893],[120.02397612116614,30.273929837974492],[120.02397276840486,30.295096184972877],[120.00018962106981,30.294554257460305]]]}}",
    "realArea": "123.2",
    "opacity": 20,
    "plantEnvType": 1
  }
}

出参示例

{
    "code": 200,
    "message": "success",
    "data":"ecaf24330bdf4e18ba8a969b7e82fe6d"
}

2.3 删除地块

path：/solution/farm/tunnel/delete
版本：1.0.0

入参

注意，tunnelId和outTunnelId至少要有一个非空，如果两个非空要保证所属同一个地块。

参数	类型	是否必填	备注
tunnelId	String	否	IoT地块Id
outTunnelId	String	否	外部合作伙伴地块Id

出参

无

示例

入参示例

{
    "tunnelId": "ecaf24330bdf4e18ba8a969b7e82fe6d",
    "outTunnelId": "tunnelId-001"
}

出参示例

{
    "code": 200,
    "message": "success"
}

2.4 分页地块查询

path：/solution/farm/tunnel/query
版本：1.0.0

入参

参数	类型	是否必填	备注
outBaseId	String	否	外部合作伙伴基地Id
baseId	String	否	IoT基地Id
pageSize	Integer	否	分页大小，默认1
pageNo	Integer	否	分页页码，默认100

出参

data.data

参数		类型	说明
total		Integer	基地总数
pageSize		Integer	页面大小
pageNo		Integer	页号
data	outTunnelId	String	外部合作伙伴地块Id
	tunnelName	String	地块名称
	outBaseId	String	外部合作伙伴基地Id
	baseId	String	IoT基地Id
	littleStar	Integer	星级
	description	String	介绍
	tunnelCode	String	编号
	plantEnvType	Integer	地块类型，1-加热温室/2-日光温室/3-连栋温室/4-春秋棚/5-农田/6-果园/7-水面/8-养殖/9-伐林地/10-开荒地/11-草场地
	longitude	String	位置经度
	latitude	String	位置维度
	boundaryCoordinates	String	边界，高德地图多边形
	realArea	String	面积，单位亩
	farmerName	String	农户姓名
	farmerPhone	String	农户电话
	instructorName	String	指导员姓名
	instructorPhone	String	指导员电话
	viewColor	String	地图展示地块颜色
	opacity	Integer	地图展示透明度

示例

入参示例

{
    "baseId": "ecaf24330bdf4e18ba8a969b7e82fe6d",
    "pageNo": 1,
  "pageSize":10
}

出参示例

{
    "code": 200,
    "data": {
        "data": [{
            "outBaseId": "outBaseId2",
            "baseId": "baseId2",
            "boundaryCoordinates": "{\"type\":\"Feature\", \"properties\":{},\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[120.00018962106981,30.294554257460305],[119.99970749399938,30.274193330717893],[120.02397612116614,30.273929837974492],[120.02397276840486,30.295096184972877],[120.00018962106981,30.294554257460305]]]}}",
            "description": "description0",
            "farmerName": "farmerName0",
            "farmerPhone": "134232311120",
            "gmtCreate": 1584966655000,
            "gmtModified": 1585015322000,
            "instructorName": "instructorName0",
            "instructorPhone": "134232311130",
            "littleStar": 10,
            "opacity": 22,
            "partitionId": "1230",
            "plantEnvType": 10,
            "scopeId": "a1033sb2GFZgjQNU",
            "spaceId": "ecaf24330bdf4e18ba8a969b7e82fe6d",
            "tunnelCode": "JJ2130",
            "tunnelId": "tunnelId-001",
            "tunnelName": "tunnelId-0010",
            "outTunnelId": "ecaf24330bdf4e18ba8a969b7e82fe6d",
            "viewColor": "#ccc0"
        }],
        "pageNo": 1,
        "pageSize": 10,
        "total": 1
    },
    "message": "success"
}

2.5 查询单个地块

path：/solution/farm/tunnel/getbyid
版本：1.0.0
注意，tunnelId和outTunnelId至少要有一个非空，如果两个非空要保证所属同一个地块。

参数	类型	是否必填	备注
tunnelId	String	否	IoT地块Id
outTunnelId	String	否	外部合作伙伴地块Id

出参

参数	类型
outTunnelId	String	外部合作伙伴地块Id
tunnelName	String	地块名称
outBaseId	String	外部合作伙伴基地Id
baseId	String	IoT基地Id
littleStar	Integer	星级
description	String	介绍
tunnelCode	String	编号
plantEnvType	Integer	地块类型？
longitude	String	位置经度
latitude	String	位置维度
boundaryCoordinates	String	边界，高德地图多边形
realArea	String	面积，单位亩
farmerName	String	农户姓名
farmerPhone	String	农户电话
instructorName	String	指导员姓名
instructorPhone	String	指导员电话
viewColor	String	地图展示地块颜色
opacity	Integer	地图展示透明度

示例

入参示例

{
    "tunnelId": "ecaf24330bdf4e18ba8a969b7e82fe6d",
    "outTunnelId": "tunnelId-001"
}

出参示例

{
    "code": 200,
    "data": {
        "outBaseId": "outBaseId2",
        "baseId": "baseId2",
        "boundaryCoordinates": "{\"type\":\"Feature\", \"properties\":{},\"geometry\":{\"type\":\"Polygon\",\"coordinates\":[[[120.00018962106981,30.294554257460305],[119.99970749399938,30.274193330717893],[120.02397612116614,30.273929837974492],[120.02397276840486,30.295096184972877],[120.00018962106981,30.294554257460305]]]}}",
        "description": "description0",
        "farmerName": "farmerName0",
        "farmerPhone": "134232311120",
        "gmtCreate": 1584966655000,
        "gmtModified": 1585015322000,
        "instructorName": "instructorName0",
        "instructorPhone": "134232311130",
        "littleStar": 10,
        "opacity": 22,
        "partitionId": "1230",
        "plantEnvType": 10,
        "scopeId": "a1033sb2GFZgjQNU",
        "spaceId": "ecaf24330bdf4e18ba8a969b7e82fe6d",
        "tunnelCode": "JJ2130",
        "tunnelId": "tunnelId-001",
        "tunnelName": "tunnelId-0010",
        "outTunnelId": "ecaf24330bdf4e18ba8a969b7e82fe6d",
        "viewColor": "#ccc0"
    },
    "message": "success"
}