POST api/Geofence/PostSaveGeofence

新增/修改一个电子围栏

请求信息

URI 参数

None.

Body 参数

SaveGeofenceModel
参数名称备注说明数据类型附加信息
DeviceID

设备ID 可以从GetDeviceList接口获取

integer

None.

UserID

创建用户ID ,如果没有用户ID也可以传0 ,如果有必须传设备所属用户ID

integer

None.

GeofenceID

电子围栏唯一ID 如果是新增围栏该值传0 如果是修改围栏参数,传递对应的围栏ID

integer

None.

MapType

地图类型 传递围栏使用时对应的地图类型 [谷歌、华为、高德、苹果原生地图传值google] [百度地图传值baidu] [天地图、OpenStreetMap传值tian]

string

None.

GeofenceName

围栏名称 长度不能超过50个字节

string

None.

GeofenceRemark

围栏备注 长度不能超过200个字节

string

None.

Latitude

纬度 传入对应地图使用的坐标

string

None.

Longitude

经度 传入对应地图使用的坐标

string

None.

Radius

围栏半径 适用圆形围栏,非圆形围栏传0即可 单位:米

integer

None.

GeofenceType

围栏类型 1表示圆形围栏 2表示多边形围栏 3表示区域围栏(该围栏类型不对外开放,请勿使用) 4表示矩形围栏

integer

None.

AlarmType

围栏报警类型 1表示进围栏报警 2表示出围栏报警 3表示进出围栏都报警

integer

None.

Token

Token 授权信息,第一次请求时该值为空

string

None.

Language

语言 中文:zh-cn 英文:en-us

string

None.

请求格式

application/json, text/json

Sample:
{
  "DeviceID": 1,
  "UserID": 2,
  "GeofenceID": 3,
  "MapType": "sample string 4",
  "GeofenceName": "sample string 5",
  "GeofenceRemark": "sample string 6",
  "Latitude": "sample string 7",
  "Longitude": "sample string 8",
  "Radius": 9,
  "GeofenceType": 10,
  "AlarmType": 11,
  "Token": "sample string 12",
  "Language": "sample string 13"
}

application/xml, text/xml

Sample:
<SaveGeofenceModel xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenWebAPI.Models.ParModel">
  <Language>sample string 13</Language>
  <Token>sample string 12</Token>
  <AlarmType>11</AlarmType>
  <DeviceID>1</DeviceID>
  <GeofenceID>3</GeofenceID>
  <GeofenceName>sample string 5</GeofenceName>
  <GeofenceRemark>sample string 6</GeofenceRemark>
  <GeofenceType>10</GeofenceType>
  <Latitude>sample string 7</Latitude>
  <Longitude>sample string 8</Longitude>
  <MapType>sample string 4</MapType>
  <Radius>9</Radius>
  <UserID>2</UserID>
</SaveGeofenceModel>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'SaveGeofenceModel'.

响应信息

资源描述

SaveGeofenceResult
参数名称备注说明数据类型附加信息
result

处理结果 1表示新增/修改成功 0表示新增/修改失败

integer

None.

State

返回值基类 0表示成功返回 -1表示接口异常

integer

None.

Remark

返回值说明 通常用于解释返回值情况,例如:接口成功返回、提交的鉴权信息匹配异常等解释说明 0:接口成功返回 -1:接口返回异常 999:鉴权失败 1:提交的鉴权信息匹配异常 2:提交的Token已过期,请重新获取Token 3:用户不存在 4:暂不支持设备IMEI登录 5:用户名下没有设备存在 6:没有获取到分组信息 7:设备不存在 8:没有获取到该时间段内的轨迹数据 9:没有获取到该设备的报警信息 10:用户不存在或密码不匹配 11:报警信息不存在 12:要删除的电子围栏不存在 13:没有获取到该设备的ACC数据 14:该区域内没有设备存在 15:无法获取到该设备的OBD信息 16:要修改的围栏不属于该设备

string

None.

响应格式

application/json, text/json

Sample:
{
  "result": 1,
  "State": 2,
  "Remark": "sample string 3"
}

application/xml, text/xml

Sample:
<SaveGeofenceResult xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/OpenWebAPI.Models.ResModel">
  <Remark>sample string 3</Remark>
  <State>2</State>
  <result>1</result>
</SaveGeofenceResult>