电梯应急救援平台HTTP接口协议要求、数据交换内容

附录A

（规范性附录）

电梯应急救援平台HTTP接口协议要求

1.1接口申报要求

1.1.1接口申报应符合如下要求：

a）接口服务方需提供接口服务器地址及端口；

b）协议格式：接口服务器地址:端口号/平台英文名称/分类英文名称/接口英文名称？

@141±0"22宣。酎授权码，其中分类名称和接口名称详情见1.5节，授权码在访问获

取授权码时获得；

例：http:〃接口服务器地址：端口号/平台英文名称/comm/getDict?authorization=090988778899809

（获取数据字典）

c）用户识别码由安平台名称统一提供，接口对接期间长期有效；

d）接口授权码是针对每个接口服务的，具有时效性限制，系统内限制为30分钟；

e）接口数据模型定义的必填项必须提供；

f）上传数据前应建立校验数据重复性的机制，避免数据重复插入；

g）无特殊说明，接口默认采用HTTPPOST接口方法。

1.2接口日志记录要求

接口调用方、接口提供方均应该对每次调用记录详细的日志，包括路由信息层和业务信

息层的所有详细信息，以及接口调用的通讯情况做记录。日志记录后，可以根据请求唯一标

识查询到详细的日志记录。

1.3接口异常处理要求

捕获

异常

各系统（包括接口调用方、接口提供方）在捕获异常后，异常的处理遵循能处理就处理，

不能处理就封装并向上传递，如果不能传递就告警并人工处理的原则。

当调用接口时，如果因为网络异常等数据传输错误而造成数据未送达对端时，建议接口

调用方进行一定数量的重试。

当调用接口时，如果数据已经送达对端，因为数据本身存在错误而无法处理时，接口被

调用方应该将详细的错误信息返回给接口调用方，并尽量明确的告知数据错误的具体原因。

1.4其他要求

HTTP接口协议版本：HTTP协议版本为1.1及以上。

字符集统一采用UTF-8格式；

接口调用，单次文件包大小应小于30M

1.5协议清单

分类名称英文名称说明

通用应用comm包括获取授权码、数据字典、制造单位、维保/使用/单位、救援/维保

人员、上传文件

电梯管理dtgl包括电梯的基础信息、安装/改造/修理信息、检验记录、使用登记（变

更）/停用/报废/注销信息、运行参数信息

救援管理jygi包括救援记录、救援网格信息

统计管理tjgl电梯的相关统计指标

分类接口名称英文名称说明

通用应用获取授权码接口getTicket获取授权码以访问接口

通用应用获取数据字典getDict获取数据字典，如电梯类别、品种、救援类

型、故障类型等

通用应用获取单位信息getOrglnfo获取电梯使用单位、维保单位、制造单位、

设计单位信息

通用应用获取人员信息getOperators获取电梯维保人员、安全管理人员、检验人

员、网格救援人员、救援客服的信息

通用应用上传文件接口upFile上传电梯证明材料、人员资质材料、单位资

质材料

电梯管理获取电梯基础信息getDtList包括电梯的设备类别、种类、品种、型号、

使用单位、维保单位、使用状态、地址等

获取电梯施工告知信息getDtReport包括历次的电梯安装改造维修告知信息

获取电梯使用登记信息getDtRegister包括电梯历次的使用登记、变更情况

获取电梯检验记录信息getDtChecklnfo包括电梯的监检和定检记录

获取电梯参数信息getDtParameter电梯层站数、运行速度等运行参数信息

上传电梯救援记录upDtSavelnfo电梯历次救援记录

上传电梯救援网格信息upDtRescueGrid电梯网格化信息

统计管理上传电梯累计运行情况upDtWorkinglnfo电梯累计运行次数、时间、故障数

2接口协议内容

2.1通用应用

2.1.1获取授权码接口

2.1.1.1功能说明

本接口用于获取系统授权码。数据服务商通过HTTP的POST接口与电梯应急救援平台

外部接口通信。

2.1.1.2接口地址

http:〃（服务器IP＞:（服务器端口＞/＜系统简称＞/comm/getTicket

2.1.1.3人参

参数名类型可选标识参数描述

