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 um Microsoft Bookings negócios.

Observação

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

Métodos

Método	Tipo de retorno	Descrição
Listar compromissos	coleção bookingAppointment	Obtenha uma lista de objetos bookingAppointment no bookingbusiness especificado.
Criar bookingAppointment	bookingAppointment	Crie um novo bookingAppointment para o bookingbusiness especificado.
Obter bookingAppointment	bookingAppointment	Leia as propriedades e as relações do objeto bookingAppointment .
Atualização	bookingAppointment	Atualize um objeto bookingAppointment .
Delete	Nenhum	Exclua um objeto bookingAppointment .
Cancel	Nenhum	Cancele um objeto bookingAppointment .

Propriedades

Propriedade	Tipo	Descrição
additionalInformation	Cadeia de caracteres	Informações adicionais que são enviadas ao cliente quando um compromisso é confirmado.
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
id	String	A ID do bookingAppointment. Somente leitura.
isLocationOnline	Booliano	If true, indica que o compromisso será mantido online. O valor padrão é false.
joinWebUrl	Cadeia de caracteres	A URL da reunião online para o compromisso.
maximumAttendeesCount	Int32	O número máximo de clientes permitidos em um compromisso. Se maximumAttendeesCount do serviço for maior que 1, passe as 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 indicar 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	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 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	Cadeia de caracteres	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 é false.
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.

Relações

Nenhum

Representação JSON

Veja a seguir uma representação JSON do recurso.

{
  "customers": [
    {
      "@odata.type": "microsoft.graph.bookingCustomerInformation"
    }
  ],
  "duration": "String (timestamp)",
  "endDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "id": "String (identifier)",
  "isLocationOnline": "Boolean",
  "joinWebUrl": "String",
  "optOutOfCustomerEmail": "Boolean",
  "postBuffer": "String (timestamp)",
  "preBuffer": "String (timestamp)",
  "price": "Integer",
  "priceType": {"@odata.type": "microsoft.graph.bookingPriceType"},
  "reminders": [{"@odata.type": "microsoft.graph.bookingReminder"}],
  "selfServiceAppointmentId": "String",
  "serviceId": "String",
  "serviceLocation": {"@odata.type": "microsoft.graph.location"},
  "serviceName": "String",
  "serviceNotes": "String",
  "smsNotificationsEnabled": "Boolean",
  "staffMemberIds": ["String"],
  "startDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "maximumAttendeesCount": "Integer",
  "filledAttendeesCount": "Integer"
}