レスポンスと例外 - C# SDK

APIResponse、BulkAPIResponse、FileAPIResponseは、Zoho CRM APIのレスポンスのラッパーオブジェクトです。すべてのAPI呼び出しメソッドは、これら2つのオブジェクトのいずれかを返します。

  • メソッド検索エンティティーはAPIResponseオブジェクトを返し、メソッド検索エンティティーのリストはBulkAPIResponseオブジェクトを返します。
  • record.DownloadPhoto()、record.DownloadAttachment(Attachment_Id)などのデータまたはメモから写真または添付ファイルをダウンロードするために、ファイルダウンロードAPIに対してFileAPIResponseが返されます。
  • インスタンス変数「Data」または「BulkData」プロパティーを使用して、エンティティーデータのみをレスポンスラッパーオブジェクトから取得します。APIResponse.Dataは、単一のZoho CRMエンティティーオブジェクトを返し、BulkAPIResponse.BulkDataは、Zoho CRMエンティティーオブジェクトのリストを返します。
  • FileAPIResponseには、ダウンロードされたファイルの名前を返すFileAPIResponse.GetFileName()と、ファイルの内容をInputStreamとして返すFileAPIResponse.GetFileAsStream()の2つの定義済みメソッドがあります。

注：

  • BulkAPIResponseは汎用クラスです。そのため、データを取得するには、対応する型を使用する必要があります。

    "ZCRMModule module = ZCRMModule.GetInstance("Contacts");
    BulkAPIResponse<ZCRMRecord> response = module.GetRecords();
    List<ZCRMRecord> records = response.BulkData;"

これらのレスポンスラッパーオブジェクトには、データ以外に次のプロパティーがあります。

  1. ResponseHeaders - 現在の日付/ウィンドウの残りのAPIカウントと、現在のウィンドウがリセットされてから経過した時間。以下を通じて利用できます。

    response.GetResponseHeaders()

  2. ResponseInfo - 実際のデータに加えて、APIによって提供される場合は、その他の情報。

    response.Info

  3. List<EntityResponse> - 一括APIの個々のエンティティーのステータス。たとえば、データの追加では、いくつかのデータのためにAPIが部分的に失敗することがあります。このディクショナリーは、個々のデータの作成ステータスを示します。以下を通じて利用できます。

    response.BulkEntitiesResponse

例外の確認

問題のあるAPIレスポンス、SDKの異常などの予期しない動作はすべてSDKによって処理され、単一の例外であるZCRMExceptionとしてのみスローされます。したがって、この例外を検出するには、クライアントアプリコードだけで十分です。