Mettre à jour 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 .

Mettez à jour les propriétés d’un objet bookingAppointment dans le bookingBusiness spécifié.

Cette API est disponible dans les déploiements de cloud national suivants.

Service global	Gouvernement des États-Unis L4	Us Government L5 (DOD)	Chine gérée par 21Vianet
✅	✅	✅	❌

Autorisations

Choisissez l’autorisation ou les autorisations marquées comme moins privilégiées pour cette API. Utilisez une autorisation ou des autorisations privilégiées plus élevées uniquement si votre application en a besoin. Pour plus d’informations sur les autorisations déléguées et d’application, consultez Types d’autorisations. Pour en savoir plus sur ces autorisations, consultez les informations de référence sur les autorisations.

Type d’autorisation	Autorisations avec privilèges minimum	Autorisations privilégiées plus élevées
Déléguée (compte professionnel ou scolaire)	BookingsAppointment.ReadWrite.All	Bookings. Manage.All, Bookings. ReadWrite.All
Déléguée (compte Microsoft personnel)	Non prise en charge.	Non prise en charge.
Application	BookingsAppointment.ReadWrite.All	Bookings. Manage.All, Bookings. Read.All, Bookings. ReadWrite.All

Remarque

Si vous créez une application personnalisée à l’aide d’autorisations d’application, vous devez suivre la validation des règles d’entreprise.

Requête HTTP

PATCH /solutions/bookingBusinesses/{id}/appointments/{id}

En-têtes de demande facultatifs

Nom	Description
Autorisation	Porteur {code}. Obligatoire.

Corps de la demande

Dans le corps de la demande, fournissez uniquement les valeurs des propriétés à mettre à jour. Les propriétés existantes qui ne sont pas incluses dans le corps de la demande conservent leurs valeurs précédentes ou sont recalculées en fonction des modifications apportées à d’autres valeurs de propriété.

Le tableau suivant spécifie les propriétés qui peuvent être mises à jour.

Propriété	Type	Description
customerEmailAddress	Chaîne	Adresse SMTP du bookingCustomer qui réserve le rendez-vous.
customerId	Chaîne	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	Chaîne	Nom du client.
customerNotes	Chaîne	Notes du client associé à ce rendez-vous. Vous pouvez obtenir la valeur uniquement lors de la lecture de ce bookingAppointment par son ID. Vous pouvez définir cette propriété uniquement lors de la création initiale d’un rendez-vous avec un nouveau client. Après ce point, la valeur est calculée à partir du client représenté par customerId.
customerPhone	Chaîne	Numéro de téléphone du client.
clientèle	collection bookingCustomerInformation	Il répertorie les 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	Chaîne	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.
invoiceAmount	Double	Montant facturé sur la facture.
invoiceDate	dateTimeTimeZone	Date, heure et fuseau horaire de la facture pour ce rendez-vous.
invoiceId	Chaîne	ID de la facture.
invoiceStatus	chaîne	Status de la facture. Les valeurs possibles sont , draftreviewing, open, canceledpaid, et corrective.
isCustomerAllowedToManageBooking	Valeur booléenne	Indique que le client peut gérer les réservations créées par le personnel. La valeur par défaut est false.
invoiceUrl	Chaîne	URL de la facture dans Microsoft Bookings.
filledAttendeesCount	Int32	Nombre actuel de clients dans le rendez-vous. Obligatoire.
isLocationOnline	Valeur booléenne	True indique que le rendez-vous est tenu en ligne. La valeur par défaut est false.
maximumAttendeesCount	Int32	Nombre maximal de clients autorisés dans le rendez-vous. Obligatoire.
optOutOfCustomerEmail	Valeur booléenne	True indique que le bookingCustomer de 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	Chaîne	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	Chaîne	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	Chaîne	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	Valeur booléenne	True indique que les notifications SMS seront envoyées aux clients pour le rendez-vous. La valeur par défaut est false.
staffMemberIds	Collection de chaînes	ID de chaque bookingStaffMember qui est planifié dans ce rendez-vous.
start	dateTimeTimeZone	Date, heure et fuseau horaire de début du rendez-vous.

Remarque

Si le nombre maximal de clients (maximumAttedeesCount) autorisé dans le service est supérieur à 1 :

• Assurez-vous que les clients existent dans le calendrier Booking. Si ce n’est pas le cas, créez à l’aide de l’opération Create bookingCustomer .
• Passez des ID client valides lorsque vous créez ou mettez à jour le rendez-vous. Si l’ID client n’est pas valide, ce client n’est pas inclus dans l’objet rendez-vous.

Réponse

