Atualizar bookingAppointment
Namespace: microsoft.graph
Atualize as propriedades de um objeto bookingAppointment no bookingBusiness especificado.
Essa API está disponível nas seguintes implantações nacionais de nuvem.
Serviço global | Governo dos EUA L4 | GOVERNO DOS EUA L5 (DOD) | China operada pela 21Vianet |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
Permissões
Escolha a permissão ou as permissões marcadas como menos privilegiadas para essa API. Use uma permissão ou permissões privilegiadas mais altas somente se o aplicativo exigir. Para obter detalhes sobre permissões delegadas e de aplicativo, consulte Tipos de permissão. Para saber mais sobre essas permissões, consulte a referência de permissões.
Tipo de permissão | Permissões menos privilegiadas | Permissões privilegiadas mais altas |
---|---|---|
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 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 | Portador {código}. 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 mantêm seus valores anteriores ou são recalculadas com base em 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, denotado no formato ISO8601 . |
endDateTime | dateTimeTimeZone | A data, hora e fuso horário que o compromisso termina. |
filledAttendeesCount | Int32 | O número atual de clientes no compromisso. Obrigatório. |
isLocationOnline | Booliano | Se true , indicará que o compromisso será realizado online. O valor padrão é falso. |
maximumAttendeesCount | Int32 | O número máximo de clientes permitidos no compromisso. Obrigatório. |
optOutOfCustomerEmail | Booliano | Se true , indicará que o bookingCustomer para este compromisso não deseja receber uma confirmação para este compromisso. |
Postbuffer | Duração | O tempo de reserva após o término do compromisso, para limpeza, como exemplo. O valor é expresso no formato ISO8601 . |
Prebuffer | Duração | O tempo de reserva antes do compromisso começar, para preparação, como exemplo. O valor é expresso no formato ISO8601 . |
Preço | Duplo | O preço regular 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 cliente enviados para este compromisso. O valor dessa propriedade só está disponível ao ler este bookingAppointment por sua ID. |
selfServiceAppointmentId | Cadeia de caracteres | Uma ID de acompanhamento adicional para o compromisso, se o compromisso tiver sido criado diretamente pelo cliente na página de agendamento, em oposição a 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 associada a esse compromisso. |
serviceLocation | location | O local em que o serviço é entregue. |
serviceName | Cadeia de caracteres | O nome do bookingService associado a esse compromisso. Essa propriedade é opcional ao criar um novo compromisso. Se não for especificado, ele será computado do serviço associado ao compromisso pela propriedade serviceId . |
serviceNotes | Cadeia de caracteres | Anotações de um bookingStaffMember. O valor dessa propriedade só está disponível ao ler este bookingAppointment por sua ID. |
smsNotificationsEnabled | Booliano | Se true , indicar que as notificações por SMS serão enviadas aos clientes para o compromisso. O valor padrão é falso. |
staffMemberIds | String collection | A ID de cada bookingStaffMember que está agendada neste compromisso. |
startDateTime | dateTimeTimeZone | A data, hora e fuso horário que o compromisso começa. |
Observação
Se o número máximo de clientes (máximoAttedeesCount) permitido no serviço for maior que 1:
- Verifique se os clientes existem no Calendário de Reservas. Se não o fizerem, crie usando a operação Criar bookingCustomer .
- Passe IDs válidas do cliente 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 um dia.
PATCH https://graph.microsoft.com/v1.0/solutions/bookingBusinesses/Contosolunchdelivery@contoso.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
O exemplo a seguir mostra a resposta.
HTTP/1.1 204 No Content
Comentários
https://aka.ms/ContentUserFeedback.
Em breve: Ao longo de 2024, eliminaremos os problemas do GitHub como o mecanismo de comentários para conteúdo e o substituiremos por um novo sistema de comentários. Para obter mais informações, consulteEnviar e exibir comentários de