|
輸入參數 |
※輸入參數請都先以UrlEncode過後再帶入、以避免因特殊字元造成的錯誤
|
名稱 |
描述 |
資料型態 |
註解 |
|
Ccid |
客戶證號 |
字串 |
最長為15位元的客戶證號 |
|
Key |
授權碼 |
字串 |
長度為36的授權碼字串 |
|
GsmNo |
車機門號 |
字串 |
可選參數，但無法與CarNo共同存在參數中。
欲查詢之車機門號，以半形逗號串接。
例如：GsmNo=0987654321,0987654322。
若包含重覆的車機門號，只會查詢一次。
若不輸入表示查詢客戶證號下所有車機最新狀態。
|
|
CarNo |
車牌號碼 |
字串 |
可選參數，但無法與GsmNo共同存在參數中。
欲查詢之車號，以半形逗號串接。
例如：GsmNo=test_car1,test_car2。
若包含重覆的車號，只會查詢一次。
若不輸入表示查詢客戶證號下所有車機最新狀態。
|
|
|
輸出結果 |
若API執行成功，輸出結果為一XML：
<?xml version="1.0" encoding="utf-8" ?>
<Data>
<Counter>共有多少組資訊</Counter>
<ObuStatus>
<GsmNo>車輛門號</GsmNo>
<CarNo>車牌號碼</CarNo>
<Time>狀態回覆時間</Time>
<Speed>車速，單位為公里/小時</Speed>
<Addr>位置</Addr>
<GpsStatus>GPS狀態代碼</GpsStatus>
<Lon>經度</Lon>
<Lat>緯度</Lat>
<Direction>行進方向角度，介於0~360之間，正北以0表示、正東以90表示，以此類推</Direction>
<CarStatus>車輛狀態代碼</CarStatus>
<StayStartTime>若逾時停留或引擎怠停事件尚未結束，會顯示此標簽。表示逾時停留或引擎怠停事件開始的時間</StayStartTime>
<IO1>IO1的IO狀態代碼</IO1>
<IO2>IO2的IO狀態代碼</IO2>
<IO3>IO3的IO狀態代碼</IO3>
<IO4>IO4的IO狀態代碼</IO4>
<rpm>轉速</rpm>
<mileage>里程數</mileage>
<ObuStatusTime>最新車機狀態回覆時間</ObuStatusTime>
<ObuStatusContent>最新車機狀態回覆內容</ObuStatusContent>
</ObuStatus>
<ObuStatus></ObuStatus>
……(ObuStatus共Counter筆)
</Data>
|
輸出參數說明：
|
標籤名稱 |
描述 |
資料型態 |
註解 |
|
Counter |
訊息筆數 |
數字 |
此次API共回應多少筆歷史記錄 |
|
ObuStatus |
車機最新回報資料 |
|
共有Counter筆 |
|
GsmNo |
車機門號 |
字串 |
車機門號 |
|
CarNo |
車牌號碼 |
字串 |
車牌號碼
|
|
Time |
狀態回覆時間 |
時間字串(yyyy/MM/dd HH:mm:ss) |
車機傳送此筆訊息的時間
|
|
Speed |
車速 |
字串 |
車機傳送此筆訊息時的車速
|
|
Addr |
位置 |
字串 |
車機傳送此筆訊息時的位置
|
|
GpsStatus |
GPS狀態 |
數字 |
車機傳送此筆訊息時的GPS狀態代碼
|
|
Lon |
經度 |
字串 |
車機傳送此筆訊息時的所在位置之經度
|
|
Lat |
緯度 |
字串 |
車機傳送此筆訊息時的所在位置之緯度
|
|
Direction |
方向 |
字串 |
行進方向角度，介於0~360之間，正北以0表示、正東以90表示，以此類推
|
|
CarStatus |
車輛狀態代碼 |
數字 |
車輛狀態代碼(詳見代碼對照表)
|
|
StayStartTime |
停留開始時間 |
時間字串(yyyy/MM/dd HH:mm:ss) |
若逾時停留或引擎怠停事件尚未結束，會顯示此標簽，表示逾時停留或引擎怠停事件開始的時間
|
|
IO1 |
IO1的IO狀態代碼 |
數字 |
IO1的IO狀態代碼(詳見IO狀態對照表)，此欄位僅車訊快遞 3G PND車機有意義，其餘車機一律顯示為99
|
|
IO2 |
IO2的IO狀態代碼 |
數字 |
IO2的IO狀態代碼(詳見IO狀態對照表)，此欄位僅車訊快遞 3G PND車機有意義，其餘車機一律顯示為99
|
|
IO3 |
IO3的IO狀態代碼 |
數字 |
IO3的IO狀態代碼(詳見IO狀態對照表)，此欄位僅車訊快遞 3G PND車機有意義，其餘車機一律顯示為99
|
|
IO4 |
IO4的IO狀態代碼 |
數字 |
IO4的IO狀態代碼(詳見IO狀態對照表)，此欄位僅車訊快遞 3G PND車機有意義，其餘車機一律顯示為99
|
|
rpm |
轉速 |
數字 |
車機傳送此筆訊息時的轉速 |
|
mileage |
里程數 |
數字 |
車機傳送此筆訊息時的里程數
|
|
ObuStatusTime |
最新車機狀態回覆時間 |
日期 |
最新車機狀態回覆時間
|
|
ObuStatusContent |
最新車機狀態回覆內容 |
字串 |
最新車機狀態回覆內容
|
附註：IO1、IO2、IO3、IO4代表意義需視IO設定而定。例如IO1接至車門，則IO1表示車門IO。
|
|
GPS狀態代碼表：
|
|
車輛狀態代碼表：
|
車輛狀態代碼 |
說明 |
|
0 |
待命 |
|
1 |
休息 |
|
2 |
作業/行駛中 |
|
3~8、11~13、18、21、34、54 |
防盜告警 |
|
9 |
開門 |
|
10 |
關門 |
|
14、55 |
斷電 |
|
15 |
完畢 |
|
16 |
檢測回報 |
|
17 |
解除告警 |
|
19 |
超速 |
|
20 |
逾時停留 |
|
22、31、50~52 |
斷電告警 |
|
23、53 |
緊急按鈕 |
|
24 |
斷油 |
|
25 |
出勤 |
|
26 |
退勤 |
|
27 |
值勤中 |
|
28 |
檢測啟動 |
|
29 |
拖移 |
|
36 |
引擎怠停 |
|
66 |
引擎作業 |
|
128 |
註冊中 |
|
247 |
失聯後更新為熄火狀態 |
|
248 |
未裝機 |
|
249 |
確認防盜 |
|
250 |
確認解除 |
|
251 |
進入防盜 |
|
252 |
解除防盜 |
|
253 |
失聯 |
|
254 |
熄火 |
|
255 |
發動 |
|
|
IO狀態代碼表：
|
IO狀態代碼 |
說明 |
|
0 |
Low |
|
1 |
High |
|
2 |
Low Pulse |
|
3 |
High Pulse |
|
4 |
Low Level Delay |
|
5 |
High Level Delay |
|
99 |
不觸發 |
|
254 |
車機處於關機或註冊狀態 |
|
255 |
其他(異常) |
|
|
錯誤訊息 |
若API執行失敗，結果以XML格式回傳：
<?xml version="1.0" encoding="utf-8" ?>
<Data>
<ErrorCode>錯誤訊息代碼</ErrorCode>
</Data>
|
錯誤訊息代碼說明如下：
|
錯誤訊息代碼 |
錯誤說明 |
|
001 |
輸入的授權碼(Key)是不合法的授權碼 |
|
002 |
使用的IP是不合法的IP |
|
003 |
存取時間小於允許間隔時間 |
|
010 |
輸入的參數有缺漏 |
|
011 |
輸入的客戶證號(Ccid)不正確 |
|
012 |
輸入的車機門號(GsmNo)至少有一組不正確 |
|
013 |
GsmNo與CarNo僅能使用其中一個參數 |
|
014 |
輸入的車號(CarNo)至少有一組不正確 |
|
200 |
系統忙碌或其他原因造成沒有完成服務，請重試 |
|
|
範例 |
呼叫範例：
https://efms.hinet.net/FMS_WS/Services/API/Get_ObuStatus.aspx?Ccid=123456&Key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&GsmNo=0987654321
https://efms.hinet.net/FMS_WS/Services/API/Get_ObuStatus.aspx?Ccid=123456&Key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&CarNo=carno1
回應範例：
<?xml version="1.0" encoding="utf-8" ?>
<Data>
<Counter>1</Counter>
<ObuStatus>
<GsmNo>0987654321</GsmNo>
<CanNo>AA-1234</CanNo>
<Time>2011/02/23 12:15:50</Time>
<Speed>20</Speed>
<Addr>桃園縣楊梅鎮民族路二段551巷12號附近</Addr>
<GpsStatus>0</GpsStatus>
<Lon>121.164261</Lon>
<Lat>24.951975</Lat>
<Direction>93</Direction>
<CarStatus>255</CarStatus>
<IO1>0</IO1>
<IO2>99</IO2>
<IO3>99</IO3>
<IO4>99</IO4>
<rpm>1000</rpm>
<mileage>10000</mileage>
<ObuStatusTime>2011/02/23 11:15:50</ObuStatusTime>
<ObuStatusContent>貨物確認</ObuStatusContent>
</ObuStatus>
</Data>
|
|