Si elle réussit, cette méthode renvoie un code de réponse 204 No Content. Il ne retourne rien dans le corps de la réponse.

Exemple

Demande

L’exemple suivant modifie la date de service d’un jour et met à jour la date de facture.

HTTP

PATCH https://graph.microsoft.com/beta/solutions/bookingBusinesses/contosolunchdelivery@contoso.com/appointments/AAMkADKnAAA=
Content-type: application/json

{
    "@odata.type":"#microsoft.graph.bookingAppointment",
    "end":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-06T12:30:00.0000000+00:00",
        "timeZone":"UTC"
    },
    "invoiceDate":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-06T12:30:00.0000000+00:00",
        "timeZone":"UTC"
    },
    "start":{
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",
        "dateTime":"2018-05-06T12:00:00.0000000+00:00",
        "timeZone":"UTC"
    }
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new BookingAppointment
{
	OdataType = "#microsoft.graph.bookingAppointment",
	End = new DateTimeTimeZone
	{
		OdataType = "#microsoft.graph.dateTimeTimeZone",
		DateTime = "2018-05-06T12:30:00.0000000+00:00",
		TimeZone = "UTC",
	},
	InvoiceDate = new DateTimeTimeZone
	{
		OdataType = "#microsoft.graph.dateTimeTimeZone",
		DateTime = "2018-05-06T12:30:00.0000000+00:00",
		TimeZone = "UTC",
	},
	Start = new DateTimeTimeZone
	{
		OdataType = "#microsoft.graph.dateTimeTimeZone",
		DateTime = "2018-05-06T12:00:00.0000000+00:00",
		TimeZone = "UTC",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Solutions.BookingBusinesses["{bookingBusiness-id}"].Appointments["{bookingAppointment-id}"].PatchAsync(requestBody);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

CLI

mgc-beta solutions booking-businesses appointments patch --booking-business-id {bookingBusiness-id} --booking-appointment-id {bookingAppointment-id} --body '{\
    "@odata.type":"#microsoft.graph.bookingAppointment",\
    "end":{\
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",\
        "dateTime":"2018-05-06T12:30:00.0000000+00:00",\
        "timeZone":"UTC"\
    },\
    "invoiceDate":{\
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",\
        "dateTime":"2018-05-06T12:30:00.0000000+00:00",\
        "timeZone":"UTC"\
    },\
    "start":{\
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",\
        "dateTime":"2018-05-06T12:00:00.0000000+00:00",\
        "timeZone":"UTC"\
    }\
}\
'

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Go

// Code snippets are only available for the latest major version. Current major version is $v0.*

// Dependencies
import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

requestBody := graphmodels.NewBookingAppointment()
end := graphmodels.NewDateTimeTimeZone()
dateTime := "2018-05-06T12:30:00.0000000+00:00"
end.SetDateTime(&dateTime) 
timeZone := "UTC"
end.SetTimeZone(&timeZone) 
requestBody.SetEnd(end)
invoiceDate := graphmodels.NewDateTimeTimeZone()
dateTime := "2018-05-06T12:30:00.0000000+00:00"
invoiceDate.SetDateTime(&dateTime) 
timeZone := "UTC"
invoiceDate.SetTimeZone(&timeZone) 
requestBody.SetInvoiceDate(invoiceDate)
start := graphmodels.NewDateTimeTimeZone()
dateTime := "2018-05-06T12:00:00.0000000+00:00"
start.SetDateTime(&dateTime) 
timeZone := "UTC"
start.SetTimeZone(&timeZone) 
requestBody.SetStart(start)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
appointments, err := graphClient.Solutions().BookingBusinesses().ByBookingBusinessId("bookingBusiness-id").Appointments().ByBookingAppointmentId("bookingAppointment-id").Patch(context.Background(), requestBody, nil)

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

BookingAppointment bookingAppointment = new BookingAppointment();
bookingAppointment.setOdataType("#microsoft.graph.bookingAppointment");
DateTimeTimeZone end = new DateTimeTimeZone();
end.setOdataType("#microsoft.graph.dateTimeTimeZone");
end.setDateTime("2018-05-06T12:30:00.0000000+00:00");
end.setTimeZone("UTC");
bookingAppointment.setEnd(end);
DateTimeTimeZone invoiceDate = new DateTimeTimeZone();
invoiceDate.setOdataType("#microsoft.graph.dateTimeTimeZone");
invoiceDate.setDateTime("2018-05-06T12:30:00.0000000+00:00");
invoiceDate.setTimeZone("UTC");
bookingAppointment.setInvoiceDate(invoiceDate);
DateTimeTimeZone start = new DateTimeTimeZone();
start.setOdataType("#microsoft.graph.dateTimeTimeZone");
start.setDateTime("2018-05-06T12:00:00.0000000+00:00");
start.setTimeZone("UTC");
bookingAppointment.setStart(start);
BookingAppointment result = graphClient.solutions().bookingBusinesses().byBookingBusinessId("{bookingBusiness-id}").appointments().byBookingAppointmentId("{bookingAppointment-id}").patch(bookingAppointment);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const bookingAppointment = {
    '@odata.type':'#microsoft.graph.bookingAppointment',
    end: {
        '@odata.type':'#microsoft.graph.dateTimeTimeZone',
        dateTime: '2018-05-06T12:30:00.0000000+00:00',
        timeZone: 'UTC'
    },
    invoiceDate: {
        '@odata.type':'#microsoft.graph.dateTimeTimeZone',
        dateTime: '2018-05-06T12:30:00.0000000+00:00',
        timeZone: 'UTC'
    },
    start: {
        '@odata.type':'#microsoft.graph.dateTimeTimeZone',
        dateTime: '2018-05-06T12:00:00.0000000+00:00',
        timeZone: 'UTC'
    }
};

await client.api('/solutions/bookingBusinesses/contosolunchdelivery@contoso.com/appointments/AAMkADKnAAA=')
	.version('beta')
	.update(bookingAppointment);

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

PHP

<?php
use Microsoft\Graph\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\BookingAppointment;
use Microsoft\Graph\Beta\Generated\Models\DateTimeTimeZone;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new BookingAppointment();
$requestBody->setOdataType('#microsoft.graph.bookingAppointment');
$end = new DateTimeTimeZone();
$end->setOdataType('#microsoft.graph.dateTimeTimeZone');
$end->setDateTime('2018-05-06T12:30:00.0000000+00:00');
$end->setTimeZone('UTC');
$requestBody->setEnd($end);
$invoiceDate = new DateTimeTimeZone();
$invoiceDate->setOdataType('#microsoft.graph.dateTimeTimeZone');
$invoiceDate->setDateTime('2018-05-06T12:30:00.0000000+00:00');
$invoiceDate->setTimeZone('UTC');
$requestBody->setInvoiceDate($invoiceDate);
$start = new DateTimeTimeZone();
$start->setOdataType('#microsoft.graph.dateTimeTimeZone');
$start->setDateTime('2018-05-06T12:00:00.0000000+00:00');
$start->setTimeZone('UTC');
$requestBody->setStart($start);

$result = $graphServiceClient->solutions()->bookingBusinesses()->byBookingBusinessId('bookingBusiness-id')->appointments()->byBookingAppointmentId('bookingAppointment-id')->patch($requestBody)->wait();

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Python

# Code snippets are only available for the latest version. Current version is 1.x
from msgraph_beta import GraphServiceClient
from msgraph_beta.generated.models.booking_appointment import BookingAppointment
from msgraph_beta.generated.models.date_time_time_zone import DateTimeTimeZone
# To initialize your graph_client, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=python
request_body = BookingAppointment(
	odata_type = "#microsoft.graph.bookingAppointment",
	end = DateTimeTimeZone(
		odata_type = "#microsoft.graph.dateTimeTimeZone",
		date_time = "2018-05-06T12:30:00.0000000+00:00",
		time_zone = "UTC",
	),
	invoice_date = DateTimeTimeZone(
		odata_type = "#microsoft.graph.dateTimeTimeZone",
		date_time = "2018-05-06T12:30:00.0000000+00:00",
		time_zone = "UTC",
	),
	start = DateTimeTimeZone(
		odata_type = "#microsoft.graph.dateTimeTimeZone",
		date_time = "2018-05-06T12:00:00.0000000+00:00",
		time_zone = "UTC",
	),
)

result = await graph_client.solutions.booking_businesses.by_booking_business_id('bookingBusiness-id').appointments.by_booking_appointment_id('bookingAppointment-id').patch(request_body)

Importante

Microsoft Graph SDK utilisent la version v1.0 de l’API par défaut et ne prennent pas en charge tous les types, propriétés et API disponibles dans la version bêta. Pour plus d’informations sur l’accès à l’API bêta avec le SDK, consultez Utiliser les kits de développement logiciel (SDK) Microsoft Graph avec l’API bêta.

Pour plus d’informations sur la façon d'ajouter le Kit de développement logiciel (SDK) à votre projet et créer une instance authProvider, consultez la documentation du Kit de développement logiciel (SDK).

Réponse

L’exemple suivant illustre la réponse.

HTTP/1.1 204 No Content