前のトピック: デフォルト組織の詳細の取得次のトピック: 組織の検索


組織の詳細の取得

組織の詳細を読み取るには、retrieveOrg 操作を使用します。

注: 一度に複数の組織の詳細を取得する場合は、listOrgs 操作を使用します。 この操作の使用方法の詳細については、「組織の検索」を参照してください。

このセクションでは、組織の詳細の取得に関する以下のトピックについて説明します。

リクエスト メッセージの準備

組織の詳細を取得するには、retrieveOrgRequest メッセージを使用します。 以下の表に、このリクエスト メッセージの要素のリストを示します。

要素

必須

説明

orgName

はい

組織を識別する一意の名前。

clientTxId

いいえ

呼び出し元アプリケーションが含めることができる一意のトランザクション識別子。 この識別子は、関連するトランザクションの追跡に役立ちます。

Web サービスの起動

組織の詳細を取得する方法

  1. (オプション) retrieveOrg 操作のヘッダに認証および許可の詳細を含めます。 ヘッダ要素の詳細については、「Web サービス セキュリティの管理」の章を参照してください。
  2. 組織の詳細を取得するには、retrieveOrgRequest 要素を使用します。
  3. retrieveOrgRequest メッセージを使用して、前の手順で取得した詳細に従って入力メッセージを作成します。
  4. ArcorUserRegistryMgmtSvc サービスの retrieveOrg 操作を呼び出して、組織の詳細を取得します。

    この操作では、トランザクション識別子、認証トークン、および組織の詳細が含まれる retrieveOrgResponse メッセージが返されます。 レスポンス メッセージの詳細については、以下のセクションを参照してください。

レスポンス メッセージの解釈

retrieveOrgResponse レスポンス メッセージでは、SOAP エンベロープ ヘッダでトランザクション識別子および認証トークンが返されます。 SOAP 本文には、成功したトランザクションでは組織の詳細が含まれ、エラーがある場合はエラー レスポンスが含まれます。

成功したトランザクションで返される要素の詳細については、listEmailTypeResponse レスポンス メッセージに関する情報が記載されている表を参照してください。 エラーがある場合は、付録「エラー コード」を参照してください。