Obter datas de término de período personalizadas
Aplica-se a: Partner Center | Partner Center operado pela 21Vianet | Partner Center para Microsoft Cloud para o Governo dos EUA
Os parceiros podem visualizar as datas de término de prazo personalizadas permitidas para assinaturas baseadas em licença NCE que estão comprando para seus clientes. Os parceiros podem ver as datas de fim que se alinham com o final do mês do calendário ou que coincidem com subscrições de clientes existentes.
As APIs suportam apenas o cálculo de datas de término de prazo personalizadas para a compra de novas assinaturas e não para a renovação de assinaturas existentes.
Pré-requisitos
Credenciais conforme descrito em autenticação do Centro de Parceiros. Este cenário oferece suporte à autenticação com credenciais autônomas de Aplicativo e Aplicativo+Usuário.
Um CustomerTenantId. Se não souber o ID do cliente, pode procurá-lo no Partner Center selecionando o espaço de trabalho Clientes, depois o cliente da lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure o de ID da Microsoft na seção Informações da Conta do Cliente. A ID da Microsoft é a mesma que a ID do cliente.
Pedido REST
Sintaxe da solicitação
Método | Solicitar URI |
---|---|
OBTER | {baseURL}/v1/customers/{customerId}/subscriptions/customTermEndDates |
Cadeias de caracteres de consulta
Esta tabela lista as cadeias de caracteres de consulta necessárias para filtrar e recuperar datas de término de termo personalizadas.
Designação: | Necessário: | Descrição: |
---|---|---|
duração_do_termo | Sim | Uma representação ISO 8601 da duração do termo. Os valores atuais suportados são P1M (1 mês), P1Y (1 ano) e P3Y (3 anos). |
data_de_início_do_mandato | Não | A data pretendida da compra. Isso não pode ficar no passado. |
target_coterm_subscription_id | Não | Uma cadeia de caracteres formatada em GUID que identifica a assinatura com a qual coterminar. |
Cabeçalhos de solicitação
Para mais informações, consulte os cabeçalhos REST do Partner Center . A resposta da API retorna um máximo de 300 registros de página. Se mais de 300 registros forem retornados em uma consulta inserida, um token de continuação será fornecido no cabeçalho da resposta. O token de continuação pode ser inserido no cabeçalho de uma solicitação a seguir para retornar registros de página adicionais consultados.
Corpo do pedido
Nenhuma.
Resposta REST
Se tiver sucesso, este método retornará os detalhes das Assinaturas que foram migradas (objeto de migração) no corpo da resposta. Isso inclui a ID de migração.
Códigos de sucesso e erro de resposta
Cada resposta vem com um código de status HTTP que indica sucesso ou falha e informações adicionais de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, tipo de erro e parâmetros adicionais. Para obter a lista completa, consulte códigos de erro REST do Partner Center.
Exemplos de URL de solicitação
baseurl/v1/customers/94cd6638-11b6-4323-8c9f-6ae3088adc59/subscriptions/customTermEndDates?term_duration=P1M
Exemplos de respostas
{
"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"
}
}