bookingAppointment aktualisieren

Artikel
10/28/2023

Namespace: microsoft.graph

Wichtig

Die APIs unter der /beta Version in Microsoft Graph können sich ändern. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt. Um festzustellen, ob eine API in v1.0 verfügbar ist, verwenden Sie die Version Selektor.

Aktualisieren Sie die Eigenschaften eines bookingAppointment-Objekts im angegebenen bookingBusiness.Update the properties of a bookingAppointment object in the specified bookingBusiness.

Diese API ist in den folgenden nationalen Cloudbereitstellungen verfügbar.

Globaler Dienst	US Government L4	US Government L5 (DOD)	China, betrieben von 21Vianet
✅	❌	❌	❌

Berechtigungen

Wählen Sie für diese API die Als am wenigsten privilegierten Berechtigungen gekennzeichneten Berechtigungen aus. Verwenden Sie nur dann eine Berechtigung mit höheren Berechtigungen , wenn dies für Ihre App erforderlich ist. Ausführliche Informationen zu delegierten Berechtigungen und Anwendungsberechtigungen finden Sie unter Berechtigungstypen. Weitere Informationen zu diesen Berechtigungen finden Sie in der Berechtigungsreferenz.

Berechtigungstyp	Berechtigungen mit den geringsten Berechtigungen	Berechtigungen mit höheren Berechtigungen
Delegiert (Geschäfts-, Schul- oder Unikonto)	BookingsAppointment.ReadWrite.All	Bookings. Manage.All, Bookings. ReadWrite.All
Delegiert (persönliches Microsoft-Konto)	Nicht unterstützt	Nicht unterstützt
Anwendung	BookingsAppointment.ReadWrite.All	Bookings. Manage.All, Bookings. Read.All, Bookings. ReadWrite.All

Hinweis

Wenn Sie eine benutzerdefinierte App mit Anwendungsberechtigungen erstellen, müssen Sie die Überprüfung der Geschäftsregeln befolgen.

HTTP-Anforderung

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

Optionale Anforderungsheader

Name	Beschreibung
Authorization	Bearer {code}. Erforderlich.

Anforderungstext

Geben Sie im Anforderungstext nur die Werte für die Eigenschaften an, die aktualisiert werden sollen. Vorhandene Eigenschaften, die nicht im Anforderungstext enthalten sind, behalten ihre vorherigen Werte bei oder werden basierend auf Änderungen an anderen Eigenschaftswerten neu berechnet.

In der folgenden Tabelle sind die Eigenschaften angegeben, die aktualisiert werden können.