userCodeString必选用户识别码

serviceCodeString必选服务编码

示例：

（

data:{

userCode用户识别码1

serviceCode/Servicelz

）

}

2.1.1.4出参

参数名类型可选标识参数描述

dataString必选临时授权码

rtString必选状态对象

状态对象

参数名类型可选标识参数描述

fromSystemString必选数据来源系统

msgString必选状态说明

statusInteger必选状态码

返回报文格式：

（

"data":，临时授权码1

"rt":{

"fromSystem":"系统名称",

"msg":"操作成功"，

"status":200

）

）

2.1.2获取数据字典

2.1.2.1功能说明

本接口用于获取数据字典，如电梯类别、品利;救援类型、故障类型等。数据服务商通

过HTTPPOST接口与电梯应急救援平台外部接口通信。

2.1.2.2接口地址

http:〃〈服务器IP>:（服务器端口>/<系统简称>/comm/getDict?authorization=〈授权码〉

2.1.2.3人参

参数名类型可选标识参数描述

dataJson必选搜索对象

搜索对象

参数名类型可选标识参数描述

typeString非必选字典类型，传入不同的type值获取不

同的数据字典，电梯类别:EQU_TYPE、

电梯品种：EQU_KIND、救援类型：

MT_TYPE：故障类型：FALT_TYPE

示例:

data:{

type/MT_TYPE'

)

)

2.1.2.4出参

参数名类型可选标识参数描述

dataString必选分页对象

rtString必选状态对象

字典类型

名称类型必填？说明备注

idStringY编号

labelStringY标签名

valueStringY数据值

typeStringY类型

descriptionStringY描述

sortIntegerY排序（升序）

parentValueStringY

createByStringY创建者

createDateDateY创建时间

updateByStringY更新者

updateDateDateY更新时间

remarksStringY备注信息

delFlagStringY删除标记

返回报文格式：

(

"data":{

"count":2,

page:1,

"pageSize":1,

"total":1,

"rows":[

(

"createBy":null,

"createDate":"2020-03-1910:01:01”，

"delFlag":"0",

"description":"救援类型“，

"id":"94733412f3a611e8bce530el71537f8d",

"labeln:“一级救援”,

"parentvalue":null,

"remarks":null,

"sort":1,

“type”：HMT_TYPE",

"updateBy":null,

"updateDate":null,

"value":"ln

},

{

"createBy":null,

"createDate":"2020-03-2621:24:03”，

"delFlag":“0"，

"description":"救援类型”，

H

“id”：94733412f3a6112cbce530el71537f8d"z

"label":”二级救援”，

"parentvalue":null,

"remarks":null,

"sort":2,

"type":"MTJTYPE”，

"updateBy**:null,

"updateDate1':null,

"value":n2"

)

],

},

"rt":{

"fromSystem":"平台名称",

"msg":"操作成功"，

"status":200

)

}

2.1.3获取制造单位信息

2.1.3.1功能说明

本接口用于获取电梯的制造单位信息。数据服务商通过HTTPPOST接口与电梯应急救援

平台外部接口通信。

2.1.3.2接口地址

http://＜服务器IP＞:＜服务器端口＞/＜系统简称》/comm/getProducellnit?authorization=＜

授权码〉

2.1.3.3人参

参数名类型可选标识参数描述

dataJson必选搜索对象

搜索对象

参数名类型可选标识参数描述

produceUnitString非必选制造单位名称

示例：

(

data:{

"produceUnit":"合肥迅立达电梯有限公司"

)

)

2.1.3.4出参

参数名类型可选标识参数描述

dataString必选分页对象

rtString必选状态对象

制造单位对象

名称类型必填？说明备注

produceUnitldIntegerY系统ID

produceUnitStringY制造单位名称

produceUnitSimpleStringY制造单位简称

1icenseNoStringY制造单位代号TS2210K25

IicenseNoYearStringY许可证编号（带年TS2210K25-2016

份）

produceUnitCodeStringY单位代码

remarksStringY备注

deleteFlagStringY删除标志，0-未删

除，1-删除

create?imeDateY数据创建时间

lastUpdateTimeDateY最新更新时间，时

间戳

