|
輸入參數 |
※輸入參數請都先以UrlEncode過後再帶入、以避免因特殊字元造成的錯誤
|
名稱 |
描述 |
資料型態 |
註解 |
|
Ccid |
客戶證號 |
字串 |
最長為15位元的客戶證號 |
|
Key |
授權碼 |
字串 |
長度為36的授權碼字串 |
|
GsmNo |
車機門號 |
字串 |
DispatchId+GsmNo組合的最新一筆多階段派遣單資訊。
|
|
DispatchId |
派遣訊息代號 |
正整數 |
DispatchId+GsmNo組合的最新一筆多階段派遣單資訊。
|
|
|
輸出結果 |
若API執行成功，輸出結果為一XML：
<?xml version="1.0" encoding="utf-8" ?>
<Data>
<DispatchId>派遣訊息代號</DispatchId>
<ResponseTime>車機回覆時間</ResponseTime>
<StageName1>第一階段派遣階段名稱</StageName1>
<ReplyTime1>第一階段司機回覆時間</ReplyTime1>
<ReplyStage1>第一階段司機回覆結果</ReplyStage1>
<StageName2>第二階段派遣階段名稱</StageName2>
<ReplyTime2>第二階段司機回覆時間</ReplyTime2>
<ReplyStage2>第二階段司機回覆結果</ReplyStage2>
<StageName3>第三階段派遣階段名稱</StageName3>
<ReplyTime3>第三階段司機回覆時間</ReplyTime3>
<ReplyStage3>第三階段司機回覆結果</ReplyStage3>
<StageName4>第四階段派遣階段名稱</StageName4>
<ReplyTime4>第四階段司機回覆時間</ReplyTime4>
<ReplyStage4>第四階段司機回覆結果</ReplyStage4>
<Return>是否曾返回</Return>
</Data>
|
輸出參數說明：
|
標籤名稱 |
描述 |
資料型態 |
註解 |
|
DispatchId |
派遣訊息代號 |
正整數 |
發送多階段派遣時，系統配給的派遣訊息代號 |
|
ResponseTime |
車機回覆時間 |
時間或空白 |
格式為：yyyy/MM/dd HH:mm:ss，若車機未收到派遣訊息則會空白無值 |
|
StageName1 |
第一階段派遣階段名稱 |
字串 |
|
|
ReplyTime1 |
第一階段司機回覆時間 |
時間或空白 |
格式為：yyyy/MM/dd HH:mm:ss，若司機尚未回應則會空白無值 |
|
ReplyStage1 |
第一階段司機回覆結果 |
字串 |
|
|
StageName2 |
第二階段派遣階段名稱 |
字串 |
|
|
ReplyTime2 |
第二階段司機回覆時間 |
時間或空白 |
格式為：yyyy/MM/dd HH:mm:ss，若司機尚未回應則會空白無值 |
|
ReplyStage2 |
第二階段司機回覆結果 |
字串 |
|
|
StageName3 |
第三階段派遣階段名稱 |
字串 |
|
|
ReplyTime3 |
第三階段司機回覆時間 |
時間或空白 |
格式為：yyyy/MM/dd HH:mm:ss，若司機尚未回應則會空白無值 |
|
ReplyStage3 |
第三階段司機回覆結果 |
字串 |
|
|
StageName4 |
第四階段派遣階段名稱 |
字串 |
|
|
ReplyTime4 |
第四階段司機回覆時間 |
時間或空白 |
格式為：yyyy/MM/dd HH:mm:ss，若司機尚未回應則會空白無值 |
|
ReplyStage4 |
第四階段司機回覆結果 |
字串 |
|
|
Return |
是否曾返回 |
數字 |
1為此派遣曾返回，0為此派遣不曾返回或此車機不支援返回功能 |
|
|
錯誤訊息 |
若API執行失敗，結果以XML格式回傳：
<?xml version="1.0" encoding="utf-8" ?>
<Data>
<ErrorCode>錯誤訊息代碼</ErrorCode>
</Data>
|
錯誤訊息代碼說明如下：
|
錯誤訊息代碼 |
錯誤說明 |
|
001 |
輸入的授權碼(Key)是不合法的授權碼 |
|
002 |
使用的IP是不合法的IP |
|
003 |
存取時間小於允許間隔時間 |
|
010 |
輸入的參數有缺漏 |
|
011 |
輸入的客戶證號(Ccid)不正確 |
|
012 |
輸入的車機門號(GsmNo)不正確 |
|
200 |
系統忙碌或其他原因造成沒有完成服務，請重試 |
|
201 |
錯誤的派遣訊息代號(DispatchId)格式 |
|
202 |
查無此派遣訊息代號資訊 |
|
|
範例 |
呼叫範例：
https://efms.hinet.net/FMS_WS/Services/API/Get_DispatchStatus.aspx?Ccid=123456&Key=XXXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXXXXX&GsmNo=0987654321&DispatchId=3
回應範例：
<?xml version="1.0" encoding="utf-8" ?>
<Data>
<DispatchId>3</DispatchId>
<ResponseTime>2008/01/20 10:42:13</ResponseTime>
<StageName1>任務</StageName1>
<ReplyTime1>2008/01/20 10:45:34</ReplyTime1>
<ReplyStage1>出發</ReplyStage1>
<StageName2>過程一</StageName2>
<ReplyTime2>2008/01/20 11:23:42</ReplyTime2>
<ReplyStage2>上車</ReplyStage2>
<StageName3>過程二</StageName3>
<ReplyTime3>2008/01/20 15:45:14</ReplyTime3>
<ReplyStage3>下車</ReplyStage3>
<StageName4>結案</StageName4>
<ReplyTime4>2008/01/20 16:14:51</ReplyTime4>
<ReplyStage4>結束</ReplyStage4>
<Return>0</Return>
</Data>
|
|