組織と関連付けられているアカウント タイプを取得するには、listAccountTypes 操作を使用します。
このセクションでは、アカウント タイプを取得するための以下の手順について説明します。
組織と関連付けられているアカウント タイプを取得するには、listAccountTypeRequest メッセージを使用します。 以下の表に、このリクエスト メッセージの要素のリストを示します。
|
要素 |
必須 |
説明 |
|---|---|---|
|
targetAllOrgs |
はい |
すべての組織に割り当てられているアカウント タイプを取得するかどうかを示します。
|
|
orgName |
いいえ |
取得するアカウント タイプが属する組織の名前。 |
|
clientTxId |
いいえ |
呼び出し元アプリケーションが含めることができる一意のトランザクション識別子。 この識別子は、関連するトランザクションの追跡に役立ちます。 |
組織のアカウント タイプをリストする方法
この操作では、トランザクション識別子、認証トークン、および組織に関連付けられているアカウント タイプが含まれる listAccountTypeResponse メッセージが返されます。 レスポンス メッセージの詳細については、以下のセクションを参照してください。
listAccountTypeResponse レスポンス メッセージでは、SOAP エンベロープ ヘッダでトランザクション識別子および認証トークンが返されます。 SOAP 本文には、成功したトランザクションではアカウント タイプの詳細が含まれ、エラーがある場合はエラー レスポンスが含まれます。
成功したトランザクションで返される要素の詳細については、以下の表を参照してください。 エラーがある場合は、付録「例外コードおよびエラー コード」を参照してください。
|
要素 |
説明 |
|
|---|---|---|
|
ヘッダ要素 |
||
|
udsTransactionID |
UDS を使用して実行されたトランザクションの一意の識別子。 |
|
|
authToken |
Web サービスにアクセスするための認証情報の検証が成功した場合に返される認証トークン。 このトークンによって、その Web サービスへの後続のアクセスでは認証情報を提示する必要がなくなります。 デフォルトでは、認証トークンは 1 日間有効で、その後は認証が再度必要になります。 |
|
|
本文要素 |
||
|
AccountType/name |
アカウント タイプの名前。 |
|
|
AccountType/displayName |
アカウント タイプのわかりやすい名。 |
|
|
AccountType/customAttribute |
アカウント タイプの追加情報を指定するために使用する、名前と値のペア。 |
|
|
Copyright © 2014 CA Technologies.
All rights reserved.
|
|