前のトピック: 組織の詳細の取得次のトピック: AuthMinder データベース属性の取得


組織の検索

複数の組織の詳細を読み取るには、listOrgs 操作を使用します。 組織名、ステータス、および表示名の一部または完全な表示名で組織を検索できます。

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

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

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

要素

必須

説明

namePattern

いいえ

組織を検索するために使用する検索パターン。 組織の表示名の一部または完全な表示名を入力できます。 表示名の一部を入力すると、その検索パターンに一致する表示名を持つすべての組織が取得されます。

orgName

いいえ

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

注: 複数の組織を検索する場合は、各組織に対してこの要素を繰り返します。

OrgStatus

 

いいえ

データベース内の組織のステータス。 サポートされている値は以下のとおりです。

  • INITIAL
  • ACTIVE
  • INACTIVE
  • DELETED

clientTxId

いいえ

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

Web サービスの起動

複数の組織を検索する方法

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

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

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

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

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