Type de ressource bookingAppointment
Espace de noms: microsoft.graph
Importante
Les API sous la version /beta dans Microsoft Graph sont susceptibles d’être modifiées. L’utilisation de ces API dans des applications de production n’est pas prise en charge. Pour déterminer si une API est disponible dans v1.0, utilisez le sélecteur Version .
Représente un rendez-vous client pour un service de réservation, effectué par un ensemble de membres du personnel, fourni par une entreprise Microsoft Bookings.
Méthodes
| Méthode | Type renvoyé | Description |
|---|---|---|
| List | collection bookingAppointment | Obtenez la liste des objets bookingAppointment dans le bookingbusiness spécifié. |
| Create | bookingAppointment | Créez un bookingAppointment pour le bookingbusiness spécifié. |
| Obtenir | bookingAppointment | Lisez les propriétés et les relations de l’objet bookingAppointment . |
| Mettre à jour | bookingAppointment | Mettre à jour un objet bookingAppointment . |
| Supprimer | Aucun | Supprimer un objet bookingAppointment . |
| Annuler un rendez-vous | Aucun | Annuler un objet bookingAppointment . |
Propriétés
| Propriété | Type | Description |
|---|---|---|
| additionalInformation | String | Informations supplémentaires envoyées au client lorsqu’un rendez-vous est confirmé. |
| anonymousJoinWebUrl | String | URL de la réunion à rejoindre anonymement. |
| appointmentLabel | String | L’utilisateur peut marquer une étiquette personnalisée sur le rendez-vous. |
| createdDateTime | DateTimeOffset | Date, heure et fuseau horaire de création du rendez-vous. |
| customerEmailAddress | String | Adresse SMTP du bookingCustomer qui réserve le rendez-vous. |
| customerId | String | ID du bookingCustomer pour ce rendez-vous. Si aucun ID n’est spécifié lors de la création d’un rendez-vous, un nouvel objet bookingCustomer est créé. Une fois défini, vous devez considérer le customerId immuable. |
| customerLocation | location | Représente les informations d’emplacement du bookingCustomer qui réserve le rendez-vous. |
| customerName | String | Nom du client. |
| customerNotes | String | Notes du client associé à ce rendez-vous. Vous pouvez obtenir la valeur uniquement lorsque vous lisez ce bookingAppointment par son ID. Vous ne pouvez définir cette propriété que lorsque vous créez initialement un rendez-vous avec un nouveau client. |
| customerPhone | String | Numéro de téléphone du client. |
| clientèle | collection bookingCustomerInformation | Collection des propriétés du client pour un rendez-vous. Un rendez-vous contient une liste d’informations client et chaque unité indique les propriétés d’un client qui fait partie de ce rendez-vous. Optional. |
| customerTimeZone | String | Fuseau horaire du client. Pour obtenir la liste des valeurs possibles, consultez dateTimeTimeZone. |
| durée | Durée | Longueur du rendez-vous, indiquée au format ISO8601 . |
| end | dateTimeTimeZone | Date, heure et fuseau horaire de fin du rendez-vous. |
| filledAttendeesCount | Int32 | Nombre actuel de clients dans le rendez-vous. |
| id | String | ID de bookingAppointment. En lecture seule. |
| invoiceAmount | Double | Montant facturé sur la facture. |
| invoiceDate | dateTimeTimeZone | Date, heure et fuseau horaire de la facture pour ce rendez-vous. |
| invoiceId | String | ID de la facture. |
| invoiceStatus | string | Status de la facture. Les valeurs possibles sont draft, reviewing, open, canceled, paid, corrective. |
| invoiceUrl | String | URL de la facture dans Microsoft Bookings. |
| isCustomerAllowedToManageBooking | Boolean | Indique que le client peut gérer les réservations créées par le personnel. La valeur par défaut est false. |
| isLocationOnline | Boolean | Indique que le rendez-vous est tenu en ligne. La valeur par défaut est false. |
| joinWebUrl | String | URL de la réunion en ligne pour le rendez-vous. |
| lastUpdatedDateTime | DateTimeOffset | Date, heure et fuseau horaire de la dernière mise à jour de l’activité de réservation. |
| maximumAttendeesCount | Int32 | Nombre maximal de clients autorisés dans un rendez-vous. Si maximumAttendeesCount du service est supérieur à 1, passez des ID client valides lors de la création ou de la mise à jour d’un rendez-vous. Pour créer un client, utilisez l’opération Créer bookingCustomer . |
| optOutOfCustomerEmail | Boolean | True indique que le bookingCustomer pour ce rendez-vous ne souhaite pas recevoir de confirmation pour ce rendez-vous. |
| postBuffer | Durée | Durée de réserve après la fin du rendez-vous, pour le nettoyage, par exemple. La valeur est exprimée au format ISO8601 . |
| preBuffer | Durée | Durée de réservation avant le début du rendez-vous, pour la préparation, par exemple. La valeur est exprimée au format ISO8601 . |
| prix | Double | Prix normal d’un rendez-vous pour le bookingService spécifié. |
| priceType | bookingPriceType | Paramètre permettant d’offrir une flexibilité pour la structure tarifaire des services. Les valeurs possibles sont les suivantes : undefined, fixedPrice, startingAt, hourly, free, priceVaries, callUs, notSet, unknownFutureValue. |
| Rappels | Collection bookingReminder | Collection de rappels clients envoyés pour ce rendez-vous. La valeur de cette propriété est disponible uniquement lors de la lecture de cet objet bookingAppointment par son ID. |
| selfServiceAppointmentId | String | Un autre ID de suivi pour le rendez-vous, si le rendez-vous a été créé directement par le client sur la page de planification, par opposition à un membre du personnel au nom du client. |
| serviceId | Chaîne | ID du bookingService associé à ce rendez-vous. |
| serviceLocation | location | Emplacement où le service est fourni. |
| serviceName | String | Nom du bookingService associé à ce rendez-vous. Cette propriété est facultative lors de la création d’un rendez-vous. S’il n’est pas spécifié, il est calculé à partir du service associé au rendez-vous par la propriété serviceId . |
| serviceNotes | String | Remarques d’un bookingStaffMember. La valeur de cette propriété est disponible uniquement lors de la lecture de cet objet bookingAppointment par son ID. |
| smsNotificationsEnabled | Boolean | True indique que les notifications SMS seront envoyées aux clients pour le rendez-vous. La valeur par défaut est false. |
| staffMemberIds | String collection | ID de chaque bookingStaffMember qui est planifié dans ce rendez-vous. |
| start | dateTimeTimeZone | Date, heure et fuseau horaire de début du rendez-vous. |
Relations
Aucun
Représentation JSON
La représentation JSON suivante montre le type de ressource.
{
"@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",
}