パートナーは、要求に応じて顧客検証のステータスを取得できます。
[前提条件]
パートナー センターの認証で説明されているように、確立された資格情報。 このシナリオでは、App+User 資格情報のみを使用した認証がサポートされます。
顧客 ID (customer-tenant-id)。 顧客の ID がわからない場合は、パートナー センターで [顧客] ワークスペースを選び、顧客一覧から顧客を選び、[アカウント] を選んで調べることができます。 顧客の [アカウント] ページで、[顧客アカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。
C#
顧客のアカウントの検証ステータスを取得するには、まず、取得する ValidationType を表す列挙型を作成します。 次に、顧客識別子を使用して IAggregatePartner.Customers.ById メソッドを呼び出します。 次に、 ValidationStatus プロパティを使用して IValidationStatus インターフェイスを取得します。 最後に、検証タイプの列挙型変数を入力パラメータとして GetValidationStatus() または GetValidationStatusAsync() を呼び出します。
var validationTypeToFetch = ValidationType.Account;
var eduCustomerQualification = partnerOperations.Customers.ById(existingCustomer.Id).ValidationStatus.GetValidationStatus(validationTypeToFetch);
サンプル: コンソール サンプル アプリ。 プロジェクト: SdkSamples クラス: GetValidationStatus.cs
RESTリクエスト
リクエスト構文
| メソッド | URI |
|---|---|
| 取得する | {baseURL}/v1/customers/{customer-id}/validationStatus?type=account |
URI パラメーター
次のクエリパラメータを使用して、検証ステータスを取得する顧客を指定します。
| 名前 | タイプ | 必須 | 説明 |
|---|---|---|---|
| {お客様ID} | GUID | Y | 値は、顧客を指定できる GUID 形式の CustomerTenantId です。 |
| 型 | 文字列 | Y | 取得する検証ステータスのタイプ。 |
要求ヘッダー
詳細については、「パートナー センター REST ヘッダー」を参照してください。
REST 応答
各応答には、成功または失敗とその他のデバッグ情報を示す HTTP 状態コードが付属しています。 ネットワーク トレース ツールを使用して、このコード、エラーの種類、およびその他のパラメーターを読み取ります。 完全な一覧については、パートナー センターの REST エラー コード 参照してください。
応答フィールド
| フィールド | タイプ | 説明 | 注記 |
|---|---|---|---|
| タイプ | 列挙型 | 検証情報の種類 | validation-type と同じデータ。 検証タイプは、応答タイプとして account を返します。 |
| ステータス | 文字列 | 検証状態 | 利用可能なステータス: 不明、レビュー中、許可済み、許可されていない、準備ができていません |
| 最新の更新時刻 | 文字列 | UTC での最後のステータス更新時刻 | 日時は入力されなくなり、空の文字列になります。 |
応答例
許可されたステータス
{
"type": "account",
"status": "Allowed",
"lastUpdateDateTime": ""
}
レビュー中の状態
{
"type": "account",
"status": "UnderReview",
"lastUpdateDateTime": ""
}
許可されていないステータス
{
"type": "account",
"status": "NotAllowed",
"lastUpdateDateTime": ""
}
不明なステータス
{
"type": "account",
"status": "Unknown",
"lastUpdateDateTime": ""
}
未準備ステータス
{
"type": "account",
"status": "Not Ready",
"lastUpdateDateTime": ""
}
404 見つかりません エラー
{
"code": 600074,
"message": "Account Status for the customer, {customer-id} was not found.",
"description": "Account Status for the customer, {customer-id} was not found.",
"errorName": "AccountStatusNotFound",
"isRetryable": false,
"errorMessageExtended": "InternalErrorCode=600074"
購入資格
お客様の取引は、お客様のアカウントに以下のいずれかのステータスがある場合、ブロックされます。
- アンダーレビュー
- 許可されていません
- 未知
顧客が次のいずれかの条件を満たしている場合、顧客のトランザクションはブロックされません。
- 顧客のステータスは [許可] です
- 顧客にアカウントのステータスがない
- 顧客がサンドボックス ユーザーである