Atualizar bookingAppointment

  • Artigo

Namespace: microsoft.graph

Atualize as propriedades de um objeto bookingAppointment no bookingBusiness especificado.

Esta API está disponível nas seguintes implementações de cloud nacionais.

Serviço global US Government L4 US Government L5 (DOD) China operada pela 21Vianet
✅ ✅ ✅ ❌

Permissões

Escolha a permissão ou permissões marcadas como menos privilegiadas para esta API. Utilize uma permissão ou permissões com privilégios mais elevados apenas se a sua aplicação o exigir. Para obter detalhes sobre as permissões delegadas e de aplicação, veja Tipos de permissão. Para saber mais sobre estas permissões, veja a referência de permissões.

Tipo de permissão Permissões com menos privilégios Permissões com privilégios superiores
Delegado (conta corporativa ou de estudante) BookingsAppointment.ReadWrite.All Bookings. Manage.All, Bookings. ReadWrite.All
Delegado (conta pessoal da Microsoft) Sem suporte. Sem suporte.
Application BookingsAppointment.ReadWrite.All Bookings. Manage.All, Bookings. Read.All, Bookings. ReadWrite.All

Observação

Se criar uma aplicação personalizada com permissões de aplicação, tem de seguir a validação de Regras de negócio.

Solicitação HTTP

PATCH /solutions/bookingBusinesses/{id}/appointments/{id}

Cabeçalhos de solicitação

Nome Descrição
Autorização Portador {código}. Obrigatório.

Corpo da solicitação

No corpo do pedido, forneça apenas os valores das propriedades a atualizar. As propriedades existentes que não estão incluídas no corpo do pedido mantêm os valores anteriores ou são recalculadas com base em alterações a outros valores de propriedade.

A tabela a seguir especifica as propriedades que podem ser atualizadas.

Propriedade Tipo Descrição
customerEmailAddress Cadeia de caracteres O endereço SMTP do bookingCustomer que reserva o compromisso.
customerName Cadeia de caracteres O nome do cliente.
customerNotes Cadeia de caracteres Notas do cliente associadas a este compromisso. Só pode obter o valor quando ler este bookingAppointment pelo respetivo ID. Só pode definir esta propriedade quando criar inicialmente um compromisso com um novo cliente.
customerPhone Cadeia de caracteres O número de telefone do cliente.
clientes coleção bookingCustomerInformation Apresenta uma lista das propriedades do cliente para um compromisso. Um compromisso contém uma lista de informações do cliente e cada unidade indica as propriedades de um cliente que faz parte desse compromisso. Opcional.
customerTimeZone Cadeia de caracteres O fuso horário do cliente. Para obter uma lista de valores possíveis, veja dateTimeTimeZone.
duração Duração A duração do compromisso, indicada no formato ISO8601 .
end dateTimeTimeZone A data, hora e fuso horário em que o compromisso termina.
invoiceStatus string O status da fatura. Os valores possíveis são: draft, , reviewingopen, canceled, , paide corrective.
isCustomerAllowedToManageBooking Booliano Indica que o cliente pode gerir as reservas criadas pela equipa. O valor padrão é false.
filledAttendeesCount Int32 O número atual de clientes no compromisso. Obrigatório.
isLocationOnline Booliano True indica que o compromisso é realizado online. O valor padrão é false.
maximumAttendeesCount Int32 O número máximo de clientes permitido no compromisso. Obrigatório.
optOutOfCustomerEmail Booliano True indica que o bookingCustomer para este compromisso não quer receber uma confirmação para este compromisso.
postBuffer Duração A quantidade de tempo a reservar após o fim do compromisso, para limpeza, como exemplo. O valor é expresso no formato ISO8601 .
preBuffer Duração A quantidade de tempo a reservar antes do início do compromisso, para preparação, como exemplo. O valor é expresso no formato ISO8601 .
preço Duplo O preço normal de um compromisso para o bookingService especificado.
priceType bookingPriceType Uma definição para fornecer flexibilidade para a estrutura de preços dos serviços. Os valores possíveis são: undefined, fixedPrice, startingAt, hourly, free, priceVaries, callUs, notSet, unknownFutureValue.
lembretes coleção bookingReminder A coleção de lembretes de clientes enviados para este compromisso. O valor desta propriedade só está disponível ao ler este bookingAppointment pelo respetivo ID.
selfServiceAppointmentId Cadeia de caracteres Outro ID de controlo para o compromisso, se o compromisso tiver sido criado diretamente pelo cliente na página de agendamento, em oposição a um membro da equipa em nome do cliente.
serviceId Cadeia de caracteres O ID do bookingService associado a este compromisso.
serviceLocation location A localização onde o serviço é entregue.
serviceName Cadeia de caracteres O nome do bookingService associado a este compromisso.
Esta propriedade é opcional ao criar um novo compromisso. Se não for especificado, é calculado a partir do serviço associado ao compromisso pela propriedade serviceId .
serviceNotes Cadeia de caracteres Notas de um bookingStaffMember. O valor desta propriedade só está disponível ao ler este bookingAppointment pelo respetivo ID.
smsNotificationsEnabled Booliano True indica que as notificações por SMS são enviadas aos clientes para o compromisso. O valor padrão é false.
staffMemberIds Coleção String O ID de cada bookingStaffMember que está agendado para este compromisso.
iniciar dateTimeTimeZone A data, hora e fuso horário em que o compromisso começa.

Observação

Se o número máximo de clientes (maximumAttedeesCount) permitido no serviço for superior a 1:

  • Certifique-se de que os clientes existem no Calendário do Booking. Se não o fizerem, crie com a operação Create bookingCustomer .
  • Transmita IDs de cliente válidos quando cria ou atualiza o compromisso. Se o ID do cliente for inválido, esse cliente não será incluído no objeto de compromisso.

Resposta

Se tiver êxito, este método retornará um código de resposta 204 No Content. Não devolve nada no corpo da resposta.

Exemplos

Solicitação

O exemplo seguinte altera a data de serviço por dia.

PATCH https://graph.microsoft.com/v1.0/solutions/bookingBusinesses/Contosolunchdelivery@contoso.com/appointments/AAMkADKnAAA=
Content-type: application/json

{
    "@odata.type":"#microsoft.graph.bookingAppointment",
    "end":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-06T12:30:00.0000000+00:00",
        "timeZone":"UTC"
    },
    "start":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-06T12:00:00.0000000+00:00",
        "timeZone":"UTC"
    }
}

Resposta

O exemplo a seguir mostra a resposta.

HTTP/1.1 204 No Content