電子メールタイプの取得

組織に対して設定されている電子メールアドレスタイプを取得するには、listEmailTypes 操作を使用します。

このセクションでは、組織に対して設定されている電子メールアドレスタイプを取得するための以下の手順について説明します。

組織に対して設定されている電子メールアドレスタイプを取得するには、listEmailTypeRequest メッセージを使用します。以下の表に、このリクエストメッセージの要素のリストを示します。

要素	必須	説明
orgName	いいえ	電子メールアドレスタイプを取得する必要がある組織の名前。
clientTxId	いいえ	呼び出し元アプリケーションが含めることができる一意のトランザクション識別子。この識別子は、関連するトランザクションの追跡に役立ちます。

電子メールアドレスタイプを取得する方法

（オプション） listEmailTypes 操作のヘッダに認証および許可の詳細を含めます。ヘッダ要素の詳細については、「Web サービスセキュリティの管理」を参照してください。
listEmailTypeRequest 要素を使用して、この表に記載されている組織名を取得します。
listEmailTypeRequest メッセージを使用して、前の手順で指定した詳細に従って入力メッセージを作成します。
ArcotConfigRegistrySvc サービスの listEmailTypes 操作を呼び出して、電子メールアドレスタイプを取得します。
この操作では、トランザクション識別子、認証トークン、および電子メールアドレスタイプが含まれる listEmailTypeResponse メッセージが返されます。レスポンスメッセージの詳細については、以下のセクションを参照してください。

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

成功したトランザクションで返される要素の詳細については、以下の表を参照してください。エラーがある場合は、付録「例外コードおよびエラーコード」を参照してください。

要素	説明

ヘッダ要素
udsTransactionID	UDS を使用して実行されたトランザクションの一意の識別子。
authToken	Web サービスにアクセスするための認証情報の検証が成功した場合に返される認証トークン。このトークンによって、その Web サービスへの後続のアクセスでは認証情報を提示する必要がなくなります。デフォルトでは、認証トークンは 1 日間有効で、その後は認証が再度必要になります。
本文要素
isGlobal	電子メールタイプをグローバルレベルで設定するかどうかを示します。 True：電子メールタイプがグローバルレベルで設定されていることを示します。 False：電子メールタイプが組織レベルで設定されていることを示します。
emailType/name	電子メールアドレスタイプの名前。
emailType/displayName	電子メールアドレスタイプの表示名。
emailType/priority	複数の電子メールタイプが設定されている場合の、電子メールタイプの優先度。
emailType/isMandatory	電子メールタイプが必須かどうかを示します。