tipo de recurso bookingAppointment
Namespace: microsoft.graph
Importante
As APIs na versão /beta no Microsoft Graph estão sujeitas a alterações. Não há suporte para o uso dessas APIs em aplicativos de produção. Para determinar se uma API está disponível na v1.0, use o seletor Versão.
Representa um compromisso de cliente para um bookingService, realizado por um conjunto de docentes, fornecido por uma empresa 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 | O utilizador pode carimbar uma etiqueta personalizada no compromisso. |
| createdDateTime | DateTimeOffset | A data, hora e fuso horário em que o compromisso foi criado. |
| customerEmailAddress | Cadeia de caracteres | O endereço SMTP do bookingCustomer que reserva o compromisso. |
| customerId | Cadeia de caracteres | O ID do bookingCustomer para este compromisso. Se não for especificado nenhum ID quando é criado um compromisso, é criado um novo objeto bookingCustomer . Uma vez definido, deve considerar o customerId imutável. |
| customerLocation | location | Representa informações de localização para o 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 das propriedades do cliente para um compromisso. Um compromisso irá 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, veja dateTimeTimeZone. |
| duração | Duração | A duração do compromisso, indicada no formato ISO8601 . |
| end | dateTimeTimeZone | A data, hora e fuso horário em que o compromisso termina. |
| filledAttendeesCount | Int32 | O número atual de clientes no compromisso. |
| id | Cadeia de caracteres | O ID do bookingAppointment. Somente leitura. |
| invoiceAmount | Duplo | O valor faturado na fatura. |
| invoiceDate | dateTimeTimeZone | A data, hora e fuso horário da fatura para este compromisso. |
| invoiceId | Cadeia de caracteres | O ID da fatura. |
| invoiceStatus | string | O status da fatura. Os possíveis valores são: draft, reviewing, open, canceled, paid, corrective. |
| invoiceUrl | Cadeia de caracteres | O URL da fatura em Microsoft Bookings. |
| 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. |
| 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 | True indica 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 | True indica que as notificações por SMS serão enviadas para os clientes para o compromisso. O valor padrão é falso. |
| staffMemberIds | Coleção de cadeias de caracteres | O ID de cada bookingStaffMember que está agendado para este compromisso. |
| iniciar | dateTimeTimeZone | A data, hora e fuso horário em que o compromisso é iniciado. |
Relações
Nenhum
Representação JSON
A representação JSON seguinte mostra o tipo de recurso.
{
"@odata.type": "#microsoft.graph.bookingAppointment",
"id": "String (identifier)",
"createdDateTime": "String (timestamp)",
"lastUpdatedDateTime": "String (timestamp)",
"selfServiceAppointmentId": "String",
"additionalInformation": "String",
"appointmentLabel": "String",
"isLocationOnline": "Boolean",
"joinWebUrl": "String",
"smsNotificationsEnabled": "Boolean",
"customerId": "String",
"customerName": "String",
"customerEmailAddress": "String",
"customerPhone": "String",
"customerLocation": {
"@odata.type": "microsoft.graph.location"
},
"customerTimeZone": "String",
"customerNotes": "String",
"serviceId": "String",
"serviceName": "String",
"start": {
"@odata.type": "microsoft.graph.dateTimeTimeZone"
},
"end": {
"@odata.type": "microsoft.graph.dateTimeTimeZone"
},
"duration": "String (duration)",
"preBuffer": "String (duration)",
"postBuffer": "String (duration)",
"serviceLocation": {
"@odata.type": "microsoft.graph.location"
},
"priceType": "String",
"price": "Double",
"serviceNotes": "String",
"reminders": [
{
"@odata.type": "microsoft.graph.bookingReminder"
}
],
"optOutOfCustomerEmail": "Boolean",
"anonymousJoinWebUrl": "String",
"customers": [
{
"@odata.type": "microsoft.graph.bookingCustomerInformation"
}
],
"maximumAttendeesCount": "Int32",
"filledAttendeesCount": "Int32",
"staffMemberIds": [
"String"
],
"invoiceAmount": "Double",
"invoiceDate": {
"@odata.type": "microsoft.graph.dateTimeTimeZone"
},
"invoiceId": "String",
"invoiceStatus": "String",
"invoiceUrl": "String",
"isCustomerAllowedToManageBooking": "Boolean",
}