GET の概要

GET は HTTP メソッドであり、これを使用して InsuranceSuite アプリケーションからデータを取得します。

GET には次の 2 種類があります。

• コレクション GET は、1 つ以上のリソースのコレクションを返す GET です。コレクション GET のパスで末尾は複数形の英単語名詞になります。例えば、GET /activities/xc:1227/notes です。
• 要素 GET は、単一の特定リソースを返す GET です。要素 GET のパスで末尾は特定リソースの ID になります。例えば、GET /activities/xc:1227 です。

GET が正常に終了すると、応答には以下のものが含まれます。

• 成功を示す HTTP 応答
• クエリで要求されたデータが含まれている応答ペイロード

GET を送信するように呼び出し元アプリケーションをコンフィギュレーションすると、API 呼び出しの構造はかなり単純になります。呼び出しではクエリパラメータが必要になる場合がありますが、GET では要求ペイロードを必要としません。主な作業は、応答ペイロードの解析になります。このトピックのこれ以降の部分で説明する内容は、応答ペイロードの構成方法と、開発者が応答ペイロードの形式について学ぶ方法です。