tipo de recurso bookingAppointment

Namespace: microsoft.graph

Representa um compromisso do cliente para um bookingService, executado por um conjunto de membros da equipe, fornecido por uma empresa do Microsoft Bookings.

Métodos

Método Tipo de retorno Descrição
List coleção bookingAppointment Obtenha uma lista de objetos bookingAppointment no bookingBusiness especificado.
Create bookingAppointment Crie um novo bookingAppointment para o bookingBusiness especificado.
Get bookingAppointment Leia as propriedades e os relacionamentos do objeto bookingAppointment .
Atualizar bookingAppointment Atualizar um objeto bookingAppointment .
Delete Nenhum Exclua um objeto bookingAppointment .
Cancelar compromisso Nenhum Cancele um objeto bookingAppointment .

Propriedades

Propriedade Tipo Descrição
Informações adicionais Cadeia de caracteres Informações adicionais que são enviadas ao cliente quando um compromisso é confirmado.
anonymousJoinWebUrl Cadeia de caracteres A URL da reunião para ingressar anonimamente.
appointmentLabel Cadeia de caracteres O rótulo personalizado que pode ser carimbado neste compromisso pelos usuários.
createdDateTime DateTimeOffset A data, a hora e o fuso horário em que o compromisso foi criado. O tipo de carimbo de data/hora representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
customerEmailAddress Cadeia de caracteres O endereço SMTP do bookingCustomer que marca o compromisso.
customerName Cadeia de caracteres O nome do cliente.
Notas do cliente Cadeia de caracteres Notas do cliente associadas a este compromisso. Você pode obter o valor somente ao ler este bookingAppointment por seu ID. Você pode definir essa propriedade somente quando cria inicialmente um compromisso com um novo cliente.
customerPhone Cadeia de caracteres O número de telefone do cliente.
clientes bookingCustomerColeta de informações Uma coleção de propriedades do cliente para um compromisso. Um compromisso contém 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 A duração do compromisso, indicada em formato ISO8601 .
end 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.
id Cadeia de caracteres A ID do bookingAppointment. Somente leitura.
isCustomerAllowedToManageBooking Booliano Indica que o cliente pode gerenciar reservas criadas pela equipe. O valor padrão é false.
isLocationOnline Booliano Indica que o compromisso é realizado online. O valor padrão é false.
joinWebUrl Cadeia de caracteres A URL da reunião online para o compromisso.
lastUpdatedDateTime DateTimeOffset A data, hora e fuso horário em que a empresa de reservas foi atualizada pela última vez. O tipo de carimbo de data/hora representa informações de data e hora usando o formato ISO 8601 e está sempre em UTC. Por exemplo, meia-noite UTC em 1 de janeiro de 2014 é 2014-01-01T00:00:00Z.
maximumAttendeesCount Int32 O número máximo de clientes permitidos em um compromisso. Se maximumAttendeesCount do serviço for maior que 1, passe IDs de cliente válidas ao criar ou atualizar um compromisso. Para criar um cliente, use a operação Criar bookingCustomer .
optOutOfCustomerEmail Booliano Se 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 para reservar após o término da consulta, para limpeza, por exemplo. O valor é expresso em formato ISO8601 .
preBuffer Duração A quantidade de tempo a reservar antes do início da consulta, para preparação, por exemplo. O valor é expresso em 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, hourlyfree, priceVaries, , callUs, , notSet, . unknownFutureValue
Lembretes Coleção bookingReminder A coleção de lembretes de clientes enviados para este compromisso. O valor desta propriedade está disponível apenas ao ler este bookingAppointment pelo seu ID.
selfServiceAppointmentId Cadeia de caracteres Outra ID de rastreamento para o compromisso, se o compromisso foi criado diretamente pelo cliente na página de agendamento, em vez de por um membro da equipe em nome do cliente.
serviceId Cadeia de caracteres A ID do bookingService associado a este compromisso.
serviceLocation location O local em que 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, ele será calculado a partir do serviço associado ao compromisso pela propriedade serviceId .
serviceNotes Cadeia de caracteres Notas de um bookingStaffMember. O valor desta propriedade está disponível apenas ao ler este bookingAppointment pelo seu ID.
smsNotificationsEnabled Booliano Se true, indica que as notificações por SMS serão enviadas aos clientes para o compromisso. O valor padrão é false.
staffMemberIds String collection A ID de cada bookingStaffMember agendado neste compromisso.
iniciar dateTimeTimeZone A data, a hora e o fuso horário em que o compromisso começa.

Relações

Nenhum

Representação JSON

A representação JSON a seguir mostra o tipo de recurso.

{
  "@odata.type": "#microsoft.graph.bookingAppointment",
  "additionalInformation": "String",
  "anonymousJoinWebUrl": "String",
  "appointmentLabel": "String",
  "createdDateTime": "String (timestamp)",
  "customerEmailAddress": "String",
  "customerName": "String",
  "customerNotes": "String",
  "customerPhone": "String",
  "customers": [{"@odata.type": "microsoft.graph.bookingCustomerInformation"}],
  "customerTimeZone": "String",
  "duration": "String (duration)",
  "end": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "filledAttendeesCount": "Int32",
  "id": "String (identifier)",
  "isCustomerAllowedToManageBooking": "Boolean",
  "isLocationOnline": "Boolean",
  "joinWebUrl": "String",
  "lastUpdatedDateTime": "String (timestamp)",
  "maximumAttendeesCount": "Int32",
  "optOutOfCustomerEmail": "Boolean",
  "postBuffer": "String (duration)",
  "preBuffer": "String (duration)",
  "price": "Double",
  "priceType": "String",
  "reminders": [{"@odata.type": "microsoft.graph.bookingReminder"}],
  "selfServiceAppointmentId": "String",
  "serviceId": "String",
  "serviceLocation": {"@odata.type": "microsoft.graph.location"},
  "serviceName": "String",
  "serviceNotes": "String",
  "smsNotificationsEnabled": "Boolean",
  "staffMemberIds": ["String"],
  "start": {"@odata.type": "microsoft.graph.dateTimeTimeZone"}
}