tipo de recurso bookingAppointment

  • Artigo

Namespace: microsoft.graph

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

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 uma nova reservaAppointment para o bookingbusiness especificado.
Obter bookingAppointment bookingAppointment Leia as propriedades e as relações do objeto bookingAppointment .
Atualizar Nenhum(a) Atualize um objeto bookingAppointment .
Delete Nenhum Excluir um objeto bookingAppointment .
Cancel Nenhum Cancelar 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 a ser ingressado anonimamente.
Clientes coleção bookingCustomerInformation 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 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
id Cadeia de caracteres A ID do bookingAppointment. Somente leitura.
isLocationOnline Booliano Se true, indicará que o compromisso será realizado 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 IDs válidas do cliente durante a criação ou atualização de 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 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á calculado a partir 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 é false.
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.

Relações

Nenhum

Representação JSON

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

{
  "additionalInformation": "String",
  "anonymousJoinWebUrl": "String",
  "customers": [
    {
      "@odata.type": "microsoft.graph.bookingCustomerInformation"
    }
  ],
  "duration": "String (timestamp)",
  "endDateTime": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "filledAttendeesCount": "Int32",
  "id": "String (identifier)",
  "isLocationOnline": "Boolean",
  "joinWebUrl": "String",
  "maximumAttendeesCount": "Int32",
  "optOutOfCustomerEmail": "Boolean",
  "postBuffer": "String (timestamp)",
  "preBuffer": "String (timestamp)",
  "price": "Double",
  "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"}
}