Eigenschaft	Typ	Beschreibung
customerEmailAddress	Zeichenfolge	Die SMTP-Adresse des bookingCustomers , der den Termin bucht.
customerId	Zeichenfolge	Die ID des bookingCustomer für diesen Termin. Wenn beim Erstellen eines Termins keine ID angegeben wird, wird ein neues bookingCustomer-Objekt erstellt. Nach dem Festlegen sollten Sie die customerId als unveränderlich betrachten.
customerLocation	location	Stellt Standortinformationen für den bookingCustomer dar, der den Termin bucht.
Customername	Zeichenfolge	Der Name des Kunden.
customerNotes	Zeichenfolge	Notizen des Kunden, die diesem Termin zugeordnet sind. Sie können den Wert nur abrufen, wenn Sie diese bookingAppointment anhand ihrer ID lesen. Sie können diese Eigenschaft nur beim ersten Erstellen eines Termins mit einem neuen Kunden festlegen. Danach wird der Wert aus dem Kunden berechnet, der durch customerId dargestellt wird.
customerPhone	Zeichenfolge	Die Telefonnummer des Kunden.
Kunden	bookingCustomerInformation-Sammlung	Sie listet die Kundeneigenschaften für einen Termin auf. Ein Termin enthält eine Liste von Kundeninformationen, und jede Einheit gibt die Eigenschaften eines Kunden an, der Teil dieses Termins ist. Optional.
customerTimeZone	Zeichenfolge	Die Zeitzone des Kunden. Eine Liste der möglichen Werte finden Sie unter dateTimeTimeZone.
Dauer	Dauer	Die Länge des Termins, die im format ISO8601 angegeben ist.
end	dateTimeTimeZone	Datum, Uhrzeit und Zeitzone, in der der Termin endet.
invoiceAmount	Gleitkommawert mit doppelter Genauigkeit	Der in Rechnung gestellte Betrag.
invoiceDate	dateTimeTimeZone	Datum, Uhrzeit und Zeitzone der Rechnung für diesen Termin.
invoiceId	Zeichenfolge	Die ID der Rechnung.
invoiceStatus	string	Die status der Rechnung. Mögliche Werte sind: `draft`, `reviewing`, `open`, `canceled`, `paid`und `corrective`.
isCustomerAllowedToManageBooking	Boolesch	Gibt an, dass der Kunde buchungen verwalten kann, die vom Personal erstellt wurden. Der Standardwert ist `false`.
invoiceUrl	Zeichenfolge	Die URL der Rechnung in Microsoft Bookings.
filledAttendeesCount	Int32	Die aktuelle Anzahl der Kunden im Termin. Erforderlich.
isLocationOnline	Boolesch	True gibt an, dass der Termin online gehalten wird. Der Standardwert ist `false`.
maximumAttendeesCount	Int32	Die maximale Anzahl von Kunden, die für den Termin zulässig sind. Erforderlich.
optOutOfCustomerEmail	Boolesch	True gibt an, dass der bookingCustomer für diesen Termin keine Bestätigung für diesen Termin erhalten möchte.
postBuffer	Dauer	Die Zeit, die nach Ablauf des Termins reserviert werden soll, z. B. für die Bereinigung. Der Wert wird in ISO8601 Format ausgedrückt.
preBuffer	Dauer	Die Zeit, die vor Beginn des Termins reserviert werden muss, z. B. zur Vorbereitung. Der Wert wird in ISO8601 Format ausgedrückt.
Preis	Gleitkommawert mit doppelter Genauigkeit	Der reguläre Preis für einen Termin für den angegebenen bookingService.
priceType	bookingPriceType	Eine Einstellung, die Flexibilität für die Preisstruktur von Diensten bietet. Mögliche Werte: `undefined`, `fixedPrice`, `startingAt`, `hourly`, `free`, `priceVaries`, `callUs`, `notSet`, `unknownFutureValue`.
Erinnerungen	bookingReminder-Sammlung	Die Sammlung von Kundenerinnerungen, die für diesen Termin gesendet wurden. Der Wert dieser Eigenschaft ist nur verfügbar, wenn diese bookingAppointment anhand seiner ID gelesen wird.
selfServiceAppointmentId	Zeichenfolge	Eine weitere Nachverfolgungs-ID für den Termin, wenn der Termin direkt vom Kunden auf der Terminplanungsseite und nicht von einem Mitarbeiter im Auftrag des Kunden erstellt wurde.
ServiceID	Zeichenfolge	Die ID des bookingService , der diesem Termin zugeordnet ist.
serviceLocation	location	Der Ort, an dem der Dienst bereitgestellt wird.
Servicename	Zeichenfolge	Der Name des bookingService , der diesem Termin zugeordnet ist. Diese Eigenschaft ist beim Erstellen eines neuen Termins optional. Wenn keine Angabe erfolgt, wird sie aus dem Dienst berechnet, der dem Termin durch die serviceId-Eigenschaft zugeordnet ist.
serviceNotes	Zeichenfolge	Notizen aus einem bookingStaffMember. Der Wert dieser Eigenschaft ist nur verfügbar, wenn diese bookingAppointment anhand seiner ID gelesen wird.
smsNotificationsEnabled	Boolesch	True gibt an, dass SMS-Benachrichtigungen für den Termin an die Kunden gesendet werden. Der Standardwert ist `false`.
staffMemberIds	String-Sammlung	Die ID jedes bookingStaffMember , der in diesem Termin geplant ist.
start	dateTimeTimeZone	Datum, Uhrzeit und Zeitzone, in der der Termin beginnt.

Hinweis

Wenn die maximal zulässige Anzahl von Kunden (maximumAttedeesCount) im Dienst größer als 1 ist:

Stellen Sie sicher, dass die Kunden im Buchungskalender vorhanden sind. Wenn dies nicht der Fall ist, erstellen Sie sie mit dem Vorgang BookingCustomer erstellen .
Übergeben Sie gültige Kunden-IDs, wenn Sie den Termin erstellen oder aktualisieren. Wenn die Kunden-ID ungültig ist, wird dieser Kunde nicht in das Terminobjekt aufgenommen.

Antwort

Wenn die Methode erfolgreich verläuft, wird der Antwortcode 204 No Content zurückgegeben. Es gibt nichts im Antworttext zurück.

Beispiel

Anforderung

Im folgenden Beispiel wird das Dienstdatum um einen Tag geändert und das Rechnungsdatum aktualisiert.

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"
    }
}


// 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);

Wichtig

Die Microsoft Graph SDKs verwenden standardmäßig die Version v1.0 der API und unterstützen nicht alle Typen, Eigenschaften und APIs, die in der Beta-Version verfügbar sind. Einzelheiten zum Zugriff auf die Beta-API mit dem SDK finden Sie unter Verwenden der Microsoft Graph SDKs mit der Beta-API.

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
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"\
    }\
}\
'

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.



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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


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)

appointments, err := graphClient.Solutions().BookingBusinesses().ByBookingBusinessId("bookingBusiness-id").Appointments().ByBookingAppointmentId("bookingAppointment-id").Patch(context.Background(), requestBody, nil)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


// 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);

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


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);

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\BookingAppointment;
use Microsoft\Graph\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();

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.


from msgraph import GraphServiceClient
from msgraph.generated.models.booking_appointment import BookingAppointment
from msgraph.generated.models.date_time_time_zone import DateTimeTimeZone

graph_client = GraphServiceClient(credentials, scopes)

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)

Wichtig

Einzelheiten darüber, wie Sie das SDK zu Ihrem Projekt hinzufügen und eine authProvider-Instanz erstellen, finden Sie in der SDK-Dokumentation.

Antwort

Das folgende Beispiel zeigt die Antwort.

HTTP/1.1 204 No Content

bookingAppointment aktualisieren

Berechtigungen

HTTP-Anforderung

Optionale Anforderungsheader

Anforderungstext

Antwort

Beispiel

Anforderung

Antwort

Feedback

Feedback

Zusätzliche Ressourcen