火警系統介面文件

2021-10-01 12:12:19 字數 4024 閱讀 3820

1、 使用者登入介面

介面功能

使用者登入,token資訊寫入該請求response的cookie中

url
/login/do_login

http請求方式
post

請求引數

引數必選

型別說明

username

必選string

使用者名稱password

必選string

密碼返回字段

欄位名稱

字段型別

說明code

int狀態碼: (2000, 成功), (4001, 使用者資訊不存在),(4002,使用者名稱不存在),(4003,使用者密碼錯誤)

message

string

若狀態碼2000, 則為token;否則,為錯誤提示資訊

介面示例

2、使用者退出介面

介面功能

使用者退出登入狀態

url
/logout/do_logout

http請求方式
post

請求引數

引數必選

型別說明

返回字段

欄位名稱

字段型別

說明code

int狀態碼: (2000, 成功)

message

string

使用者成功退出登入…

介面示例

3、系統主介面

介面功能

地圖資訊介面展示

url
/main

http請求方式
post

請求引數

引數必選

型別說明

now可選

int時間戳,以秒為單位的時間戳

返回字段:list《unitinfo》

class :unitinfo欄位說明

欄位名稱

字段型別

說明unitname

string

單位名稱

presettimealarmcount

int過去預設時間段內的報警數量

presettimehiddencount

int過去預設時間段內的隱患數量

status

int單位的火警等級,暫定:0,1,2,3

location

location

該單位的經緯度資訊

alarmlogs

list《alarmlo**o》

該單位最新的五條報警記錄

hiddenlogs

list《hiddenlo**o》

該單位最新的五條隱患記錄

class:location欄位說明

欄位名稱

字段型別

說明lng

double

經度lat

double

緯度class: alarmlo**o欄位說明

欄位名稱

字段型別

說明buildingname

string

探測器名稱

unit

string

單位名稱

alarmtime

int報警時間,以秒為單位的時間戳

result

string

現場確認結果

classifyresult

string

模型的識別結果

class: hiddenlo**o欄位說明

欄位名稱

字段型別

說明devicename

string

探測器名稱

unit

string

單位名稱

alarmtime

int報警時間,以秒為單位的時間戳

failtype

string

故障型別

alarmfrequency

int報警次數

confirmresult

string

確認結果

resetstatus

string

復位狀態

resettime

int復位時間

classifyresult

string

模型的識別結果

介面示例

[,,

,,],

"hiddenlogs":[

],"location":,

"presettimealarmcount":0

,"presettimehiddencount":1

,"status":0

,"unitname"

:"江山萬隆度假村"},

...,

]

4、報警日誌

介面功能

報警日誌的查詢介面

url
/queryalarmlog

http請求方式
post

請求引數

引數必選

型別說明

curpage

非必選int

當前頁數

pagesize

非必選int

頁大小返回字段: class《queryalarmlo**o》

欄位名稱

字段型別

說明curpage

int當前頁數

pagesize

int頁大小

pagenum

int當前分頁方式下的總頁數

alarmlo**os

list《alarmlo**o》

當前頁的報警日誌,alarmlo**o說明詳見介面3

介面示例

,,

,,,,

,,,,

,,,,

,,,,

,,,,

,,,,

,,,]

,"curpage":1

,"pagenum"

:317

,"pagesize":30

}

5、隱患日誌

介面功能

報警日誌的查詢介面

url
/queryhiddenlog

http請求方式
post

請求引數

引數必選

型別說明

curpage

非必選int

當前頁數

pagesize

非必選int

頁大小返回字段: class《queryhiddenlo**o》

欄位名稱

字段型別

說明curpage

int當前頁數

pagesize

int頁大小

pagenum

int當前分頁方式下的總頁數

alarmlo**os

list《hiddenlo**o》

當前頁的報警日誌,hiddenlo**o說明詳見介面3

介面示例

,,

,,,,

,,,]

,"pagenum"

:65546

,"pagesize":10

}

yapi 介面文件 介面文件神器YApi

阿八個人部落格 1190000020220258 什麼是yapi github 官網上是這麼介紹的 yapi 是乙個可本地部署的 打通前後端及qa的 視覺化的介面管理平台 可以這麼說yapi兼具swagger,rap2,postman的各項優點why yapi 如果你想要乙個好用的介面管理平台,那麼...

Android 介面文件

前言 一 設定描述 設計描述,主要是介紹專案介面文件的業務及主要功能介紹,有互動方式 json資料互動格式 命名規則等做細分講解。1 介面的呼叫方式 移動端通過webservice和其他通用的請求方式,呼叫伺服器介面,返回json資料。2 json的結構 請求失敗示例 請求成功示例 字段解析 sta...

介面文件格式

幻寵大陸 專案協議文件 協議格式說明 遊戲系統中協議是由兩部分組成 協議頭 協議體。其中協議頭的資料長度為固定。如下顯示 客戶端傳送的訊息格式 字段意義 字段型別 說明訊息長度 int描述協議體的長度,包括當前 訊息頭short 協議 id 訊息回執碼 short 壓縮或加密的標識,或者是回執碼 訊...