返回报文格式：

(

"data":{

"count":3,

"page":lf

"pageSize":10,

"total":1,

"rows":[

(

"cd":null,

"createDate":null,

"createTime":"2020-04-0319:35:48”，

"delFlag":null,

••deleteFlag":“0"，

"endDate":null,

"id":null,

"lastUpdateTime":"2020-04-0319:35:48.0",

nlastdateprocetype**:null,

n

“licenseNo”：TS2210K25"z

"nameOrCode":null,

"orderBy":null,

"pageNum":1,

uH

pageSize:10z

"produceUnit":"合肥迅立达电梯有限公司”，

n

"produceUnitCode":HTZ"z

"produceUnitld":1,

"produceUnitSimpleH:“华天能源”，

"remarks":"",

"startDate**:null,

"uuidH:null

I

],

},

"rt":{

"fromSystem":"安平台名称",

"msg":"操作成功"，

"status":200

}

）

2.1.4获取单位信息

2.1.4.1功能说明

本接口用于获取使用（物业）单位、维保单位、安装单位信息。数据服务商通过HTTPPOST

接口与电梯应急救援平台外部接口通信。

2.1.4.2接口地址

http:〃〈服务器IP＞:＜服务器端口＞/＜系统简称＞/comm/getUnit?authorization=＜S:tX,^＞

2.1.4.3入参

参数名类型可选标识参数描述

dataJson必选搜索对象

搜索对象

参数名类型可选标识参数描述

unitNatureString非必选单位性质unitNature传入不同值获取

不同的单位列表，cl、使用单位：C2、

维保单位：c3、安装改造修理单位：

示例:

data:{

unitNature：'cl'

)

2.1.4.4出参

参数名类型可选标识参数描述

dataString必选分页对象

rtString必选状态对象

单位对象

名称类型必填？说明备注

unitldIntegerY系统ID

unitOrgCodeStringY单位机构序列编

码

unitOrgldSeqStringY单位机构序列

id

unitNameStringY单位名称

unitSimpleNameStringY单位简称

propertyUnitSocialCodeStringY统一社会信用代

码

unitPhoneStringY单位联系电话

unitLegalStaffStringY法定代表人

unitLegalPhoneStringY联系人联系电话

unitContactStaffStringY单位联系人

certNoStringY充装单位使用登

记证号

unitLocationStringY单位地址

1ngLatStringY

longitudeDoubleY经度

latitudeDoubleY纬度

unitStatusStringY单位状态

unitNatureStringY单位性质

createldStringY创建记录的账号

ID

orgCodeStringY数据所属机构序

列编码

orgldSeqStringY数据所属机构序

列id

createTimeDateY数据创建时间

deleteFlagStringY删除标志，0-未

删除，1-删除

updateldStringY修改记录的账号

ID

lastUpdateTimeDateY最新更新时间，

时间戳

dataFromStringY数据来源，O-PC

端批量导入，

1-PC端人工录

入，2-移动端人

工录入，3-系统

接口

返回报文格式:

"data":{

"count":3,

"page":1,

"pageSize":10,

"total":1,

"rows":[

"cd":null,

"certNo'1:null,

"createDate":null,

"createldn:”wg”,

"createTime":"2020-04-2300:00:00”，

"dataFrom,1:”2"，

"delFlag":null,

"deleteFlag'1:“0"，

"endDate":null,

"filelds":null,

"files":null,

“id”：null,

"IngLat":n118.332971,31.341414",

"lastUpdateTime":"2020-05-0510:51:56.0",

"lastdateprocetypen:null,

"latitude**:31.385422,

"longitude11:118.303755,

"num":null,

"orderBy":null,

"orgCode":,,340000u45,\

n

"orgldSeq":"0.1.u45.z

•'pageNum*':1r

"pageSize":10,

"propertyUnitSocialCode":"674853475637P”，

"quallds":null,

Hqualsn:null,

"startDaten:null,

"unitContactStaffH:“李四”，

"unitld":45,

"unitLegalPhone":，

"unitLegalStaff":“张三”，

“unitLocation”：”安徽省芜湖市东紫园物业管理公司”,

"unitName":"测试检验机构1",

"unitNature'1:"j4,j5,j6”，

n

"unitOrgCode":"340000u45z

"unitOrgIdSeqH:”0.1.u45.”，

"unitPhone11:，

"unitSimpleName":nCSJYIu,

"unitstatus":"0",

"updateldn:”wg”，

"uuid":null

}

],

},

"rt":{

"fromSystem":"安平台名称",

"msg":"操作成功"，

"status":200

)

)

