適用於：合作夥伴中心 |由 21Vianet 營運的合作夥伴中心 |美國政府Microsoft雲端合作夥伴中心
合作夥伴可以查看他們為客戶購買的基於 NCE 許可證的訂閱允許的自定義期限結束日期。 合作夥伴可以查看與日曆月結束日期一致或與現有客戶訂閱一致的結束日期。
API 僅支援針對購買新訂閱的自定義字詞結束日期進行計算，而不支援現有訂閱的續約。
先決條件
合作夥伴中心身份驗證中所述的憑證。 此案例支援使用獨立應用程式和 App+使用者認證進行驗證。
客戶租戶ID（CustomerTenantId）。 如果您不知道客戶的標識碼，您可以在 合作夥伴中心 中選取 [客戶] 工作區，然後從客戶清單中找到該客戶，接著選取 [帳戶]。 在客戶的 [帳戶] 頁面上，在 [客戶帳戶資訊] 區段中尋找 Microsoft ID。 Microsoft標識碼與客戶標識符相同。
REST 要求
請求語法
| 方法 | 請求網址識別碼 (URI) |
|---|---|
| 獲取 | {baseURL}/v1/customers/{customerId}/subscriptions/customTermEndDates |
查詢字串
下表列出了篩選和檢索自定義術語結束日期所需的查詢字串。
| 名稱： | 必要： | 描述： |
|---|---|---|
| term_duration | 是的 | 詞彙持續時間的 ISO 8601 標準表示法。 目前的支援值為 P1M （1 個月）、P1Y （1 年） 和 P3Y （3 年）。 |
| term_start_date | 否 | 預期購買日期。 這不可能是過去。 |
| target_coterm_subscription_id | 否 | 一個 GUID 格式的字串，用於標識要與之共存的訂閱。 |
備註
P1M的期限或每月期限交給API將回傳共同期限結果，這些結果可能無法用於調整期限。 每月調整無法用於截至當月28日、29日或30日到期的訂閱，除非該日期是當月的最後一天。
請求標頭
如需詳細資訊，請參閱合作夥伴中心 REST 標頭。 API 的回應最多會傳回 300 個頁面記錄。 如果在輸入的查詢中傳回超過 300 筆記錄，響應標頭中會提供接續令牌。 可以在以下請求的標頭中輸入繼續標記，以返回查詢的其他頁面記錄。
請求主體
沒有。
REST 響應
如果成功，這個方法會在響應主體中傳回已移轉的訂閱詳細資訊（移轉物件）。 這包括遷移標識碼。
回應成功和錯誤碼
每個回應都有一個 HTTP 狀態代碼，指出成功或失敗和其他偵錯資訊。 請使用網路追蹤工具來讀取此錯誤碼、錯誤類型和其他參數。 如需完整清單，請參閱合作夥伴中心的 REST 錯誤碼。
請求 URL 範例
baseurl/v1/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M
回應範例
{
"totalCount": 2,
"items": [
{
"allowedCustomTermEndDateType": "calendarMonthAligned",
"allowedCustomTermEndDate": "2023-07-31T00:00:00"
},
{
"allowedCustomTermEndDateType": "subscriptionAligned",
"cotermSubscriptionIds": [
"5fcf618b-1daa-4604-da99-cc3e1c9ee422",
"d30a9ff9-713e-4546-c97e-f06b9dcf6ef6"
],
"allowedCustomTermEndDate": "2023-08-01T00:00:00"
}
],
"links": {
"self": {
"uri": "/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M",
"method": "GET",
"headers": []
}
},
"attributes": {
"objectType": "Collection"
}
}