Atualizar bookingAppointment

Namespace: microsoft.graph

Atualize as propriedades de um objeto bookingAppointment no bookingBusiness especificado.

Permissões

Uma das seguintes permissões é obrigatória para chamar esta API. Para saber mais, incluindo como escolher permissões, confira Permissões.

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

Observação

Se você criar um aplicativo personalizado usando permissões de aplicativo, deverá seguir a validação de regras de negócios.

Solicitação HTTP

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

Cabeçalhos de solicitação

Nome Descrição
Autorização {code} do portador. Obrigatório.

Corpo da solicitação

No corpo da solicitação, forneça apenas os valores das propriedades que devem ser atualizadas. As propriedades existentes que não estão incluídas no corpo da solicitação manterão seus valores anteriores ou serão recalculadas com base nas alterações em outros valores de propriedade.

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

Propriedade Tipo Descrição
Clientes coleção bookingCustomerInformation Ele lista as propriedades do cliente para um compromisso. Um compromisso conterá uma lista de informações do cliente e cada unidade indicará 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, consulte dateTimeTimeZone.
duração Duração O comprimento do compromisso, indicado no formato ISO8601 .
endDateTime dateTimeTimeZone A data, a hora e o fuso horário em que o compromisso termina.
filledAttendeesCount Int32 O número atual de clientes no compromisso. Obrigatório.
isLocationOnline Booliano If true, indica que o compromisso será mantido online. O valor padrão é falso.
maximumAttendeesCount Int32 O número máximo de clientes permitidos no compromisso. Obrigatório.
optOutOfCustomerEmail Booliano If true, indica que o bookingCustomer para este compromisso não deseja receber uma confirmação para este compromisso.
Postbuffer Duração A quantidade de tempo a ser reservado após o término do compromisso, para limpeza, como exemplo. O valor é expresso no formato ISO8601 .
Prebuffer Duração A quantidade de tempo a ser reservado 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 configuraçã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 dessa propriedade está disponível somente ao ler este bookingAppointment por sua ID.
selfServiceAppointmentId String Uma ID de acompanhamento adicional para o compromisso, se o compromisso tiver sido criado diretamente pelo cliente na página de agendamento, em vez de um membro da equipe em nome do cliente. Só há suporte para compromisso se maxAttendeeCount for 1.
serviceId Cadeia de caracteres A ID do bookingService associado a este compromisso.
serviceLocation location O local onde o serviço é entregue.
serviceName String O nome do bookingService associado a este compromisso.
Essa propriedade é opcional ao criar um novo compromisso. Se não for especificado, ele será calculado do serviço associado ao compromisso pela propriedade serviceId .
serviceNotes Cadeia de caracteres Anotações de um bookingStaffMember. O valor dessa propriedade está disponível somente ao ler este bookingAppointment por sua ID.
smsNotificationsEnabled Booliano If true, indica que as notificações por SMS serão enviadas aos clientes para o compromisso. O valor padrão é falso.
staffMemberIds Coleção de cadeias de caracteres A ID de cada bookingStaffMember agendado neste compromisso.
startDateTime dateTimeTimeZone A data, a hora e o 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 maior que 1:

  • Verifique se os clientes existem no Calendário de Reserva. Caso contrário, crie usando a operação Criar bookingCustomer .
  • Passe as IDs de cliente válidas ao criar ou atualizar o compromisso. Se a ID do cliente não for válida, 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. Ele não retorna nada no corpo da resposta.

Exemplos

Solicitação

O exemplo a seguir altera a data do serviço por dia.

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

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

Resposta

Este é um exemplo de resposta.

HTTP/1.1 204 No Content