tipo de recurso bookingAppointment
Namespace: microsoft.graph
Representa um compromisso de cliente para um bookingService, realizado por um conjunto de docentes, 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 relações do objeto bookingAppointment . |
| Atualizar | bookingAppointment | Atualizar um objeto bookingAppointment . |
| Delete | Nenhum | Eliminar um objeto bookingAppointment . |
| Cancelar compromisso | Nenhum | Cancelar 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. |
| anonymousJoinWebUrl | Cadeia de caracteres | O URL da reunião para participar anonimamente. |
| appointmentLabel | Cadeia de caracteres | A etiqueta personalizada que pode ser carimbada neste compromisso pelos utilizadores. |
| createdDateTime | DateTimeOffset | A data, hora e fuso horário em que o compromisso foi criado. O tipo de carimbo de data/hora representa informações de data e hora com 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 reserva o compromisso. |
| customerName | Cadeia de caracteres | O nome do cliente. |
| customerNotes | Cadeia de caracteres | Notas do cliente associadas a este compromisso. Só pode obter o valor quando ler este bookingAppointment pelo respetivo ID. Só pode definir esta propriedade quando criar inicialmente um compromisso com um novo cliente. |
| customerPhone | Cadeia de caracteres | O número de telefone do cliente. |
| 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, veja dateTimeTimeZone. |
| duração | Duração | A duração do compromisso, indicada no formato ISO8601 . |
| end | dateTimeTimeZone | A data, hora e fuso horário quando o compromisso termina. |
| filledAttendeesCount | Int32 | O número atual de clientes no compromisso. |
| id | Cadeia de caracteres | O ID do bookingAppointment. Somente leitura. |
| isCustomerAllowedToManageBooking | Booliano | Indica que o cliente pode gerir as reservas criadas pela equipa. O valor padrão é false. |
| isLocationOnline | Booliano | Indica que o compromisso é realizado online. O valor padrão é false. |
| joinWebUrl | Cadeia de caracteres | O URL da reunião online para o compromisso. |
| lastUpdatedDateTime | DateTimeOffset | A data, hora e fuso horário em que o negócio de reservas foi atualizado pela última vez. O tipo de carimbo de data/hora representa informações de data e hora com 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 num compromisso. Se maximumAttendeesCount do serviço for superior a 1, transmita IDs de cliente válidos ao criar ou atualizar um compromisso. Para criar um cliente, utilize a operação Create bookingCustomer . |
| optOutOfCustomerEmail | Booliano | Se true indicar que o bookingCustomer para este compromisso não quer receber uma confirmação para este compromisso. |
| postBuffer | Duração | A quantidade de tempo a reservar após o fim do compromisso, para limpeza, como exemplo. O valor é expresso no formato ISO8601 . |
| preBuffer | Duração | A quantidade de tempo a reservar 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 definiçã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 desta propriedade só está disponível ao ler este bookingAppointment pelo respetivo ID. |
| selfServiceAppointmentId | Cadeia de caracteres | Outro ID de controlo para o compromisso, se o compromisso tiver sido criado diretamente pelo cliente na página de agendamento, em oposição a um membro da equipa em nome do cliente. |
| serviceId | Cadeia de caracteres | O ID do bookingService associado a este compromisso. |
| serviceLocation | location | A localização onde 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, é calculado a partir do serviço associado ao compromisso pela propriedade serviceId . |
| serviceNotes | Cadeia de caracteres | Notas de um bookingStaffMember. O valor desta propriedade só está disponível ao ler este bookingAppointment pelo respetivo ID. |
| smsNotificationsEnabled | Booliano | Se true, indicar que as notificações por SMS serão enviadas para os clientes para o compromisso. O valor padrão é false. |
| staffMemberIds | String collection | O ID de cada bookingStaffMember que está agendado para este compromisso. |
| iniciar | dateTimeTimeZone | A data, hora e fuso horário em que o compromisso começa. |
Relações
Nenhum
Representação JSON
A representação JSON seguinte 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"}
}