2.1.5获取人员信息

2.1.5.1功能说明

本接口用于获取物业管理人员、维保单位人员、救援人员及检验人员的信息。数据服务

商通过HTTPPOST接口与电梯应急救援平台外部接口通信。

2.1.5.2接口地址

http:〃〈服务器IP>:<服务器端口>/〈系统简称〉/comm/getOperators?authorization=<^

权码〉

2.1.5.3人参

参数名类型可选标识参数描述

dataJson必选搜索对象

搜索对象

参数名类型可选标识参数描述

stationNameString非必选岗位名称stationName传入不同值获

取不同岗位的人员列表，法人：ml,

应急救援人员：m2,维保单位人员：

m3,救援人员：m4,检验人员

示例：

(

data:{

stationName/mr

)

)

2.1.5.4出参

参数名类型可选标识参数描述

dataString必选分页对象

rtString必选状态对象

人员对象

名称类型必填？说明备注

staffldIntegerY系统ID

photoPathStringY照片位置

staffNameStringY人员姓名

idCardNoStringY身份证号

ageIntegerY年龄

genderStringY性别

phoneNumberStringY手机电话号码

jobNumberStringY工号

unitBelongToStringY所属单位

propertyUnitSocialCodeStringY所属单位统一社

会信用代码

stationNameStringY岗位名称

onStationStatusStringY在职状态

checklnDateDateY入职时间

workingYearsStringY工龄，工作年限

jobDescriptionStringY岗位说明

educationLevelStringY学历

graduateSchoolStringY毕业院校

majorNameStringY专业名称

graduateDateDateY毕业时间

isOperationStaffStringY是否为作业人员

certificateClassStringY证书种类

certificateTypeStringY证书类型

certificateGetDateDateY证书取得时间

certificateEffeetiveDateDateY证书有效期

createldStringY创建记录的账号

ID

orgCodeStringY数据所属机构序

列编码

orgldSeqStringY数据所属机构序

列id

createTimeDateY数据创建时间

deleteFlagStringY删除标志，0-未

删除，1-删除

updateldStringY修改记录的账号

ID

lastUpdateTimeDateY最新更新时间，

时间戳

dataFromStringY数据来源，0-PC

端批量导入，

1-PC端人工录

入，2-移动端人

工录入，3-系统

接口

返回报文格式:

"data":{

"count":3,

"page":1,

"pageSize":10,

"total":1,

"rows":[

"age":25,

“cd”：null,

"certClassn:null,

"certType":null,

"certificateClass":null,

,'certificateEffectiveDate":null,

"certificateGetDate":null,

"certificateType":null,

"checklnDate":"2020-03-1000:00:00",

"createDate":null,

,,createldn:"whtest",

"createTime":"2020-03-0600:00:00”,

"dataFrom**:null,

"delFlag":null,

"deleteFlag":“0"，

"educationLevel":"F",

"endDate":null,

"filelds":null,

"files":null,

"gender11:“男“，

"graduateDate":"2020-03-1000:00:00”，

"graduateSchool":"安徽财经大学”，

"id":null,

"idCarciNon:"34112619950916103x",

"isOperationStaffn:null,

"jobDescription**:“敲代码”，

"jobNumbern:"23455”,

"lastUpdateTime":"2020-05-1115:19:14.0”，

"lastdateprocetype":null,

"majorName":"计算机科学与技术”，

"onStationStatus":“0"，

"orderBy":null,

"orgCode":"34020202",

"orgIdSeqH:”53.”，

"orgldSeqSearch":null,

•'pageNum":1z

"pageSize":10,

"phoneNumber":，

"photoPath":"file/whfile/202005/20200511152416655821703.png",

"propertyUnitSocialCode":“232”，

"quallds":null,

"qualsn:null,

"staffId":1,

"staffNamen:“王耿"，

"startDate":null,

"stationName":"m4,ml,m2,m3,m5,m6”，

"unitBelongTo'1:"智慧BU",

n

"updateld:"wg"z

"uuid":null,

"workingYearsH:"1"

)

],

},

