要求和回應訊息格式

要求和回應訊息格式

要求

    <?xml version='1.0' encoding='UTF-8'?>
    <call method="exportData" callerName="a string that identifies your client application">
       <credentials login="sample@company.com" password="my_pwd"/>              
       method specific data goes here
    </call>

此行表示後續資料是採用 UTF-8 編碼的 XML。
<call> 標記會使用其方法屬性內容來指出正在呼叫哪個 API 方法。在此範例中，API 方法為 exportData。此外，callerName 是 <call> 標記的必要屬性內容。它可向系統識別您的用戶端應用程式，並在疑難排解和記錄時用於識別目的。
每個 API 方法都需要驗證進行呼叫的使用者。這通常是透過提供登入名稱和密碼來完成。允許在此指定其他屬性內容。請參閱每個 API 函數的文件，以取得有關憑證的更多詳細資料。
某些 API 方法需要在要求中包含其他資料。例如，exportData 方法需要一些條件，這些條件說明在擷取其資料時應使用哪些時段、科目、層級等。這部分的要求會因方法而異。
這是第 2 行呼叫標記的結束標記。

回覆

     <?xml version='1.0' encoding='UTF-8'?>
     <response success="true">
       <messages>
          <message key="modeled-import-success">Personnel import successful. Rows imported: 100</message>
       </messages>
       <output>
         ... method output ...
       </output>
     </response>

與要求類似，此行指出後續資料的格式為 XML，並以 UTF-8 編碼。
每個回覆都包含在 <response> 標記中。如果要求成功，則回應標記上的成功屬性內容會設為 True。如果要求不成功，則成功屬性內容會設為 False。
許多 API 呼叫都會傳回此選填的 <messages> 區塊，其中包含伺服器產生的訊息清單。如果伺服器沒有可傳回的訊息來回應呼叫，則可能不會顯示此區塊。錯誤訊息將一律顯示在訊息區塊內。
訊息區塊內的每條訊息都有一個索引鍵屬性內容，可識別要傳送的訊息類型。訊息標記也包含來自伺服器的訊息文字，包括任何傳回值、狀態值或其他與要求成功或失敗相關的獨立中繼資料。回覆可包含不限數量的訊息標記。
關閉訊息標記。
API 方法呼叫的實際輸出 (如果有的話) 會包含在 <輸出> 標記中。
API 方法呼叫的實際輸出會顯示在此處。此輸出會因呼叫的方法而異。
結束輸出標記。
結束回應標記。