1598 lines
44 KiB
Plaintext
1598 lines
44 KiB
Plaintext
上海城建勘测院
|
||
监测数据不落地平台
|
||
接口管理规范
|
||
2021年12月
|
||
目录
|
||
目录1
|
||
修订记录8
|
||
1.基础数据说明9
|
||
1.1.接口返回状态值说明9
|
||
1.2.接口固定参数值说明9
|
||
1.2.1.请求头参数SecretKey9
|
||
1.2.2.请求头参数SystemCode10
|
||
1.2.3.请求头参数Token10
|
||
1.2.4.测试系统IP和端口10
|
||
2.接口说明10
|
||
2.1.所有API目录10
|
||
2.2.登录接口11
|
||
2.2.1.账号密码登录接口11
|
||
2.2.1.1.接口描述11
|
||
2.2.1.2.接口请求URL地址11
|
||
2.2.1.3.接口请求方式11
|
||
2.2.1.4.接口参数12
|
||
2.2.1.5.接口返回值格式12
|
||
2.2.1.6.返回值示例13
|
||
2.2.2.发送验证码（获取验证码）13
|
||
2.2.2.1.接口描述13
|
||
2.2.2.2.接口请求URL地址13
|
||
2.2.2.3.接口请求方式13
|
||
2.2.2.4.接口参数14
|
||
2.2.2.5.接口返回值格式14
|
||
2.2.2.6.返回值示例15
|
||
2.2.3.手机验证码登录15
|
||
2.2.3.1.接口描述15
|
||
2.2.3.2.接口请求URL地址15
|
||
2.2.3.3.接口请求方式15
|
||
2.2.3.4.接口参数16
|
||
2.2.3.5.接口返回值格式16
|
||
2.2.3.6.返回值示例17
|
||
2.3.修改密码18
|
||
2.3.1.修改登录密码接口18
|
||
2.3.1.1.接口描述18
|
||
2.3.1.2.接口请求URL地址18
|
||
2.3.1.3.接口请求方式18
|
||
2.3.1.4.接口参数18
|
||
2.3.1.5.接口返回值格式19
|
||
2.3.1.6.返回值示例19
|
||
2.4.获取当前用户信息19
|
||
2.4.1.接口描述19
|
||
2.4.2.接口请求URL地址19
|
||
2.4.3.接口请求方式20
|
||
2.4.4.接口参数20
|
||
2.4.5.接口返回值格式20
|
||
2.4.6.返回值示例21
|
||
2.5.获取项目数据接口21
|
||
2.5.1.1.获取当前用户项目列表21
|
||
2.5.1.2.接口描述21
|
||
2.5.1.3.接口请求URL地址21
|
||
2.5.1.4.接口请求方式21
|
||
2.5.1.5.接口请求头参数22
|
||
2.5.1.6.接口返回值格式22
|
||
2.5.1.7.返回值示例23
|
||
2.6.获取APP端任务列表23
|
||
2.6.1.接口描述23
|
||
2.6.2.接口请求URL地址23
|
||
2.6.3.接口请求方式24
|
||
2.6.4.接口参数24
|
||
2.6.5.接口返回值格式25
|
||
2.6.6.返回值示例25
|
||
2.7.获取项目当前监测计划的任务列表26
|
||
2.7.1.接口描述26
|
||
2.7.2.接口请求URL地址26
|
||
2.7.3.接口请求方式27
|
||
2.7.4.接口参数27
|
||
2.7.5.接口返回值格式27
|
||
2.7.6.返回值示例28
|
||
2.8.获取监测计划及上传监测值（废除）28
|
||
2.8.1.获取监测计划28
|
||
2.8.1.1.接口描述28
|
||
2.8.1.2.接口请求URL地址29
|
||
2.8.1.3.接口请求方式29
|
||
2.8.1.4.接口参数29
|
||
2.8.1.5.接口返回值格式29
|
||
2.8.1.6.返回值示例30
|
||
2.8.2.上传本次监测值30
|
||
2.8.2.1.接口描述30
|
||
2.8.2.2.接口请求URL地址30
|
||
2.8.2.3.接口请求方式31
|
||
2.8.2.4.接口参数31
|
||
2.8.2.5.参数MonitorValue对象31
|
||
2.8.2.6.接口返回值格式31
|
||
2.9.获取测组包含的监测点列表32
|
||
2.9.1.接口描述32
|
||
2.9.2.接口请求URL地址32
|
||
2.9.3.接口请求方式32
|
||
2.9.4.接口参数32
|
||
2.9.5.接口返回值格式33
|
||
2.9.6.返回值示例33
|
||
2.9.6.1.PointList 所关联监测点33
|
||
2.9.6.2.LastMonitorData属性说明34
|
||
2.10.获取项目监测计划统计表34
|
||
2.10.1.接口描述34
|
||
2.10.2.接口请求URL地址34
|
||
2.10.3.接口请求方式34
|
||
2.10.4.接口参数35
|
||
2.10.5.接口返回值格式35
|
||
2.10.6.返回值示例35
|
||
2.11.获取指定监测计划的测组统计表36
|
||
2.11.1.接口描述36
|
||
2.11.2.接口请求URL地址36
|
||
2.11.3.接口请求方式36
|
||
2.11.4.接口参数36
|
||
2.11.5.接口返回值格式37
|
||
2.11.6.返回值示例37
|
||
2.12.监测点统计表38
|
||
2.12.1.接口描述38
|
||
2.12.2.接口请求URL地址38
|
||
2.12.3.接口请求方式38
|
||
2.12.4.接口参数38
|
||
2.12.5.接口返回值格式39
|
||
2.12.6.返回值示例39
|
||
2.13.数据解析（原始文件上传）40
|
||
2.13.1.接口描述40
|
||
2.13.2.接口请求URL地址40
|
||
2.13.3.接口请求方式40
|
||
2.13.4.接口参数40
|
||
2.13.4.1.参数MonitorData对象41
|
||
2.13.5.接口返回值格式41
|
||
2.14.获取基准点42
|
||
2.14.1.接口描述42
|
||
2.14.2.接口请求URL地址42
|
||
2.14.3.接口请求方式42
|
||
2.14.4.接口参数42
|
||
2.14.5.接口返回值格式43
|
||
2.14.6.返回值示例43
|
||
2.15.获取工点数据44
|
||
2.15.1.接口描述44
|
||
2.15.2.接口请求URL地址44
|
||
2.15.3.接口请求方式44
|
||
2.15.4.接口参数44
|
||
2.15.5.接口返回值格式45
|
||
2.15.6.返回值示例46
|
||
修订记录
|
||
日期
|
||
版本
|
||
编制/修订内容摘要
|
||
编制人
|
||
2022-1-24
|
||
V3.5
|
||
增加章节2.8的接口，根据项目获取项目的监测项接口
|
||
漆志立
|
||
2022--17
|
||
V3.8
|
||
增加章节2.1.2发送验证码的接口
|
||
修改章节2.1.3手机验证码登录接口
|
||
修改章节2.3获取当前用户信息接口，
|
||
修改章节2.4获取项目数据接口
|
||
变更章节2.5位获取APP端任务列表接口
|
||
变更章节2.6为获取项目当前监测计划的任务列表接口
|
||
变更章节2.8为获取测组包含的监测点列表接口
|
||
增加章节2.9获取项目监测计划统计表接口
|
||
增加章节2.10获取指定监测几乎统计表接口
|
||
增加章节2.11监测点统计表接口
|
||
增加章节2.12数据上传接口
|
||
增加章节2.13获取基准点接口，
|
||
增加章节2.14获取项目信息接口
|
||
李勇潘
|
||
2022-08
|
||
V3.9
|
||
增加所有api接口列表的表格说明，章节2.1，原来接口的章节编号说明顺延
|
||
原章节2.14和原2.5合并，取消原章节2.14接口说明
|
||
修改2.13数据解析（原始文件上传）接口类型
|
||
2022-12
|
||
V4.0
|
||
修改章节2.6，2.6.2新增接口URL请求地址(接口3);2.6.5返回值TaskList 所关联监测点中新增属性工点ID
|
||
修改章节2.13，2.3.4接口参数新增WorkPointID(工点ID),原参数MonitorData改为PointsData
|
||
增加章节2.15获取工点数据接口
|
||
增加章节2.16上传水位自动化数据
|
||
2023-03
|
||
V4.1
|
||
修改章节2.9获取测组包含的监测点列表，修改接口传递数值类型
|
||
2023-04
|
||
V4.2
|
||
2.13接口中 2.13.4.1.3.1CXSubData对象不在需要上传FrontCurrentValue(管形位移改正前)值，CurrentValue改为上传管形位移改正前值2.13接口支持上传支撑轴力数据
|
||
2023-06
|
||
V4.3
|
||
增加2.17章节接口
|
||
2023-07
|
||
V4.4
|
||
2.13接口支持上传地下水位数据
|
||
2023-07
|
||
V4.5
|
||
2.6接口将返回WorkPointName工点名称
|
||
2.9接口新增属性AxiaType(支撑轴力监测类型),InitialValueData，LastMonitorData将返回传感器编号
|
||
2.13接口支撑轴力上传数据新增属性InitialFrequency(初始频率)，InitialTemperature(初始温度)
|
||
基础数据说明
|
||
接口返回状态值说明
|
||
状态值编码
|
||
值描述
|
||
200
|
||
接口请求成功
|
||
500
|
||
接口请求失败
|
||
429
|
||
同一条数据一分钟内频繁请求接口，次数超过允许请求最大次数
|
||
403
|
||
同一条数据请求接口连续报错，次数超过允许出错的最大次数
|
||
接口固定参数值说明
|
||
请求头参数SecretKey
|
||
PC端系统为每个调用接口的供应商分配一个调用接口的秘钥，此秘钥在调用接口的时候会校验，如果校验成功，才允许继续调用接口，如果校验失败，则不允许调用接口。
|
||
此秘钥为随机分配秘钥，可能会定期更换，供应商最好做成配置项方便在 不调整程序的前提下随时修改秘钥值。
|
||
此参数放在请求头同中请求接口。
|
||
请求头参数SystemCode
|
||
PC端系统为每个调用接口的供应商分配一个调用接口的供应商编码，用于记录调用接口日志，方便以后追踪是哪个供应商调用的接口。
|
||
“SystemCode”与“SecretKey”一一对应，如果调用接口时2者之间不匹配，也无法成功调用接口。
|
||
此参数放在请求头同中请求接口。
|
||
请求头参数Token
|
||
调用接口(除登录接口外)时放到请求头里面，避免重要信息泄露
|
||
测试系统IP和端口
|
||
http://106.15.183.20:8006/
|
||
接口说明
|
||
所有API目录
|
||
API地址
|
||
所在章节
|
||
API接口说明
|
||
/OutWebApi/api/LoginByAccount
|
||
章节2.2.1
|
||
账号密码登录接口
|
||
/OutWebApi/api/LoginSecurityCode
|
||
章节2.2.2
|
||
发送短信验证码接口
|
||
/OutWebApi/api/LoginByMobile
|
||
章节2.2.3
|
||
手机验证码登录接口
|
||
/OutWebApi/api/ModifyPassword
|
||
章节2.3.1
|
||
修改登录密码接口
|
||
/OutWebApi/api/GetUserInfo
|
||
章节2.4
|
||
获取当前用户信息
|
||
/OutWebApi/api/GetProjectList
|
||
章节2.5
|
||
获取当前用户项目列表
|
||
/OutWebApi/api/GetUserPlanGroup
|
||
章节2.6
|
||
获取APP端任务列表
|
||
/OutWebApi/api/GetPlanGroup
|
||
章节2.7
|
||
项目当前监测计划的任务列表
|
||
/OutWebApi/api/GetPointBySurveyGroup
|
||
章节2.9
|
||
获取测组包含的监测点列表
|
||
/OutWebApi/api/GetPlanStatistical
|
||
章节2.10
|
||
获取项目监测计划统计表
|
||
/OutWebApi/api/GetSurveyGroupList
|
||
章节2.11
|
||
获取指定监测计划的测组统计表
|
||
/OutWebApi/api/GetPointStatistics
|
||
章节2.12
|
||
监测点统计表
|
||
/OutWebApi/api/AnalysisMonitorData
|
||
章节2.13
|
||
数据上传（原始文件）
|
||
/OutWebApi/api/ControlPoint
|
||
章节2.14
|
||
获取基准点
|
||
/OutWebApi/api/ControlPoint
|
||
章节2.15
|
||
获取工点（进行中的）
|
||
登录接口
|
||
账号密码登录接口
|
||
接口描述
|
||
用户通过账号密码登录手机APP，校验并获取PC端用户token
|
||
接口请求URL地址
|
||
/OutWebApi/api/LoginByAccount
|
||
接口请求方式
|
||
POST请求，参数传递格式：json格式，格式参见参数说明
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
调用接口供应商编码，具体说明见章节1.2.2
|
||
UserLoginData
|
||
UserLoginData对象
|
||
UserLoginData对象参数，具体说明见章节2.2.1.4.1
|
||
参数UserLoginData
|
||
参数格式示例：{“LoginName”:”XXXX”,” Password”:”XXXX”}
|
||
属性编号
|
||
属性类型
|
||
属性名称
|
||
属性说明
|
||
LoginName
|
||
String
|
||
登录名称
|
||
必须项 用户登录账号
|
||
Password
|
||
String
|
||
登录密码
|
||
必须项 用户登录密码
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :“Token：token值”
|
||
}，
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :null
|
||
}
|
||
返回值示例
|
||
章节2.1.1.5中执行成功的返回值（data）中的属性说明
|
||
属性名称
|
||
属性说明
|
||
参数说明
|
||
Token
|
||
用户登录Token
|
||
获取的Token用于获取当前用户项目, 当前用户信息和设置密码和数据上传时获取当前上传人。
|
||
发送验证码（获取验证码）
|
||
接口描述
|
||
用户通过手机号码获取登录验证码
|
||
接口请求URL地址
|
||
/OutWebApi/api/LoginSecurityCode?MobilePhone=XXXX
|
||
接口请求方式
|
||
GET请求
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
调用接口秘钥，具体说明见章节1.2.2
|
||
MobilePhone
|
||
String
|
||
发送短信的目标手机号，
|
||
可在手机号前+86、86等表示区域或者不加，不加区域代表是国内手机号，发送短信支持国际手机号，
|
||
登录校验目前程序仅支持国内手机号，以防手机号乱维护，所以用了全匹配模式判断手机号是否属于某用户
|
||
如果传递手机号之前用（+86），需要处理下特殊字符，改为（%2B86），否则发送不成功
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :”result：true”
|
||
}，
|
||
同时手机会收到验证码提示短信
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”result：false”
|
||
}
|
||
返回值示例
|
||
章节2.1.1.5中执行成功的返回值（data）中的属性说明
|
||
属性名称
|
||
属性说明
|
||
参数说明
|
||
result
|
||
验证码是否发送成功
|
||
验证码发送成功会返回true，发送失败会返回false
|
||
手机验证码登录
|
||
接口描述
|
||
用户通过手机号码验证码校验后App端调用接口获取PC端用户token
|
||
接口请求URL地址
|
||
/OutWebApi/api/LoginByMobile
|
||
接口请求方式
|
||
Post请求传递Json参数
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
调用接口秘钥，具体说明见章节1.2.2
|
||
MobileMsg
|
||
MobileMsg对象
|
||
见2.2.3.4.1
|
||
MobileMsg说明
|
||
参数格式说明{“Mobile”:“XXXXX”,“VerificationCode”：“XXXXX”}
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
Mobile
|
||
String
|
||
用户手机号
|
||
可在手机号前+86、86等表示区域或者不加，登录校验目前程序仅支持国内手机号，以防手机号乱维护，所以用了全匹配模式判断手机号是否属于某用户
|
||
VerificationCode
|
||
String
|
||
短信登录验证码
|
||
如果用户请求发送多次验证码，则以最近一次发送的验证码为有效验证码
|
||
如果验证码已过提示的有效期，则需要重新请求发送验证码
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :”Token：token值”
|
||
}，
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :null
|
||
}
|
||
返回值示例
|
||
章节2.1.1.5中执行成功的返回值（data）中的属性说明
|
||
属性名称
|
||
属性说明
|
||
参数说明
|
||
Token
|
||
用户登录Token
|
||
获取的Token用于获取当前用户项目, 当前用户信息和设置密码和数据上传时获取当前上传人。
|
||
修改密码
|
||
修改登录密码接口
|
||
接口描述
|
||
修改用户登录密码
|
||
接口请求URL地址
|
||
/OutWebApi/api/ModifyPassword
|
||
接口请求方式
|
||
Post请求传递Json参数
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
调用接口供应商编码，具体说明见章节1.2.2
|
||
Token
|
||
String
|
||
请求头信息
|
||
UserLoginData
|
||
UserLoginData对象
|
||
具体说明见章节2.3.1.4.1
|
||
参数UserLoginData
|
||
参数格式示例{“Password”：“XXXXX”，“ConfirmAnswer”：“XXXXX”}
|
||
属性编号
|
||
属性类型
|
||
属性名称
|
||
属性说明
|
||
Password
|
||
String
|
||
原登录密码
|
||
必须项 用户登录密码
|
||
ConfirmAnswer
|
||
String
|
||
新密码
|
||
必须项用户新密码
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :null
|
||
}，
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :null
|
||
}
|
||
返回值示例
|
||
无
|
||
获取当前用户信息
|
||
接口描述
|
||
获取当前用户信息
|
||
接口请求URL地址
|
||
/OutWebApi/api/GetUserInfo
|
||
接口请求方式
|
||
Get请求
|
||
接口参数
|
||
请求头参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头信息，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头信息，调用接口供应商编码，具体说明见章节1.2.2
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :” UserInfo：json格式的列表数据，具体属性见章节2.4.6”
|
||
}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”如果需要接口返回数据，则返回数据在此属性中”
|
||
}
|
||
返回值示例
|
||
章节2.3.5中执行成功的返回值（data）中的属性说明
|
||
属性
|
||
属性名称
|
||
属性说明
|
||
Name
|
||
用户名称
|
||
DeptName
|
||
部门名称
|
||
MobilePhone
|
||
手机号
|
||
LoginName
|
||
登录账号
|
||
获取项目数据接口
|
||
获取当前用户项目列表
|
||
接口描述
|
||
获取当前用户有权限的、项目阶段为“进行中”的项目列表
|
||
接口请求URL地址
|
||
接口1：/OutWebApi/api/GetProjectList?ProjectID=XXXX
|
||
接口2：/OutWebApi/api/GetProjectList
|
||
备注：以上2个接口都支持，实际调用请按以下说明具体选用哪个接口
|
||
第一个接口：如果ProjectID传递的值存在，返回的是项目ID=XXXX的项目列表数据，如果ProjectID参数传了空值，则跟第二个接口返回的结果一致
|
||
第二个接口：返回的是当前用户所有的项目列表数据
|
||
接口请求方式
|
||
Get请求
|
||
接口请求头参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头信息，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头信息，调用接口供应商编码，具体说明见章节1.2.2
|
||
Token
|
||
String
|
||
请求头信息
|
||
ProjectID
|
||
String
|
||
非必填项，项目ID
|
||
如果项目ID为空，则返回当前用户所有的项目列表数据
|
||
如果项目ID不为空，则返回项目ID=XXXX的项目列表数据，只是列表数据只有一条
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :” ProjectList：json格式的列表格式数据，具体属性见章节2.5.1.6”
|
||
}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”如果需要接口返回数据，则返回数据在此属性中”
|
||
}
|
||
返回值示例
|
||
章节2.5.1.6中执行成功的返回值（data对象）中的属性ProjectList说明，如需其他属性，双方待确认
|
||
属性名称
|
||
属性说明
|
||
参数说明
|
||
ID
|
||
项目ID
|
||
ProjectCode
|
||
项目编号
|
||
SimpleName
|
||
项目简称
|
||
ProjectScale
|
||
项目等级
|
||
枚举值：总院重点，部门重点，一般项目
|
||
ProjectPhase
|
||
项目阶段（状态）
|
||
枚举值：未开始、进行中、已结束
|
||
获取APP端任务列表
|
||
接口描述
|
||
获取APP端任务列表(一个项目的一个监测计划的一个测组为一条任务，项目带权限控制，只返回进行中的项目，只返回任务类型为"APP上传"且责任人为本人的测组，如果一条监测计划不包含满足条件的测组，则不会返回该计划关联的任务；）
|
||
接口请求URL地址
|
||
接口1：/OutWebApi/api/GetUserPlanGroup?ProjectID=XXXX&planDate =XXXX
|
||
接口2：/OutWebApi/api/GetUserPlanGroup?planDate =XXXX
|
||
接口3：/OutWebApi/api/GetUserPlanGroup?planDate=XXXX&WorkPointID=XXXX
|
||
备注：以上3个接口都支持，实际调用请按以下说明具体选用哪个接口
|
||
第一个接口：如果ProjectID和PlanDate都传递，返回的是某项目下某日期的任务列表，如果ProjectID参数传了空值，则跟第二个接口返回的结果一致
|
||
第二个接口：如果只传递PlanDate，返回某日期下所有“进行中”的项目的任务列表
|
||
第三个接口：如果WorkPointID和PlanDate都传递，返回的是某工点下某日期的任务列表，如果WorkPointID参数传了空值，则跟第二个接口返回的结果一致
|
||
接口请求方式
|
||
GET请求
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头信息，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头信息，调用接口供应商编码，具体说明见章节1.2.2
|
||
Token
|
||
String
|
||
请求头信息，当前用户token
|
||
ProjectID
|
||
String
|
||
非必填项，项目ID
|
||
如果项目ID为空，则返回当前日期所有本人项目的测组任务
|
||
如果项目ID不为空，则返回当前项目本人所负责的测组任务
|
||
以上条件的前提都是以“PlanDate”传递参数为基础
|
||
PlanDate
|
||
String
|
||
必填项 ，任务所属日期
|
||
日期格式：yyyy-MM-dd(譬如：2022-04-01)
|
||
WorkPointID
|
||
String
|
||
非必填项，工点ID
|
||
如果工点ID为空，则返回当前日期所有本人项目下所有工点的测组任务
|
||
如果工点ID不为空，则返回当前工点本人所负责的测组任务
|
||
以上条件的前提都是以“PlanDate”传递参数为基础
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :{ TaskList: json格式的列表格式数据，具体属性见章节2.5.6}
|
||
}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”如果需要接口返回数据，则返回数据在此属性中”
|
||
}
|
||
返回值示例
|
||
章节2.6.5中执行成功的返回值（data对象）中的属性TaskList说明，如需其他属性双方待确认
|
||
TaskList 所关联监测点
|
||
属性
|
||
属性名称
|
||
参数说明
|
||
SimpleName
|
||
项目简称
|
||
TaskCode
|
||
任务编号
|
||
项目编号-计划期数-测组编号
|
||
ProjectID
|
||
项目ID
|
||
PlanID
|
||
监测计划ID
|
||
PlanNum
|
||
计划对应期数值
|
||
1,2,3,4,5等之类的值
|
||
Working
|
||
施工工况
|
||
Mold
|
||
类型
|
||
（常规，加测）
|
||
DutyName
|
||
责任人
|
||
GroupID
|
||
测组ID
|
||
WorkPointID
|
||
工点ID
|
||
WorkPointName
|
||
工点名称
|
||
MonitoringType
|
||
监测类型
|
||
水平位移，竖向位移，测斜，收敛，水位，轴力
|
||
BeginTime
|
||
开始时间
|
||
即上一期计划的截止时间，格式:yyyy-MM-dd HH:mm
|
||
EndTime
|
||
截止时间
|
||
最低精确到小时，格式:yyyy-MM-dd HH:mm
|
||
CompleteDegree
|
||
完成度
|
||
本测组已上传点数/测组总点数
|
||
获取项目当前监测计划的任务列表
|
||
接口描述
|
||
获取项目当前监测计划的任务列表(离当前时间最近的一个监测计划所包含的任务列表））
|
||
接口请求URL地址
|
||
接口1：/OutWebApi/api/GetPlanGroup?ProjectID=xxxx
|
||
接口2：/OutWebApi/api/GetPlanGroup
|
||
备注：以上2个接口都支持，实际调用请按以下说明具体选用哪个接口
|
||
第一个接口：如果ProjectID传递的值存在，返回的是某项目下最近的监测计划任务列表，如果ProjectID参数传了空值，则跟第二个接口返回的结果一致
|
||
第二个接口：如果不传递任何参数，返回所有“进行中”的项目的监测计划任务列表
|
||
接口请求方式
|
||
Get请求
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头信息，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头信息，调用接口供应商编码，具体说明见章节1.2.2
|
||
ProjectID
|
||
String
|
||
非必填项，项目ID，如果值为空，则返回所有项目符合条件的任务列表
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :{ TaskList: json格式的列表格式数据，具体属性见章节2.7.6}
|
||
}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”如果需要接口返回数据，则返回数据在此属性中”
|
||
}
|
||
返回值示例
|
||
章节2.7.5中执行成功的返回值（data对象）中的属性TaskList说明，如需其他属性，双方待确认
|
||
TaskList所关联监测点
|
||
属性名称
|
||
属性说明
|
||
参数说明
|
||
SimpleName
|
||
项目简称
|
||
TaskCode
|
||
任务编号
|
||
项目编号-计划期数-测组编号
|
||
ProjectID
|
||
项目ID
|
||
PlanID
|
||
监测计划ID
|
||
PeriodsNum
|
||
期数
|
||
Working
|
||
施工工况
|
||
Mold
|
||
类型
|
||
（常规，加测）
|
||
DutyName
|
||
责任人名称
|
||
GroupID
|
||
测组ID
|
||
MonitoringType
|
||
监测类型
|
||
水平位移，竖向位移，测斜，收敛，水位，轴力
|
||
BeginTime
|
||
开始时间
|
||
即上一期计划的截止时间，格式:yyyy-MM-dd HH:mm
|
||
EndTime
|
||
截止时间
|
||
最低精确到小时，格式:yyyy-MM-dd HH:mm
|
||
CompleteDegree
|
||
完成度
|
||
本测组已上传点数/测组总点数
|
||
获取监测计划及上传监测值（废除）
|
||
获取监测计划
|
||
接口描述
|
||
获取监测计划
|
||
接口请求URL地址
|
||
/OutWebApi/api/GetMonitorPoint?ProjectID=XXX
|
||
接口请求方式
|
||
Get请求
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头参数，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头参数，接口供应商编码，具体说明见章节1.2.2
|
||
ProjectID
|
||
String
|
||
必须项项目ID
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :”MonitorInfo：监测计划json列表格式的数据对象，具体属性见章节2.5.1.6”,
|
||
}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”如果需要接口返回数据，则返回数据在此属性中”
|
||
}
|
||
返回值示例
|
||
章节2.4.1.5中执行成功的返回值（data）中的属性说明MonitorInfo
|
||
MonitorInfo 监测计划
|
||
属性
|
||
属性名称
|
||
属性说明
|
||
ID
|
||
监测计划ID
|
||
PeriodsNum
|
||
期数
|
||
ProjectID
|
||
项目ID
|
||
MonitoringDate
|
||
监测日期
|
||
MonitoringType
|
||
类型
|
||
常规，加测
|
||
EndTime
|
||
截止日期
|
||
SurveyGroup
|
||
测组ID
|
||
如果有多个测组，用“,”分割，与属性“SurveyGroupName”一一对应
|
||
SurveyGroupName
|
||
测组名称
|
||
如果有多个测组，用“,”分割，与属性“SurveyGroup”一一对应
|
||
上传本次监测值
|
||
接口描述
|
||
根据监测计划及监测点上传对应的监测值
|
||
接口请求URL地址
|
||
/OutWebApi/api/UploadMonitorValue
|
||
接口请求方式
|
||
Post请求传递Json参数
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头参数，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头参数，接口供应商编码，具体说明见章节1.2.2
|
||
Token
|
||
String
|
||
请求头信息
|
||
MonitorValue
|
||
String
|
||
必须项，json格式数据对象，具体说明见章节2.7.2.5
|
||
参数MonitorValue对象
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
ProjectID
|
||
String
|
||
必须项项目ID
|
||
PointID
|
||
String
|
||
必须项监测点ID
|
||
Value
|
||
String
|
||
必须项，本次监测值
|
||
MonitorDate
|
||
datetime
|
||
必须项 ,本次监测日期
|
||
MonitoringPlanID
|
||
String
|
||
必须项 监测计划ID
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :null
|
||
}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”null”
|
||
}
|
||
获取测组包含的监测点列表
|
||
接口描述
|
||
获取测组包含的监测点列表
|
||
接口请求URL地址
|
||
/OutWebApi/api/GetPointBySurveyGroup?GroupID=xxxx
|
||
接口请求方式
|
||
Get请求
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头信息，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头信息，调用接口供应商编码，具体说明见章节1.2.2
|
||
GroupID
|
||
String
|
||
必填项 测组ID
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :{ PointList: json格式的列表格式数据，具体属性见章节2.8.6}
|
||
}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”如果需要接口返回数据，则返回数据在此属性中”
|
||
}
|
||
返回值示例
|
||
章节2.9.5中执行成功的返回值（data对象）中的属性PointList说明，如需其他属性，双方待确认
|
||
PointList 所关联监测点
|
||
属性
|
||
属性名称
|
||
属性说明
|
||
ID
|
||
监测点ID
|
||
PointSimpleName
|
||
点名简称
|
||
PointName
|
||
点名
|
||
InitialValueData
|
||
初值列表
|
||
RateAlarm
|
||
速率报警值
|
||
TotalAlarm
|
||
累计报警值
|
||
LastMonitorDate
|
||
上次观值列表
|
||
见2.9.6.2 LastMonitorDate属性说明
|
||
MonitorDate
|
||
上次观测时间
|
||
AxiaType
|
||
支撑轴力监测类型
|
||
支撑轴力监测类型分为：“钢支撑”，“钢筋混凝土支撑(不考虑温度)”，“钢筋混凝土支撑(混凝土应变计/考虑温度)”,“钢筋混凝土支撑(非混凝土应变计/考虑温度)”4种
|
||
InitialValueData属性说明
|
||
属性
|
||
属性名称
|
||
属性说明
|
||
Attribute
|
||
属性
|
||
监测类型为测斜时属性为孔深值，监测类型为支撑轴力时属性为轴力，其他监测类型属性为高程
|
||
InitialValue
|
||
初值
|
||
LastMonitorData属性说明
|
||
属性
|
||
属性名称
|
||
属性说明
|
||
Attribute
|
||
属性
|
||
监测类型为测斜时属性为孔深值，监测类型为支撑轴力时属性为传感器编号，其他监测类型属性为高程
|
||
LastMonitorValue
|
||
上次观测值
|
||
获取项目监测计划统计表
|
||
接口描述
|
||
获取项目监测计划统计表,只列出包含"APP上传"测组的监测计划
|
||
接口请求URL地址
|
||
/OutWebApi/api/GetPlanStatistical?ProjectID =xxxx
|
||
接口请求方式
|
||
Get请求
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头信息，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头信息，调用接口供应商编码，具体说明见章节1.2.2
|
||
ProjectID
|
||
String
|
||
必填项，项目ID
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :{ PlanList: json格式的列表格式数据，具体属性见章节2.10.6}
|
||
}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”如果需要接口返回数据，则返回数据在此属性中”
|
||
}
|
||
返回值示例
|
||
章节2.10.5中执行成功的返回值（data对象）中的属性PlanList说明，如需其他属性，双方待确认
|
||
PlanList说明
|
||
属性名称
|
||
属性说明
|
||
参数说明
|
||
PlanID
|
||
监测计划ID
|
||
PeriodsNum
|
||
期数
|
||
EndTime
|
||
截止时间
|
||
Working
|
||
施工工况
|
||
CompleteDegree
|
||
完成度
|
||
非APP上传类型的测组不参与统计，未开始上传的计划的完成度为0
|
||
Mold
|
||
类型
|
||
（常规，加测）
|
||
获取指定监测计划的测组统计表
|
||
接口描述
|
||
获取指定监测计划的测组统计表,只列出包含"APP上传"测组的监测计划
|
||
接口请求URL地址
|
||
/OutWebApi/api/GetSurveyGroupList?PlanID=xxxx
|
||
接口请求方式
|
||
Get请求
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头信息，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头信息，调用接口供应商编码，具体说明见章节1.2.2
|
||
PlanID
|
||
String
|
||
必填项，监测计划ID
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :{ GroupList: json格式的列表格式数据，具体属性见章节2.11.6}
|
||
}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”如果需要接口返回数据，则返回数据在此属性中”
|
||
}
|
||
返回值示例
|
||
章节2.11.5中执行成功的返回值（data对象）中的属性GroupList说明，如需其他属性，双方待确认
|
||
GroupList说明
|
||
属性
|
||
属性名称
|
||
属性说明
|
||
GroupID
|
||
测组ID
|
||
GroupName
|
||
测组名称
|
||
DutyName
|
||
责任人
|
||
CompleteDegree
|
||
完成度
|
||
MonitoringType
|
||
监测类型
|
||
监测点统计表
|
||
接口描述
|
||
获取监测点统计表
|
||
接口请求URL地址
|
||
/OutWebApi/api/GetPointStatistics?PlanID=xxxx&GroupID=xxxxx
|
||
接口请求方式
|
||
Get请求
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头信息，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头信息，调用接口供应商编码，具体说明见章节1.2.2
|
||
PlanID
|
||
String
|
||
必填项，监测计划ID
|
||
GroupID
|
||
String
|
||
必填项，测组ID
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :{ PointsList: json格式的列表格式数据，具体属性见章节2.12.6}
|
||
}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”如果需要接口返回数据，则返回数据在此属性中”
|
||
}
|
||
返回值示例
|
||
章节2.12.5中执行成功的返回值（data对象）中的属性PointsList说明，如需其他属性，双方待确认
|
||
PointsList说明
|
||
属性
|
||
属性名称
|
||
属性说明
|
||
PointName
|
||
点名
|
||
ImportTime
|
||
上传时间
|
||
MonitorEqu
|
||
设备
|
||
数据解析（原始文件上传）
|
||
接口描述
|
||
解析用户上传得监测数据，目前只兼容水平位移的数据（涉及到公式计算）
|
||
接口请求URL地址
|
||
/OutWebApi/api/AnalysisMonitorData
|
||
接口请求方式
|
||
Post请求，
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头信息，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头信息，调用接口供应商编码，具体说明见章节1.2.2
|
||
Token
|
||
string
|
||
请求头当前用户信息，具体说明见章节1.2.3
|
||
ProjectID
|
||
multipart/form-data
|
||
必须项 监测项目ID
|
||
WorkPointID
|
||
multipart/form-data
|
||
必须项 监测工点ID
|
||
SurveyGroupID
|
||
multipart/form-data
|
||
必须项 测组ID
|
||
PlanID
|
||
multipart/form-data
|
||
必须项 监测计划ID
|
||
MonitorDate
|
||
multipart/form-data
|
||
监测日期
|
||
WorkInfo
|
||
multipart/form-data
|
||
工况
|
||
Equipment
|
||
multipart/form-data
|
||
观测设备
|
||
Weather
|
||
multipart/form-data
|
||
天气
|
||
PointsData
|
||
multipart/form-data
|
||
List对象，json数组，格式参见章节2.13.4.1（MonitorData改为PointsData）
|
||
Files
|
||
multipart/form-data
|
||
此参数名可不用写，接口自动获取文件类型，目前只支持接收单个文件
|
||
参数PointsData对象
|
||
参数示例：由于各类型（竖向、水位、测斜）的观测数据衡量方式可能不一样，后续这个对象的格式会根据不同的类型有不同的格式要求，目前确定的格式有以下3种（此格式要求是为了和报表上传的格式统一）
|
||
竖向位移
|
||
[{“Point”：“”，“PointName”：“”， “CurrentValue”：“”，“CurrentChangeValue”：“”，“IsInitValue”：“”}]
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
Point
|
||
String
|
||
必须项属性，监测点ID
|
||
PointName
|
||
String
|
||
必须项属性，监测点Name
|
||
CurrentValue
|
||
Decimal
|
||
必须项本次观测值
|
||
CurrentChangeValue
|
||
Decimal
|
||
非必须属性，本次变化值，移动端的计算结果，如果移动端无计算结果，此属性可不传，为了和报表上传的方式统一
|
||
IsInitValue
|
||
String
|
||
1.是否重取初值,枚举值：1、0（1：代表重取初值，0代表否），
|
||
2.如果传递值为空，则默认为0
|
||
水平位移
|
||
[{“Point”：“”，“PointName”：“”， “CurrentValue”：“”，“CurrentChangeValue”：“”，“IsInitValue”：“”，“X”：“”，“Y”：“”}]
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
Point
|
||
String
|
||
必须项属性，监测点ID
|
||
PointName
|
||
String
|
||
必须项属性，监测点Name
|
||
CurrentValue
|
||
Decimal
|
||
必须项本次观测值，单位（mm）
|
||
CurrentChangeValue
|
||
Decimal
|
||
非必须属性，本次变化值，app的计算结果，如果app无此计算结果，此属性可不传，预留属性（方便和报表上传统一）
|
||
IsInitValue
|
||
String
|
||
1.是否重取初值,枚举值：1、0（1：代表重取初值，0代表否），
|
||
2.如果传递值为空，则默认为0
|
||
X
|
||
Decimal
|
||
水平位移类型的监测数据原始数据，如果app端无，可不传递
|
||
Y
|
||
Decimal
|
||
水平位移类型的监测数据原始数据，如果app端无，可不传递
|
||
备注: CurrentValue是X或Y的值，具体是X还是Y看系统中测点配置的位移方向是X还是Y
|
||
测斜
|
||
[{"Point":"","PointName":"","IsInitValue":"","CxSubData":[{"Depth":,"CurrentValue":,"CurrentChangeValue":，"A0":,"A180":,"FrontCurrentValue":}]}]
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
Point
|
||
String
|
||
必须项属性，监测点ID
|
||
PointName
|
||
String
|
||
必须项属性，监测点Name
|
||
IsInitValue
|
||
String
|
||
1.是否重取初值,枚举值：1、0（1：代表重取初值，0代表否），
|
||
2.如果传递值为空，则默认为0
|
||
CxSubData
|
||
List
|
||
List对象，json数组，格式参见章节2.13.4.1.1
|
||
CxSubData对象
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
Depth
|
||
String
|
||
必须项属性，深度
|
||
CurrentValue
|
||
Decimal
|
||
必须项管形位移量（改正前），单位（mm）
|
||
CurrentChangeValue
|
||
Decimal
|
||
非必须属性，本次变化值，app的计算结果，如果app无此计算结果，此属性可不传，预留属性（方便和报表上传统一）
|
||
A0
|
||
Decimal
|
||
非必须属性，A0
|
||
A180
|
||
Decimal
|
||
非必须属性，A180
|
||
管形位移量（改正后）=当期孔口改正点(系统中测点配置中关联的水平位移点)的累计变化量-管形位移量（改正前）
|
||
支撑轴力
|
||
[{"Point":"","PointName":"", " CurrentValue":"", " CurrentChangeValue ":"",”IsInitValue”:”” " ZLSubData ":[{" SensorNumber":," Frequency":,”InitialFrequency”:,"SingleAxialForce":，"Temperature":,”InitialTemperature”:}]}]
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
Point
|
||
String
|
||
必须项属性，监测点ID
|
||
PointName
|
||
String
|
||
必须项属性，监测点Name
|
||
CurrentValue
|
||
String
|
||
必须项属性，本次轴力（KN)
|
||
CurrentChangeValue
|
||
Decimal
|
||
非必须属性，本次变化值，app的计算结果，如果app无此计算结果，此属性可不传，预留属性（方便和报表上传统一）
|
||
IsInitValue
|
||
String
|
||
1.是否重取初值,枚举值：1、0（1：代表重取初值，0代表否），
|
||
2.如果传递值为空，则默认为0
|
||
ZLSubData
|
||
List
|
||
List对象，json数组，格式参见章节2.13.4.1.1
|
||
ZLSubData对象
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SensorNumber
|
||
String
|
||
必须项属性，传感器编号，（当支撑轴力监测类型为“钢支撑”时最多上传2个传感器的数据，其他监测类型最多上传4个传感器的数据）
|
||
InitialFrequency
|
||
Decimal
|
||
必须项属性，传感器初始频率（Hz）
|
||
Frequency
|
||
Decimal
|
||
必须项属性，本次监测频率（Hz）
|
||
SingleAxialForce
|
||
Decimal
|
||
非必须属性，单个轴力值(kN)
|
||
InitialTemperature
|
||
Decimal
|
||
非必须属性，传感器初始温度(℃)(当支撑轴力监测类型为“钢筋混凝土支撑(混凝土应变计/考虑温度)”或“钢筋混凝土支撑(非混凝土应变计/考虑温度)”时，此参数必填)
|
||
Temperature
|
||
Decimal
|
||
非必须属性，本次监测时温度(℃)(当支撑轴力监测类型为“钢筋混凝土支撑(混凝土应变计/考虑温度)”或“钢筋混凝土支撑(非混凝土应变计/考虑温度)”时，此参数必填)
|
||
地下水位
|
||
[{“Point”：“”，“PointName”：“”， “CurrentValue”：“”，“CurrentChangeValue”：“”，“NozzleDepth”:“”,“NozzleElevation”:“”’,“IsInitValue”：“”}]
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
Point
|
||
String
|
||
必须项属性，监测点ID
|
||
PointName
|
||
String
|
||
必须项属性，监测点Name
|
||
CurrentValue
|
||
Decimal
|
||
必须项属性，本次高程值
|
||
CurrentChangeValue
|
||
Decimal
|
||
非必须属性，本次变化值，移动端的计算结果，如果移动端无计算结果，此属性可不传，为了和报表上传的方式统一
|
||
NozzleDepth
|
||
Decimal
|
||
必须项属性，管口深度(m)
|
||
NozzleElevation
|
||
Decimal
|
||
非必须属性，管口高程(m)
|
||
IsInitValue
|
||
String
|
||
1.是否重取初值,枚举值：1、0（1：代表重取初值，0代表否），
|
||
2.如果传递值为空，则默认为0
|
||
接口返回值格式
|
||
接口调用示例图
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data:null
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :null
|
||
}
|
||
获取基准点
|
||
接口描述
|
||
获取项目基准点信息
|
||
接口请求URL地址
|
||
/OutWebApi/api/ControlPoint?ProjectID=XXX
|
||
接口请求方式
|
||
Get
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头信息，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头信息，调用接口供应商编码，具体说明见章节1.2.2
|
||
ProjectID
|
||
String
|
||
项目ID
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :{ ControlPointList: json格式的列表格式数据，具体属性见章节2.14.6}
|
||
}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”如果需要接口返回数据，则返回数据在此属性中”
|
||
}
|
||
返回值示例
|
||
章节2.14.5中执行成功的返回值（data对象）中的属性ControlPointList
|
||
ControlPointList说明
|
||
属性
|
||
属性名称
|
||
属性说明
|
||
Point
|
||
点名
|
||
PointX
|
||
X值
|
||
PointY
|
||
Y值
|
||
PointZ
|
||
H值
|
||
获取工点数据
|
||
接口描述
|
||
获取工点列表数据
|
||
接口请求URL地址
|
||
接口1：/OutWebApi/api/GetWorkPoint
|
||
接口2：/OutWebApi/api/GetWorkPoint?ProjectID=XXXX
|
||
接口3：/OutWebApi/api/GetWorkPoint?WorkPointID=XXXX
|
||
备注：以上3个接口都支持，实际调用请按以下说明具体选用哪个接口
|
||
第一个接口：如果都不传递，返回所有“进行中”的项目下现场负责人是本人的“进行中”的工点列表数据
|
||
第二个接口：如果ProjectID传递，返回的是某项目下的现场负责人是本人的“进行中”的工点列表数据，如果ProjectID参数传了空值，则跟第一个接口返回的结果一致
|
||
第三个接口：如果WorkPointID传递，返回的是某个现场负责人是本人的“进行中”的工点数据，如果WorkPointID参数传了空值，则跟第一个接口返回的结果一致
|
||
接口请求方式
|
||
GET请求
|
||
接口参数
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头信息，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头信息，调用接口供应商编码，具体说明见章节1.2.2
|
||
Token
|
||
String
|
||
请求头信息，当前用户token
|
||
ProjectID
|
||
String
|
||
非必填项，项目ID
|
||
1.如果项目ID为空，则返回所有“进行中”的项目下现场负责人是本人的“进行中”的工点列表数据
|
||
2.如果项目ID不为空，则返回当前项目下现场负责人是本人的“进行中”的工点列表数据
|
||
WorkPointID
|
||
String
|
||
非必填项，工点ID
|
||
1.如果工点ID为空，返回所有“进行中”的项目下现场负责人是本人的“进行中”的工点列表数据
|
||
2.如果工点ID不为空，则返回“进行中”的项目下某个现场负责人是本人的“进行中”的工点数据
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data :{ WorkPointList: json格式的列表格式数据，具体属性见章节2.15.6}
|
||
}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :”如果需要接口返回数据，则返回数据在此属性中”
|
||
}
|
||
返回值示例
|
||
章节2.15.5中执行成功的返回值（data对象）中的属性WorkPointList说明，如需其他属性双方待确认
|
||
WorkPointList 工点数据
|
||
属性
|
||
属性名称
|
||
参数说明
|
||
ID
|
||
工点ID
|
||
Name
|
||
工点名称
|
||
ProjectID
|
||
项目ID
|
||
ProjectName
|
||
项目全称
|
||
Lon
|
||
经度
|
||
Dim
|
||
纬度
|
||
StartDate
|
||
开工时间
|
||
最低精确到天，格式:yyyy-MM-dd
|
||
EndDate
|
||
结束时间
|
||
最低精确到天，格式:yyyy-MM-dd
|
||
上传水位自动化数据
|
||
接口描述
|
||
上传水位自动化数据
|
||
接口请求URL地址
|
||
/OutWebApi/api/UploadAutomation
|
||
接口请求方式
|
||
Post请求
|
||
接口请求方式
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头参数，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头参数，接口供应商编码，具体说明见章节1.2.2
|
||
Token
|
||
String
|
||
请求头当前用户信息，具体说明见章节1.2.3
|
||
PointID
|
||
multipart/form-data
|
||
必须项 测点ID
|
||
PointName
|
||
multipart/form-data
|
||
必须项 测点名称
|
||
CurrentValue
|
||
multipart/form-data
|
||
必须项 本次观测值
|
||
CurrentChangeValue
|
||
multipart/form-data
|
||
必须项 本次变化
|
||
SLChangeValue
|
||
multipart/form-data
|
||
必须项 变化速率
|
||
LJChangeValue
|
||
multipart/form-data
|
||
必须项 累计变化
|
||
MonitorDate
|
||
multipart/form-data
|
||
必须项 监测时间
|
||
UploadDate
|
||
multipart/form-data
|
||
必须项 上传时间
|
||
接口返回值格式
|
||
接口调用示例图
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data:null
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :null
|
||
}
|
||
根据监测计划获取测点
|
||
接口描述
|
||
根据监测计划获取该监测计划相关的测点信息列表
|
||
接口请求URL地址
|
||
/OutWebApi/api/GetPointsByPlan
|
||
接口请求方式
|
||
Get请求
|
||
接口请求方式
|
||
参数名称
|
||
参数类型
|
||
参数说明
|
||
SecretKey
|
||
String
|
||
请求头参数，调用接口秘钥，具体说明见章节1.2.1
|
||
SystemCode
|
||
String
|
||
请求头参数，接口供应商编码，具体说明见章节1.2.2
|
||
Token
|
||
String
|
||
请求头当前用户信息，具体说明见章节1.2.3
|
||
PlanID
|
||
string
|
||
必须项 监测计划ID
|
||
GroupID
|
||
string
|
||
必须项 测项ID
|
||
WorkPointID
|
||
string
|
||
必须项 工点ID
|
||
接口返回值格式
|
||
接口请求后返回值类型：String，即：以JSON格式返回数据集
|
||
执行成功返回值
|
||
{
|
||
code:“200”,
|
||
msg:“执行成功提示信息”,
|
||
data:{ PointList: json格式的列表格式数据，具体属性见章节2.17.6}
|
||
执行失败返回值
|
||
{
|
||
code:“500”,
|
||
msg:“执行失败提示信息”,
|
||
data :null
|
||
}
|
||
返回值示例
|
||
章节2.17.5中执行成功的返回值（data对象）中的属性PointList说明，如需其他属性，双方待确认
|
||
PointList 所关联监测点
|
||
属性
|
||
属性名称
|
||
属性说明
|
||
ID
|
||
监测点ID
|
||
PointSimpleName
|
||
点名简称
|
||
PointName
|
||
点名
|
||
InitialValueData
|
||
初值列表
|
||
RateAlarm
|
||
速率报警值
|
||
TotalAlarm
|
||
累计报警值
|
||
LastMonitorDate
|
||
上次观值列表
|
||
见2.9.6.2 LastMonitorDate属性说明
|
||
MonitorDate
|
||
上次观测时间
|
||
InitialValueData属性说明
|
||
属性
|
||
属性名称
|
||
属性说明
|
||
Attribute
|
||
属性
|
||
不叫非测斜类型，测斜是孔深值，水准是高程或为空都可以
|
||
InitialValue
|
||
初值
|
||
LastMonitorData属性说明
|
||
属性
|
||
属性名称
|
||
属性说明
|
||
Attribute
|
||
属性
|
||
不叫非测斜类型，测斜是孔深值，水准是高程或为空都可以
|
||
LastMonitorValue
|
||
上次观测值 |