Atualizar as qualificações de um cliente de forma assíncrona

  • Artigo

Atualiza as qualificações de um cliente de forma assíncrona.

Um parceiro pode atualizar as qualificações de um cliente de forma assíncrona para ser "Education", "GovernmentCommunityCloud" ou "StateOwnedEntity". Outros valores, como "Nenhum" e "Sem fins lucrativos", não podem ser definidos.

Pré-requisitos

  • Credenciais, conforme descrito em Autenticação do Partner Center. Este cenário dá suporte somente à autenticação com credenciais de aplicativo + de usuário.

  • Uma ID do cliente (customer-tenant-id). Se você não souber a ID do cliente, poderá procurá-la no Partner Center selecionando o espaço de trabalho Clientes, o cliente na lista de clientes e, em seguida, Conta. Na página Conta do cliente, procure a ID da Microsoft na seção Informações da Conta do Cliente. A ID da Microsoft é igual à ID do cliente (customer-tenant-id).

C#

Para criar a qualificação de um cliente para "Educação", primeiro, crie um objeto de tipo e especifique o tipo de qualificação e o EducationSegmentEducation , juntamente com um CustomerQualificationRequestWebsite (opcional).

Em seguida, chame o método IAggregatePartner.Customers.ById com o identificador do cliente.

Em seguida, use a propriedade Qualification para recuperar uma interface ICustomerQualification.

Finalmente, chame CreateQualifications() ou CreateQualificationsAsync() com o CustomerQualificationRequest objeto type como o parâmetro de entrada.

// Education
var eduRequestBody = new CustomerQualificationRequest 
{
    Qualification = "Education",
    EducationSegment = "K12", // could also be "HigherEducation"
    Website = "example.edu"
};

var eduCustomerQualification = partnerOperations.Customers.ById(existingCustomer.Id).Qualification.CreateQualifications(eduRequestBody);

// State Owned Entity
var soeRequestBody = new CustomerQualificationRequest 
{
    Qualification = "StateOwnedEntity"
};

var soeCustomerQualification = partnerOperations.Customers.ById(existingCustomer.Id).Qualification.CreateQualifications(soeRequestBody);

Exemplo: Aplicativo de exemplo de console. Projeto: Classe SdkSamples: CreateCustomerQualification.cs

Para atualizar a qualificação de um cliente para o GovernmentCommunityCloud em um cliente existente sem uma qualificação, o parceiro também precisa incluir o código de validação do cliente.

Primeiro, crie um objeto de CustomerQualificationRequest tipo e especifique o tipo de qualificação e o GovernmentCommunityCloud código de validação.

Em seguida, chame o método IAggregatePartner.Customers.ById com o identificador do cliente.

Em seguida, use a propriedade Qualification para recuperar uma interface ICustomerQualification.

Finalmente, chame CreateQualifications() ou CreateQualificationsAsync() com o CustomerQualificationRequest objeto type como o parâmetro de entrada.

var gccRequestBody = new CustomerQualificationRequest 
{
    Qualification = "GovernmentCommunityCloud",
    ValidationCode = "<validation code>"
};

var gccCustomerQualification = partnerOperations.Customers.ById(existingCustomer.Id).Qualification.CreateQualifications(gccRequestBody);

Exemplo: Aplicativo de exemplo de console. Projeto: Classe SdkSamples: CreateCustomerQualificationWithGCC.cs

Solicitação REST

Sintaxe da solicitação

Método URI da solicitação
POST {baseURL}/v1/customers/{customer_tenant_id}/qualificações HTTP/1.1

Parâmetro do URI

Use o parâmetro de consulta a seguir para atualizar a qualificação.

Nome Digitar Obrigatória Descrição
id de locatário do cliente GUID Sim O valor é um ID de cliente-locatário formatado por GUID que permite ao revendedor filtrar os resultados de um determinado cliente que pertence ao revendedor.

Cabeçalhos da solicitação

Para obter mais informações, confira Cabeçalhos REST do Partner Center.

Corpo da solicitação

Esta tabela descreve o objeto de qualificação no corpo da solicitação.

Propriedade Type Obrigatória Descrição
Qualificação string Sim O valor da cadeia de caracteres do enum CustomerQualification .

Esta tabela descreve especificamente o corpo de solicitação para a Qualificação Educacional .

Propriedade Type Obrigatória Descrição
Qualificação string Sim Educação
Segmento Educação string Sim K12, Ensino Superior
Website string Não Site da entidade educativa

Se a qualificação for para Educação, o segmento Educação é um campo obrigatório.

  • Os valores permitidos para EducationSegment são K12 e HigherEducation
  • Site continua sendo um campo opcional, e é relevante apenas se a Qualificação for para Educação. No entanto, incluí-lo, se disponível/aplicável é altamente recomendável

Esta tabela descreve o corpo da solicitação para a Qualificação GovernmentCommunityCloud especificamente.

Propriedade Type Obrigatória Descrição
Qualificação string Sim GovernmentCommunityCloud
Código de Validação string Sim Código de validação GCC do parceiro. Exemplo - 123456

Se a qualificação for para GovernmentCommunityCloud, ValidationCode será um campo obrigatório.

Exemplo de solicitação

POST https://api.partnercenter.microsoft.com/v1/customers/<customer-tenant-id>/qualifications HTTP/1.1
Accept: application/json
Content-Type: application/json
MS-CorrelationId: 7d2456fd-2d79-46d0-9f8e-5d7ecd5f8745
MS-RequestId: 037db222-6d8e-4d7f-ba78-df3dca33fb68

// SOE
{
    "qualification": "StateOwnedEntity"
}

// Education
{
    "qualification": "Education",
    "educationSegment": "HigherEducation", // could also be "K12"
    "website": "contoso.edu"
}

// GCC
{
    "qualification": "GovernmentCommunityCloud",
    "validationCode": "123456"
}

Resposta REST

Se bem-sucedido, esse método retorna um objeto de qualificações no corpo da resposta. A seguir está um exemplo da chamada POST em um cliente (com uma qualificação anterior de Nenhum) com a qualificação de Educação.

Códigos de êxito e de erro de resposta

Cada resposta vem com um código de status HTTP que indica sucesso ou falha e outras informações de depuração. Use uma ferramenta de rastreamento de rede para ler esse código, o tipo de erro e os parâmetros adicionais. Para obter a lista completa, confira Códigos de Erro.

Exemplo de resposta

HTTP/1.1 201 CREATED
Content-Length: 29
Content-Type: application/json
MS-CorrelationId: 7d2456fd-2d79-46d0-9f8e-5d7ecd5f8745
MS-RequestId: 037db222-6d8e-4d7f-ba78-df3dca33fb68
{
    "qualification": "Education",
    "vettingStatus": "InReview",
    "vettingCreateDate": "2020-12-04T20:54:24Z" // UTC
}