"rt":{

"fromSystem":"安平台名称"，

"msg":"操作成功"，

"status":200

2.1.6上传文件接口

2.1.6.1功能说明

本接口用于上传电梯证明材料、人员资质材料、维保单位资质材料。数据服务商通过

HTTPPOST接口与电梯应急救援平台外部接口通信。

2.1.6.2接口地址

http:〃（服务器IP＞:＜服务器端口＞/＜系统简称）/comm/upFile?authorization=＜授权码〉

2.1.6.3人参

参数名类型可选标识参数描述

dataJson必选文件对象数组

示例：

(

data:[

]

2.1.6.4出参

参数名类型可选标识参数描述

dataString必选插入成功数量

名称类型必填？说明备注

rtString必选状态对象

文件对象

fileldLongY附件主键

fileNameStringY文件名

absolutepathStringY文件路径

fileSizeLongY文件大小（字节）

fileTypeStringY文件类型

staffIdStringY上传人

staffNameStringY上传人姓名

fileTimeDateY上传时间

groupCodeStringY所属分组（task一任务

单，equipment--设

备，record一记

录,notice--公

告，noticebill一告知单，

appNo一申报单）

relationldStringY关联主键

downloadTimesLongY下载次数

isDelIntegerY是否删除（1：已删除，0：

未删除）

optFileTypeIntegerY文件操作类型一对比

stj_equ_applymaterial

表格

remarkStringY备注信息

systemTypeStringY系统类别

返回报文格式:

"data":[

absolutepath:n23:80/files/file/whfile/202005/2

0200521164710767741553.txt"

childList:null

downloadTimes:0

fileId:3620

fileName:“0519执行操作.txt"

fileSize:2064

fileTime:"2020-05-2116:47:10”

fileType:ntext/plainM

groupCode:null

groupCodeNew:null

isDel:null

optFileType:null

relationld:null

relation工dNew:null

remark:null

staffId:Hwg"

staffName:“王耿"

systemType:"SUPERVISION**

)

],

"rt":{

“fromSystem":“安平台名称"，

"msg":"操作成功，

"status":200

)

}

2.2电梯管理

2.2.1获取电梯基础信息

2.2.1.1功能说明

本接口用于获取电梯档案数据。数据服务商通过HTTPPOST接口与电梯应急救援平台外

部接口通信。

2.2.1.2接口地址

http:〃＜服务器IP＞:＜服务器端口＞/＜系统简称＞/dtgl/getDtList?authorization=＜授权码＞

2.2.1.3人参

参数名类型可选标识参数描述

dataJson必选搜索对象

搜索对象

参数名类型可选标识参数描述

equdatasysidString非必选设备系统内ID

equcardnoString非必选电梯标识牌号码

equcodeString非必选设备代码

equregcodeString非必选设备注册代码

pronoString非必选产品编号（出厂编号）

usecarnoString非必选使用证编号

equlocarecodeString非必选设备所在地区（县）字段编码

mtorgnameString非必选维保单位名称

useorgnameString非必选使用单位名称

porgaonameString非必选制造单位名称

buiorgnameString非必选安装单位名称

示例:

data:{

equdatasysid:设备系统内ID,

equcardno:电梯标识牌号码，

equcode:设备代码，

equregcode:设备注册代码，

prono:产品编号（出厂编号），

usecarno:使用证编号，

equlocarecode:设备所在地区（县）字段编码,

mtorgname:维保单位名称，

useorgname:使用单位名称，

porgaoname:制造单位名称，

buiorgname:安装单位名称

）

}

2.2,1.4出参

参数名类型可选标识参数描述

dataString必选分页对象

rtString必选状态对象

电梯基础信息对象

名称类型必填？说明备注

equdatasysidStringY设备系统内ID

oidnoStringY电梯唯•识别码

equcardnoStringY电梯标识牌号码

equcodeString