Share via


顧客の検証状態を取得する

パートナーは、必要に応じて顧客の検証の状態を取得できます。

前提条件

  • 「パートナー センター認証」の説明に従って資格情報を確立します。 このシナリオでは、アプリとユーザーの資格情報を使用した認証のみがサポートされます。

  • 顧客 ID (customer-tenant-id)。 顧客の ID がわからない場合は、 パートナー センター で [顧客] ワークスペースを選択し、 次に顧客 の一覧から顧客を探し、[ アカウント] を選択します。 顧客の [アカウント] ページで、[顧客アカウント情報] セクションで Microsoft ID を探します。 Microsoft ID は、顧客 ID (customer-tenant-id) と同じです。

C#

顧客のアカウントの検証状態を取得するには、まず、取得する ValidationType を表す列挙型を作成します。 次に、顧客識別子を使用して IAggregatePartner.Customers.ById メソッドを呼び出します。 次に、 ValidationStatus プロパティを使用して IValidationStatus インターフェイスを 取得します。 最後に、入力パラメーターとして検証型列挙型変数を使用して または GetValidationStatusAsync() を呼び出GetValidationStatus()します。

var validationTypeToFetch = ValidationType.Account;
var eduCustomerQualification = partnerOperations.Customers.ById(existingCustomer.Id).ValidationStatus.GetValidationStatus(validationTypeToFetch);

サンプル: コンソール サンプル アプリプロジェクト: SdkSamples クラス: GetValidationStatus.cs

REST 要求

要求の構文

認証方法 URI
GET {baseURL}/v1/customers/{customer-id}/validationStatus?type=account

URI パラメーター

検証の状態を取得する顧客を指定するには、次のクエリ パラメーターを使用します。

名前 Type 必須 説明
{customer-id} guid Y 値は、顧客を指定できる GUID 形式の CustomerTenantId です。
type string Y 取得する検証状態の種類。

要求ヘッダー

詳細については、「パートナー センター REST ヘッダー」を参照してください。

REST 応答

各応答には、成功または失敗を示す HTTP ステータス コードと、追加のデバッグ情報が付属しています。 このコード、エラーの種類、追加のパラメーターを読み取るには、ネットワーク トレース ツールを使用します。 完全な一覧については、パートナー センターの REST エラーコードに関する記事を参照してください。

応答フィールド

フィールド Type 説明 メモ
Type 列挙型 検証情報の種類 検証型と同じデータ。 検証の種類は、応答の種類として アカウント を返します。
Status 列挙型 検証状態 使用可能な状態: 不明、UnderReview、Allowed、NotAllowed、Not Ready
最新の更新時刻 string UTC での最終状態更新時刻

応答例

許可されている状態

{
    "type": "account",
    "status": "Allowed",
    "lastUpdateDateTime": "2021-07-14T18:02:00"
}

レビューの状態

{
    "type": "account",
    "status": "UnderReview",
    "lastUpdateDateTime": "2021-07-14T18:02:00"
}

NotAllowed 状態

{
    "type": "account",
    "status": "NotAllowed",
    "lastUpdateDateTime": "2021-07-14T18:02:00"
}

[不明] 状態

{
    "type": "account",
    "status": "Unknown",
    "lastUpdateDateTime": "2021-07-14T18:02:00"
}

準備ができていない状態

{
    "type": "account",
    "status": "Not Ready",
    "lastUpdateDateTime": "2021-07-14T18:02:00"
}

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"

購入資格

お客様のアカウントに以下のいずれかの状態がある場合、顧客のトランザクションはブロックされます。

  • UnderReview
  • 禁止
  • Unknown

顧客が次の条件を満たしている場合、顧客のトランザクションはブロックされません。

  • 顧客の状態が [許可] になっている
  • 顧客がアカウントの状態を持っていない