リクエストと応答のメッセージ フォーマット

リクエストと応答のメッセージ フォーマット

リクエスト

    <?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> タグで囲まれます。リクエストが成功した場合、レスポンス タグの Success 属性が true に設定されます。リクエストが失敗した場合、success 属性は false に設定されます。
多くの API 呼び出しは、サーバーで生成されたメッセージのリストを含む、このオプションの <メッセージ> ブロックを返します。このブロックは、呼び出しに応じてサーバーに返されるメッセージがない場合に表示されない場合があります。エラー メッセージは、常にメッセージ ブロック内に表示されます。
メッセージ ブロック内の各メッセージには、送信されるメッセージのタイプを識別するキー属性があります。メッセージ タグには、サーバーからのメッセージのテキストも含まれ、これにはリクエストの成功または失敗に関する戻り値、ステータス値、その他の単独のメタデータが含まれます。応答に含めることができるメッセージ タグの数に制限はありません。
終了メッセージ タグ。
API メソッド呼び出しからの実際の出力は (返された場合)、<output> タグで囲まれます。
API メソッド呼び出しからの実際の出力はここに表示されます。この出力は、呼び出されたメソッドによって異なります。
終了出力タグ。
終了応答タグ。