Car-eye 車輛管理系統API設計
Car-eye 決定重新根據JT1078 JT808 構建新的車輛管理平臺，並將音視訊和語音對講增加到系統中。經過將近半個月的設計，我們基本確定了主要的API介面，現分享如下：
API介面文件
|
作者： |
日期： |
2018-01-31 |
|
審批： |
日期： |
變更記錄：
|
日期 |
版本 |
變更說明 |
作者 |
|
2018/1/31 |
1.0．0 |
建立，釋出 |
目錄
描述中API介面詳細說明，細化每一個功能詳細業務流程為後續開發提供一個詳細的參考。
本文件提供給開發人員及專案相關人員參考閱讀。
所有api介面引數都採用UTF-8格式進行編碼
|
序號 |
術語 |
詳細描述 |
|
1 |
||
|
2 |
|
序號 |
文件名稱 |
發表單位 |
|
1 |
||
|
2 |
URL:http:// 39.108.246.45:801/ api/API_Common_login.action?
|
引數名 |
引數型別 |
是否必需 |
預設值 |
描述 |
|
account |
string |
是 |
無 |
登入賬號 |
|
password |
string |
是 |
無 |
登陸密碼 |
http://39.108.246.45:801/api/API_Common_login.action?account=admin& password=admin
返回結果:
{ "result": 0 }
URL:http://39.108.246.45:801/api/API_Common_GetAllDevices.action? user=admin
使用者只能查出自己歸屬的組織的下屬組織的車輛，裝置和子組織。
|
引數名 |
引數型別 |
是否必需 |
預設值 |
描述 |
|
user |
string |
是 |
無 |
使用者名稱 |
返回引數
A
|
引數名 |
引數型別 |
描述 |
|
Total |
number |
節點個數 |
List：
|
引數名 |
引數型別 |
描述 |
|
NodeID |
Number |
節點ID.如果是組織，那麼這個對應組織ID，如果是 車輛是車輛編號，如果是裝置則為空 |
|
Nodetype |
Number |
節點型別: 1組織 2 車輛 3 裝置 |
|
DeviceID |
String |
裝置號碼，不是裝置為空 |
|
Name |
String |
節點名稱，組織名稱，車牌號或者裝置名稱 |
|
FatherID |
Number |
父親節點ID,跟節點填寫0 |
{
"result": 0,
“total”：1000,
"List"：[
{
"NodeID":”010011122”,
"Nodetype"：1,
"Name"：”深圳計程車總公司”,
FatherID:0,
},
{
"NodeID":”010011121”,
"Nodetype"：1,
"Name"：”寶安計程車分公司”,
FatherID: 010011122
},
{
"NodeID":9100000,
"Nodetype"：1,
"Name"：”寶安計程車分公司”,
"FatherID": 010011122
},
{
"NodeID":44444444,
"Nodetype"：2,
"Name"：”粵B123456”,
FatherID: 9100000
},
{
"NodeID":
"Nodetype"：3,
"Name"：”行車記錄儀”,
"DeviceID"：”44545CSDSD”,
"FatherID: 44444444
},
]
}
URL:http://39.108.246.45:801/api/API_Common_GetDeviceInfo.action? Id=13510671870
返回引數
車輛資訊
|
引數名 |
引數型別 |
描述 |
|
id |
number |
車輛編號 |
|
cn |
string |
車牌號 |
|
Ic |
Number |
車輛圖示 |
|
col |
Number |
車顏色 |
|
pid |
number |
所屬公司或者車隊 |
|
list |
Array |
裝置列表以下是裝置資訊 |
|
id |
string |
裝置號 |
|
pid |
number |
裝置所屬公司 |
|
ic |
number |
IO數目 |
|
io |
string |
IO名稱以','分隔 |
|
cc |
number |
通道數目 |
|
cn |
string |
通道名稱以','分隔 |
|
sim |
string |
SIM卡號 |
|
vt |
string |
車輛型別：1:校車 2：警車 3：排程車 |
b.組織資訊
|
引數名 |
引數型別 |
描述 |
|
id |
number |
組織ID |
|
nm |
string |
組織名稱 |
|
pid |
number |
上級組織ID |
參考輸出
{
"result": 0,
“device”:[
{
“id”： 18668171282,
“cn”: “粵B123456”,
“Ic”: 1,
“col”:2,
“pid”:1,
“list”[
{
“id”: “222222”,
“pid”:2
“ic”：4
“io”: IO1,IO2,IO3,IO4 ",
“cc”:4,
“cn”:”CH1,CH2,CH3,CH4”,
“sim”:13510671870,
“vt”,1
}
]
}
],
"companys":[ { "id":1 "nm":"測試", "pid":0 }, { "id":2 "nm":"測試子部門", "pid":1 } ]
}
一輛車可以對應多個裝置
|
引數名 |
引數型別 |
是否必需 |
預設值 |
描述 |
|
carnumber |
string |
是 |
無 |
車牌號 |
返回引數：
|
引數名 |
引數型別 |
描述 |
|
devid |
string |
裝置號 |
|
type |
number |
裝置型別1表示視訊裝置，0表示GPS裝置，2其他 |
可以多個裝置.
{ "result": 0, "devices":[ { " devid ":"50000000001", "type":1 }, { " devid ":"50000000000", "type":0 } ] }
|
引數名 |
引數型別 |
是否必需 |
預設值 |
描述 |
|
devid |
string |
否 |
無 |
裝置號可以是多個，以','分割。如果為空，則判斷車牌號。 |
|
Carnumber |
string |
否 |
無 |
返回引數說明
|
引數名 |
引數型別 |
描述 |
|
devid |
string |
裝置號 |
|
Carnumber |
string |
車牌號如果是用裝置號查詢，則為空。 |
|
online |
number |
線上狀態1表示線上，否則不線上。 |
正確返回示例
{ "result": 0, "onlines":[ { " devid ":"500000", " Carnumber ": null, "online":1 } ] }
私有引數
|
引數名 |
引數型別 |
是否必需 |
預設值 |
描述 |
|
carid |
string |
否 |
無 |
裝置號可以是多個，以','分割。如果為空，則判斷車牌號。 |
|
Carnumber |
string |
否 |
無 |
車牌號 |
|
convertmap |
number |
否 |
無 |
地圖經緯度轉換1表示經緯度轉換為谷歌地圖經緯度，2表示經緯度轉換為百度地圖經緯度，預設轉為谷歌地圖經緯度。 |
返回引數說明
|
引數名 |
引數型別 |
描述 |
|
devid |
string |
裝置號 |
|
Carnumber |
string |
車牌號如果是用裝置號查詢，則為空。 |
|
lng |
number |
經度如果裝置定位無效，值為0。例如：113231258，真實值為113.231258 |
|
lat |
number |
緯度如果裝置定位無效，值為0。例如：39231258，真實值為39.231258 |
|
ft |
number |
廠家型別 |
|
sp |
number |
速度單位: km/h，使用中需先除以10。 |
|
ol |
number |
線上狀態1表示線上，否則不線上。 |
|
gt |
string |
GPS上傳時間 |
|
pt |
number |
通訊協議型別 |
|
dt |
number |
硬碟型別1表示SD卡，2表示硬碟，3表示SSD卡。 |
|
ac |
number |
音訊型別 |
|
fdt |
number |
廠家子型別 |
|
s1-s64 |
number |
|
|
t1 |
number |
溫度感測器 1 |
|
t2 |
number |
溫度感測器 2 |
|
t3 |
number |
溫度感測器 3 |
|
t4 |
number |
溫度感測器 4 |
|
hx |
number |
方向正北方向為0度，順時針方向增大，最大值360度。 |
|
mlng |
string |
地圖經度經過轉換後的經度 |
|
mlat |
string |
地圖緯度經過轉換後的緯度 |
|
pk |
number |
停車時長單位: 秒。 |
|
lc |
number |
里程單位: 米。 |
|
yl |
number |
油量單位: 升，使用中需先除以100。 |
|
ps |
string |
地理位置解析後的地理位置 或者 (經過轉換後的經度, 經過轉換後的緯度) |
正確返回示例
{
"result": 0,
"status":[
{
"id":"500000",
"vid": null,
"lng":113921858,
"lat":22568745,
"ft":0,
"sp":520,
"ol":0,
"gt":"2015-12-14 18:54:58.0",
"pt":1,
"dt":1,
"ac":1,
"fdt":0,
"net":0,
"gw":"G1",
"s1":1,
" s2":0,
" s3":0,
" s4":"1",
" s5":0,
….
" s64":0, "t1":-321, "t2":350, "t3":-200, "t4":0, "hx":137, "mlng":"113.926720", "mlat":"22.565703", "pk":0, "lc":161446267, "yl":101, "ps":"113.926720,22.565703" } ] }
GPS狀態說明
|
11 |
S1 |
GPS定位狀態 |
0為無效,1為有效。 |
|
2 |
S2 |
ACC狀態 |
0表示ACC關閉1表示ACC開啟。 |
|
3 |
S3 |
左轉狀態 |
0為無效,1為左轉。 |
|
4 |
S4 |
右轉狀態 |
0為無效,1為右轉。 |
|
5 |
S5 |
剎車狀態 |
0為無效,1為剎車。 |
|
6 |
S6 |
正轉狀態 |
0為無效,1為正轉。 |
|
7 |
S7 |
反轉狀態 |
0為無效,1為反轉。 |
|
8 |
S8 |
GPS天線狀態 |
0為不存在，1為存在。 |
|
S9 |
S9 |
硬碟狀態 |
0為不存在，1為存在，2為斷電。 |
|
10 |
S10 |
3G模組狀態 |
0模組不存在，1無訊號，2訊號差，3訊號一般，4訊號好，5訊號優。 |
|
11 |
S11 |
靜止狀態 |
1:靜止 2 表示超速 3 表示低速 |
|
12 |
S12 |
補傳狀態 |
1表示GPS補傳 |
|
13 |
S13 |
夜間狀態 |
0表示日間,1表示夜間,先判斷超速才有效 |
|
14 |
S14 |
超載狀態 |
0表示正常,1表示超載。 |
|
15 |
S15 |
停車ACC狀態 |
關於停車未熄火，如果處理靜止狀態，並且處於ACC開啟狀態，則表示停車未熄火。 |
|
16 |
S16 |
出區域報警（終端產生 |
0為不存在，1為存在。 |
|
17 |
S17 |
出線路報警（終端產生） |
0為不存在，1為存在。 |
|
18 |
S18 |
區域報警狀態 |
0：不存在區域報警 1：區域內高速報警 2：區域內低速報警 3區域外高速報警 4：區域外低速報警 5：區域內停車報警 6：區域外停車報警 |
|
19 |
S19 |
流量使用報警 |
0：不存在報警 1：日流量預警 2：日流量超過 3：月流量預警 4月流量超過 |
|
20 |
S20 |
主機掉電由後備電池供電 |
0為不存在，1為存在 |
|
21 |
S21 |
車輛設防 |
0為不存在，1為存在 |
|
222 |
S22 |
出區域報警（終端產生） |
0為不存在，1為存在無 |
|
|
23 |
S23 |
電池電壓過低 |
0為不存在，1為存在無 |
|
|
45 |
S24 |
發動機 |
0為不存在，1為存在無 |
|
|
46 |
S25 |
車載狀態 |
0-空載狀態, 1-過載狀態. |
|
|
47 |
S26 |
作業狀態 |
1-作業中 ,0-空閒 平臺產生(環衛車) |
|
|
48 |
S27 |
運營狀態 |
0：正常運營 1：停運狀態 |
|
|
49 |
S28 |
油路正常 |
0：油路正常1：油路斷開 |
|
|
50 |
S29 |
電路正常 |
0-電路正常, 1-電路斷開. |
|
|
51 |
S30 |
車門解鎖 |
| |