ISAPI 接口指引

5.1 设备通用

5.1.1 时间管理

5.1.1.1 获取设备校时管理参数

Request URL

GET /ISAPI/System/time

响应报文

<?xml version="1.0" encoding="UTF-8"?>

<Time xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<!--ro, opt, object, 时间管理, attr:version{opt, string, 协议版本}-->

<timeMode>

<!--ro, req, enum, 校时方式, subType:string, [NTP#NTP校时,manual#手动校

时,satellite#卫星校时,platform#平台校时,NONE#不允校时或无校时源,GB28181#GB28181校

时,PTP#PTP校时]-->NTP

</timeMode>

<localTime>

<!--ro, opt, string, 本地时间, range:[0,256], dep:and,

{$.Time.timeMode,eq,manual}-->2019-02-28T10:50:44+08:30

</localTime>

<timeZone>

<!--ro, opt, string, 时区, range:[0,256], dep:and,

{$.Time.timeMode,eq,manual},{$.Time.timeMode,eq,NTP}, desc:夏令在时区中配置。不开启

夏令时示例CST-8:00:00,其中CST为时区名称,-8:00:00为(UTC时间-本地时间),大于等于0:00:00时

可以省略+号。开启夏令时示例CST-8:00:00DST00:30:00,M4.1.0/02:00:00,M10.5.0/02:00:00,

其中DST为夏令时名称,00:30:00表示开启夏令时后本地时间提早的时间,M4.1.0/02:00:00表示从4月第

一个星期日2:00:00开始进入夏令时,M10.5.0/02:00:00表示到10月第5个星期日2:00:00结束夏令时。

是否支持夏令时能力:/ISAPI/System/capabilities中的isSupportDst-->CST-

8:00:00DST00:30:00,M4.1.0/02:00:00,M10.5.0/02:00:00

</timeZone>

<isSummerTime>

<!--ro, opt, bool, 当前设备返回时间是否为夏令时, desc:isSummerTime是false或者没有这

个节点,表示未进入夏令时,且isSummerTime是只读字段,仅在GET中有效。-->true

</isSummerTime>

</Time>

 

5.1.2 系统维护

5.1.2.1 获取设备系统能力

Request URL

GET /ISAPI/System/capabilities

响应报文

<?xml version="1.0" encoding="UTF-8"?>

<DeviceCap xmlns="http://www.isapi.org/ver20/XMLSchema" version="2.0">

<!--ro, req, object, 设备系统能力, attr:version{opt, string, 版本信息}-->

<isSupportReboot>

<!--ro, opt, bool, 是否支持重启, desc:交通产线必填且为true-->true

</isSupportReboot>

<isSupportDeviceInfo>

<!--ro, opt, bool, 是否支持获取设备信息, desc:交通产线必填且为true-->true

</isSupportDeviceInfo>

<isSupportTime>

<!--ro, opt, bool, 表示是否支持时间配置, desc:交通产线必填且为true,其他产线使用的是

isSupportTimeCap-->true

</isSupportTime>

<SysCap>

<!--ro, opt, object, 系统能力-->

<isSupportDst>

<!--ro, opt, bool, 是否支持夏令时-->true

</isSupportDst>

<NetworkCap>

<!--ro, opt, object, 网络能力, desc:接口:/ISAPI/System/Network/capabilities-

->

<isSupportWireless>

<!--ro, req, bool, 是否支持无线网-->true

</isSupportWireless>

<isSupportWired>

<!--ro, opt, bool, 是否支持有线网-->true

</isSupportWired>

<isSupportWAN>

<!--ro, opt, bool, 是否支持广域网-->true

</isSupportWAN>

<isSupportPPPoE>

<!--ro, req, bool, 是否支持以太网点对点协议-->true

</isSupportPPPoE>

<isSupportBond>

<!--ro, req, bool, 是否支持网卡绑定-->true

</isSupportBond>

<isSupport802_1x>

<!--ro, req, bool, 是否支持802.1x协议-->true

</isSupport802_1x>

<isSupportDdns>

<!--ro, opt, bool, 是否支持动态域名服务-->true

</isSupportDdns>

<isSupportSSH>

<!--ro, opt, bool, 是否支持SSH-->true

</isSupportSSH>

</NetworkCap>

<isSupportTimeCap>

<!--ro, opt, bool, 是否支持时间配置, desc:接

口:/ISAPI/System/time/capabilities-->true

</isSupportTimeCap>

<DeployCap>

<!--ro, opt, object, 布防非订阅参数能力-->

<deployID opt="1,2">

<!--ro, opt, enum, 布防类型, subType:int, [0#客户端布防,1#实时布防],

attr:opt{req, string, 取值范围}-->0

</deployID>

</DeployCap>

</DeviceCap>

 

5.2 激光传感应用

5.2.1 光纤基本信息管理

5.2.1.1 获取光纤总能力

Request URL

GET /ISAPI/OpticalFiber/capabilities?format=json

响应报文

{

"OpticalFiberCap": {

/*ro, req, object, 光纤总能力*/

"isSupportBasicInfo": true,

/*ro, opt, bool, 是否支持光纤基本信息, desc:支持时返回true,不支持返回false或不

返回该字段,对应URL:/ISAPI/OpticalFiber/basicInfo?format=json*/

"isSupportAlarmStorageStrategy": true,

/*ro, opt, bool, 是否支持光纤报警存储策略管理, desc:支持时返回true,不支持返回

false或不返回该字段,对应URL:/ISAPI/OpticalFiber/alarmStorageStrategy*/

"isSupportUnit": true,

/*ro, opt, bool, 是否支持光纤单元管理, desc:支持时返回true,不支持返回false或不

返回该字段,对应URL:/ISAPI/OpticalFiber/unit*/

"isSupportAlarm": true,

/*ro, opt, bool, 是否支持光纤报警, desc:支持时返回true,不支持返回false或不返回

该字段,对应URL:/ISAPI/OpticalFiber/alarm*/

"isSupportOpticalFiberBasicInfoList": true,

/*ro, opt, bool, 是否支持光纤基本信息列表, desc:GET/PUT

/ISAPI/OpticalFiber/OpticalFiberBasicInfoList?format=json*/

"isSupportSearchOpticalFiberUnit": true,

/*ro, opt, bool, 是否支持查询光纤单元信息, desc:POST

/ISAPI/OpticalFiber/SearchOpticalFiberUnit?format=json*/

"isSupportModifyOpticalFiberUnit": true,

/*ro, opt, bool, 是否支持修改光纤单元信息, desc:POST

/ISAPI/OpticalFiber/ModifyOpticalFiberUnit?format=json*/

"isSupportModifyOpticalFiberUnitSensitivity": true,

/*ro, opt, bool, 是否支持修改光纤单元灵敏度, desc:POST

/ISAPI/OpticalFiber/ModifyOpticalFiberUnitSensitivity?format=json*/

"isSupportDeleteOpticalFiberZoneList": true,

/*ro, opt, bool, 是否支持批量删除光纤防区, desc:POST

/ISAPI/OpticalFiber/DeleteOpticalFiberZoneList?format=json*/

"isSupportModifyOpticalFiberZoneList": true,

/*ro, opt, bool, 是否支持批量修改光纤防区, desc:POST

/ISAPI/OpticalFiber/ModifyOpticalFiberZoneList?format=json*/

"isSupportAddOpticalFiberZoneList": true,

/*ro, opt, bool, 是否支持批量添加光纤防区, desc:POST

/ISAPI/OpticalFiber/AddOpticalFiberZoneList?format=json*/

"isSupportSearchOpticalFiberZone": true,

/*ro, opt, bool, 是否支持查询光纤防区, desc:POST

/ISAPI/OpticalFiber/SearchOpticalFiberZone?format=json*/

"isSupportGetRasterlist": true,

/*ro, opt, bool, 是否支持查询光栅信息, desc:POST

/ISAPI/OpticalFiber/GetRasterlist?format=json*/

"isSupportDeleteSensorList": true,

/*ro, opt, bool, 是否支持批量删除传感器, desc:POST

/ISAPI/OpticalFiber/DeleteSensorList?format=json*/

"isSupportDeleteSensor": true,

/*ro, opt, bool, 是否支持删除传感器, desc:POST

/ISAPI/OpticalFiber/DeleteSensor?format=json*/

"isSupportSearchSensor": true,

/*ro, opt, bool, 是否支持查询传感器, desc:POST

/ISAPI/OpticalFiber/SearchSensor?format=json*/

"isSupportModifySensorList": true,

/*ro, opt, bool, 是否支持批量修改传感器, desc:POST

/ISAPI/OpticalFiber/ModifySensorList?format=json*/

"isSupportModifySensor": true,

/*ro, opt, bool, 是否支持修改传感器, desc:POST

/ISAPI/OpticalFiber/ModifySensor?format=json*/

"isSupportAddSensorList": true,

/*ro, opt, bool, 是否支持批量添加传感器, desc:POST

/ISAPI/OpticalFiber/AddSensorList?format=json*/

"isSupportAddSensor": true,

/*ro, opt, bool, 是否支持添加传感器, desc:POST

/ISAPI/OpticalFiber/AddSensor?format=json*/

"isSupportRasterDataStorageRuleParams": true,

/*ro, opt, bool, 是否支持光栅数据存储规则参数, desc:GET/PUT

/ISAPI/OpticalFiber/RasterDataStorageRuleParams?format=json*/

"isSupportSendDemodulateCommand": true,

/*ro, opt, bool, 是否支持下发解调命令, desc:POST

/ISAPI/OpticalFiber/SendDemodulateCommand?format=json*/

"isSupportGetSensorData": true,

/*ro, opt, bool, 是否支持查询传感器数据, desc:POST

/ISAPI/OpticalFiber/GetSensorData?format=json*/

"isSupportGetRasterWavelength": true,

/*ro, opt, bool, 是否支持获取指定光栅波长, desc:POST

/ISAPI/OpticalFiber/GetRasterWavelength?format=json*/

"isSupportModifyRasterList": true,

/*ro, opt, bool, 是否支持批量修改光栅, desc:POST

/ISAPI/OpticalFiber/ModifyRasterList?format=json*/

"isSupportModifyRaster": true,

/*ro, opt, bool, 是否支持修改光栅, desc:POST

/ISAPI/OpticalFiber/ModifyRaster?format=json*/

"isSupportSearchOpticalFiberDetectionStatus": true,

/*ro, opt, bool, 是否支持查询光纤检测状态, desc:POST

/ISAPI/OpticalFiber/SearchOpticalFiberDetectionStatus?format=json*/

"isSupportGetSpectrumData": true,

/*ro, opt, bool, 是否支持获取光谱数据, desc:GET

/ISAPI/OpticalFiber/GetSpectrumData?format=json*/

"isSupportDeleteRasterList": true,

/*ro, opt, bool, 是否支持批量删除光栅, desc:POST

/ISAPI/OpticalFiber/DeleteRasterList?format=json*/

"isSupportAddRaster": true,

/*ro, opt, bool, 是否支持添加光栅, desc:POST /ISAPI/OpticalFiber/AddRaster?

format=json*/

"isSupportGetRasterRealTimeWaveLength": true,

/*ro, opt, bool, 是否支持获取所有光栅实时波长, desc:GET

/ISAPI/OpticalFiber/GetRasterRealTimeWaveLength?format=json*/

"isSupportSearchSpectrumData": true,

/*ro, opt, bool, 是否支持查询光谱数据, desc:POST

/ISAPI/OpticalFiber/SearchSpectrumData?format=json*/

"isSupportExportSingleRasterSensorFile": true,

/*ro, opt, bool, 是否支持导出单个光栅传感器文件, desc:POST

/ISAPI/OpticalFiber/ExportSingleRasterSensorFile?format=json*/

"isSupportSearchRasterSensorFile": true,

/*ro, opt, bool, 是否支持查询光栅传感器文件, desc:POST

/ISAPI/OpticalFiber/SearchRasterSensorFile?format=json*/

"isSupportSearchOpticalFiberZoneAudioInfo": true,

/*ro, opt, bool, 是否支持查询光纤防区关联音频通道信息, desc:POST

/ISAPI/OpticalFiber/SearchOpticalFiberZoneAudioInfo?format=json*/

"isSupportModifyMalfunctionLevel": true,

/*ro, opt, bool, 是否支持修改故障等级, desc:POST

/ISAPI/OpticalFiber/ModifyMalfunctionLevel?format=json*/

"isSupportAddMalfunctionLevel": true,

/*ro, opt, bool, 是否支持添加故障等级, desc:POST

/ISAPI/OpticalFiber/AddMalfunctionLevel?format=json*/

"isSupportHandleOpticalFiberThermalAlarm": true,

/*ro, opt, bool, 是否支持处理测温光纤报警, desc:POST

/ISAPI/OpticalFiber/HandleOpticalFiberThermalAlarm?format=json*/

"isSupportExportDeviceFunctionPluginFile": true,

/*ro, opt, bool, 是否支持导出设备功能插件文件, desc:POST

/ISAPI/OpticalFiber/ExportDeviceFunctionPluginFile?format=json*/

"isSupportGetDeviceFunctionPluginInfo": true,

/*ro, opt, bool, 是否支持获取设备功能插件信息, desc:GET

/ISAPI/OpticalFiber/GetDeviceFunctionPluginInfo?format=json*/

"isSupportDeleteOpticalFiberUnitList": true,

/*ro, opt, bool, 是否支持批量删除光纤单元, desc:POST

/ISAPI/OpticalFiber/DeleteOpticalFiberUnitList?format=json*/

"isSupportDeleteOpticalFiberUnit": true,

/*ro, opt, bool, 是否支持删除光纤单元, desc:POST

/ISAPI/OpticalFiber/DeleteOpticalFiberUnit?format=json*/

"isSupportAddOpticalFiberUnit": true,

/*ro, opt, bool, 是否支持添加光纤单元, desc:POST

/ISAPI/OpticalFiber/AddOpticalFiberUnit?format=json*/

"isSupportModifyOpticalFiberUnitList": true,

/*ro, opt, bool, 是否支持批量修改光纤单元信息, desc:POST

/ISAPI/OpticalFiber/ModifyOpticalFiberUnitList?format=json*/

"isSupportGetOpticalFiberUnitSensitivityList": true,

/*ro, opt, bool, 是否支持获取所有光纤单元灵敏度, desc:GET

/ISAPI/OpticalFiber/GetOpticalFiberUnitSensitivityList?format=json*/

"isSupportSearchOpticalFiberUnitSensitivity": true,

/*ro, opt, bool, 是否支持查询光纤单元灵敏度, desc:POST

/ISAPI/OpticalFiber/SearchOpticalFiberUnitSensitivity?format=json*/

"isSupportGetOpticalFiberUnitSensitivity": true,

/*ro, opt, bool, 是否支持获取振动光纤单元灵敏度, desc:POST

/ISAPI/OpticalFiber/GetOpticalFiberUnitSensitivity?format=json*/

"isSupportMalfunctionLevel": true,

/*ro, opt, bool, 是否支持故障等级, desc:GET/PUT

/ISAPI/OpticalFiber/MalfunctionLevel?format=json*/

"isSupportModelMalfunctionLevel": true,

/*ro, opt, bool, 是否支持听诊模型故障等级参数, desc:GET/PUT

/ISAPI/OpticalFiber/ModelMalfunctionLevel?format=json*/

"isSupportSwitchOpticalFiberChannel": true,

/*ro, opt, bool, 是否支持切换光纤通道, desc:POST

/ISAPI/OpticalFiber/SwitchOpticalFiberChannel?format=json*/

"isSupportSensorRealTimeDataSubscribe": true,

/*ro, opt, bool, 是否支持传感器实时数据订阅, desc:GET/PUT

/ISAPI/OpticalFiber/SensorRealTimeDataSubscribe?format=json*/

"isSupportSearchOpticalFiberUnitAudioInfo": true,

/*ro, opt, bool, 是否支持查询光纤单元关联音频通道信息, desc:POST

/ISAPI/OpticalFiber/SearchOpticalFiberUnitAudioInfo?format=json*/

"isSupportGetDeviceFunctionPluginIcon": true,

/*ro, opt, bool, 是否支持获取设备功能插件图标文件, desc:GET

/ISAPI/OpticalFiber/GetDeviceFunctionPluginIcon?format=json*/

"isSupportGetAsyncDeleteSensorStatus": true

/*ro, opt, bool, 是否支持获取异步批量删除传感器状态, desc:POST

/ISAPI/OpticalFiber/GetAsyncDeleteSensorStatus?format=json*/

}

}


……

申请完整协议文件
如需要完整协议开发文档,请填写以下申请信息,我们会在收到信息的一周内与您联系并提供完整内容
联系我们
售后服务
close
qrCode
微信小程序
扫码登录微信小程序,可轻松查阅海量资料与视频