擷取客戶的驗證狀態
合作夥伴可以依需求擷取客戶驗證的狀態。
必要條件
合作夥伴中心驗證中所述 的已建立認證。 此案例僅支援使用「應用程式+使用者」認證來進行驗證。
客戶標識碼(customer-tenant-id)。 如果您不知道客戶的標識碼,您可以在合作夥伴中心中選取 [客戶] 工作區,然後從客戶清單中查看客戶,然後從 [帳戶]。 在客戶的 [帳戶] 頁面上,在 [客戶帳戶資訊] 區段中尋找Microsoft標識碼。 Microsoft標識碼與客戶標識符 (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 參數
使用下列查詢參數來指定您要擷取驗證狀態的客戶。
名稱 | 類型 | 必要 | 描述 |
---|---|---|---|
{customer-id} | guid | Y | 此值是 GUID 格式的 CustomerTenantId,可讓您指定客戶。 |
type | 字串 | Y | 要擷取的驗證狀態類型。 |
要求標頭
如需詳細資訊,請參閱合作夥伴中心 REST 標頭。
REST 回應
每個回應都有一個 HTTP 狀態代碼,指出成功或失敗和其他偵錯資訊。 使用網路追蹤工具來讀取此程式代碼、錯誤類型和其他參數。 如需完整清單,請參閱合作夥伴中心的 REST 錯誤碼。
回應欄位
欄位 | 類型 | 名稱 | 附註 |
---|---|---|---|
類型 | 列舉 | 驗證信息類型 | 與 驗證類型相同的數據。 驗證類型會傳 回帳戶 作為回應類型。 |
狀態 | 字串 | 驗證狀態 | 可用狀態:未知、UnderReview、Allowed、NotAllowed、Not Ready |
最新更新時間 | 字串 | UTC 的上次狀態更新時間 | 日期時間不再填入,而且會是空字串。 |
回應範例
允許的狀態
{
"type": "account",
"status": "Allowed",
"lastUpdateDateTime": ""
}
處於檢閱狀態
{
"type": "account",
"status": "UnderReview",
"lastUpdateDateTime": ""
}
NotAllowed 狀態
{
"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"
購買資格
如果客戶的帳戶具有下列任何狀態,則會封鎖客戶的交易:
- UnderReview
- NotAllowed
- Unknown
客戶的交易在符合下列條件時不會遭到封鎖:
- 客戶具有 [允許] 狀態
- 客戶沒有帳戶狀態