tipo de recurso bookingAppointment
Espacio de nombres: microsoft.graph
Importante
Las API de la versión /beta de Microsoft Graph están sujetas a cambios. No se admite el uso de estas API en aplicaciones de producción. Para determinar si una API está disponible en la versión 1.0, use el selector de Versión.
Representa una cita de cliente para un bookingService, realizada por un conjunto de miembros del personal, proporcionada por una empresa Microsoft Bookings.
Métodos
| Método | Tipo de valor devuelto | Descripción |
|---|---|---|
| List | bookingAppointment collection | Obtenga una lista de objetos bookingAppointment en el bookingbusiness especificado. |
| Crear | bookingAppointment | Cree un nuevo bookingAppointment para el bookingbusiness especificado. |
| Get | bookingAppointment | Lea las propiedades y relaciones del objeto bookingAppointment . |
| Actualizar | bookingAppointment | Actualice un objeto bookingAppointment . |
| Delete | Ninguno | Eliminar un objeto bookingAppointment . |
| Cancelación de una cita | Ninguno | Cancelar un objeto bookingAppointment . |
Propiedades
| Propiedad | Tipo | Descripción |
|---|---|---|
| additionalInformation | Cadena | Información adicional que se envía al cliente cuando se confirma una cita. |
| anonymousJoinWebUrl | Cadena | Dirección URL de la reunión a la que se va a unirse de forma anónima. |
| appointmentLabel | Cadena | El usuario puede marcar una etiqueta personalizada en la cita. |
| createdDateTime | DateTimeOffset | Fecha, hora y zona horaria en que se creó la cita. |
| customerEmailAddress | Cadena | La dirección SMTP de bookingCustomer que reserva la cita. |
| customerId | Cadena | El identificador de bookingCustomer para esta cita. Si no se especifica ningún identificador cuando se crea una cita, se crea un nuevo objeto bookingCustomer . Una vez establecido, debe considerar que customerId es inmutable. |
| customerLocation | location | Representa la información de ubicación del bookingCustomer que está reservando la cita. |
| customerName | Cadena | Nombre del cliente. |
| customerNotes | Cadena | Notas del cliente asociado a esta cita. Solo puede obtener el valor cuando lea esta bookingAppointment por su identificador. Esta propiedad solo se puede establecer cuando se crea inicialmente una cita con un nuevo cliente. |
| customerPhone | Cadena | El número de teléfono del cliente. |
| clientela | bookingCustomerInformation collection | Colección de las propiedades del cliente para una cita. Una cita contendrá una lista de información del cliente y cada unidad indicará las propiedades de un cliente que forma parte de esa cita. Opcional. |
| customerTimeZone | Cadena | Zona horaria del cliente. Para obtener una lista de los valores posibles, vea dateTimeTimeZone. |
| duration | Duración | Longitud de la cita, indicada en formato ISO8601 . |
| end | dateTimeTimeZone | Fecha, hora y zona horaria que finaliza la cita. |
| filledAttendeesCount | Int32 | Número actual de clientes en la cita. |
| id | Cadena | Identificador del bookingAppointment. Solo lectura. |
| invoiceAmount | Doble | Importe facturado en la factura. |
| invoiceDate | dateTimeTimeZone | Fecha, hora y zona horaria de la factura de esta cita. |
| invoiceId | Cadena | Identificador de la factura. |
| invoiceStatus | string | Estado de la factura. Los valores posibles son: draft, reviewing, open, canceled, paid, corrective. |
| invoiceUrl | Cadena | Dirección URL de la factura en Microsoft Bookings. |
| isCustomerAllowedToManageBooking | Booleano | Indica que el cliente puede administrar las reservas creadas por el personal. El valor predeterminado es false. |
| isLocationOnline | Booleano | Indica que la cita se mantiene en línea. El valor predeterminado es false. |
| joinWebUrl | Cadena | Dirección URL de la reunión en línea de la cita. |
| lastUpdatedDateTime | DateTimeOffset | Fecha, hora y zona horaria en que se actualizó por última vez la empresa de reserva. |
| maximumAttendeesCount | Int32 | Número máximo de clientes permitidos en una cita. Si maximumAttendeesCount del servicio es mayor que 1, pase los identificadores de cliente válidos al crear o actualizar una cita. Para crear un cliente, use la operación Crear bookingCustomer . |
| optOutOfCustomerEmail | Booleano | True indica que bookingCustomer para esta cita no desea recibir una confirmación para esta cita. |
| postBuffer | Duración | Cantidad de tiempo que se reserva una vez finalizada la cita, para limpiar, por ejemplo. El valor se expresa en formato ISO8601 . |
| preBuffer | Duración | La cantidad de tiempo que se debe reservar antes de que comience la cita, para su preparación, como ejemplo. El valor se expresa en formato ISO8601 . |
| precio | Doble | Precio normal de una cita para el bookingService especificado. |
| priceType | bookingPriceType | Una configuración para proporcionar flexibilidad para la estructura de precios de los servicios. Los valores posibles son: undefined, fixedPrice, startingAt, hourly, free, priceVaries, callUs, notSet y unknownFutureValue. |
| Recordatorios | bookingReminder collection | Colección de recordatorios de clientes enviados para esta cita. El valor de esta propiedad solo está disponible al leer esta reservaAppointment por su identificador. |
| selfServiceAppointmentId | Cadena | Otro identificador de seguimiento para la cita, si el cliente creó la cita directamente en la página de programación, en lugar de un miembro del personal en nombre del cliente. |
| serviceId | Cadena | Identificador del bookingService asociado a esta cita. |
| serviceLocation | location | Ubicación donde se entrega el servicio. |
| serviceName | Cadena | Nombre del bookingService asociado a esta cita. Esta propiedad es opcional al crear una nueva cita. Si no se especifica, se calcula a partir del servicio asociado a la cita mediante la propiedad serviceId . |
| serviceNotes | Cadena | Notas de un bookingStaffMember. El valor de esta propiedad solo está disponible al leer esta reservaAppointment por su identificador. |
| smsNotificationsEnabled | Booleano | True indica que se enviarán notificaciones SMS a los clientes para la cita. El valor predeterminado es false. |
| staffMemberIds | Colección string | El identificador de cada bookingStaffMember que está programado en esta cita. |
| start | dateTimeTimeZone | Fecha, hora y zona horaria a la que comienza la cita. |
Relaciones
Ninguno
Representación JSON
La siguiente representación JSON muestra el 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",
}