bookingAppointment-RessourcentypbookingAppointment resource type

Wichtig

APIs unter der /beta Version in Microsoft Graph können Änderungen unterworfen werden.APIs under the /beta version in Microsoft Graph are subject to change. Die Verwendung dieser APIs in Produktionsanwendungen wird nicht unterstützt.Use of these APIs in production applications is not supported.

Stellt einen Kundentermin für einen bookingServicedar, der von einer Gruppe von Mitarbeitern durchgeführt wird, die von einem Microsoft-Buchungs Unternehmen bereitgestellt werden.Represents a customer appointment for a bookingService, performed by a set of staff members, provided by a Microsoft Bookings business.

MethodenMethods

MethodeMethod RückgabetypReturn Type BeschreibungDescription
Termine auflistenList appointments bookingAppointment -SammlungbookingAppointment collection Rufen Sie eine Liste der bookingAppointment -Objekte im angegebenen bookingbusiness-Objekt ab.Get a list of bookingAppointment objects in the specified bookingbusiness.
BookingAppointment erstellenCreate bookingAppointment bookingAppointmentbookingAppointment Erstellen Sie eine neue bookingAppointment für die angegebene bookingbusiness.Create a new bookingAppointment for the specified bookingbusiness.
BookingAppointment abrufenGet bookingAppointment bookingAppointmentbookingAppointment Lesen der Eigenschaften und Beziehungen des bookingAppointment -Objekts.Read the properties and relationships of bookingAppointment object.
UpdateUpdate bookingAppointmentbookingAppointment Aktualisieren eines bookingAppointment -Objekts.Update a bookingAppointment object.
DeleteDelete KeineNone Löschen eines bookingAppointment -Objekts.Delete a bookingAppointment object.
CancelCancel KeineNone Abbrechen eines bookingAppointment -Objekts.Cancel a bookingAppointment object.

EigenschaftenProperties

EigenschaftProperty TypType BeschreibungDescription
customerEmailAddresscustomerEmailAddress StringString Die SMTP-Adresse des bookingCustomer , der den Termin Bucht.The SMTP address of the bookingCustomer who is booking the appointment.
CustomerIDcustomerId StringString Die ID des bookingCustomer für diesen Termin.The ID of the bookingCustomer for this appointment. Wenn beim Erstellen eines Termins keine ID angegeben wird, wird ein neues bookingCustomer -Objekt erstellt.If no ID is specified when an appointment is created, then a new bookingCustomer object is created. Nachdem Sie festgelegt haben, sollten Sie die unveränderliche CustomerID berücksichtigen.Once set, you should consider the customerId immutable.
customerLocationcustomerLocation locationlocation Stellt Standortinformationen für die bookingCustomer dar, die den Termin buchen.Represents location information for the bookingCustomer who is booking the appointment.
CustomerNamecustomerName StringString Der Name des Kunden.The customer's name.
customerNotescustomerNotes StringString Notizen des Kunden, der diesem Termin zugeordnet ist.Notes from the customer associated with this appointment. Sie können den Wert nur abrufen, wenn Sie diesen bookingAppointment durch seine ID lesen.You can get the value only when reading this bookingAppointment by its ID.
Sie können diese Eigenschaft nur festlegen, wenn Sie zunächst einen Termin mit einem neuen Kunden erstellen.You can set this property only when initially creating an appointment with a new customer. Nach diesem Argument wird der Wert vom Kunden berechnet, der durch CustomerIDdargestellt wird.After that point, the value is computed from the customer represented by customerId.
customerPhonecustomerPhone StringString Die Telefonnummer des Kunden.The customer's phone number.
durationduration DauerDuration Die im ISO8601 -Format bezeichnete Länge des Termins.The length of the appointment, denoted in ISO8601 format.
endend dateTimeTimeZonedateTimeTimeZone Datum, Uhrzeit und Zeitzone, zu denen der Termin endet.The date, time, and time zone that the appointment ends.
idid StringString Die ID des bookingAppointment.The ID of the bookingAppointment. Schreibgeschützt.Read-only.
invoiceAmountinvoiceAmount Gleitkommawert mit doppelter GenauigkeitDouble Der abgerechnete Betrag auf der Rechnung.The billed amount on the invoice.
invoiceDateinvoiceDate dateTimeTimeZonedateTimeTimeZone Das Datum, die Uhrzeit und die Zeitzone der Rechnung für diesen Termin.The date, time, and time zone of the invoice for this appointment.
Invoice-NrinvoiceId StringString Die ID der Rechnung.The ID of the invoice.
invoiceStatusinvoiceStatus stringstring Der Status der Rechnung.The status of the invoice. Mögliche Werte sind: draft, reviewing, open, canceled, paid und corrective.Possible values are: draft, reviewing, open, canceled, paid, corrective.
invoiceUrlinvoiceUrl StringString Die URL der Rechnung in Microsoft-Buchungen.The URL of the invoice in Microsoft Bookings.
optOutOfCustomerEmailoptOutOfCustomerEmail BooleschBoolean True gibt an, dass die bookingCustomer für diesen Termin keine Bestätigung für diesen Termin erhalten möchte.True indicates that the bookingCustomer for this appointment does not wish to receive a confirmation for this appointment.
postBufferpostBuffer DauerDuration Die Zeitspanne, die nach Beendigung des Termins für die Bereinigung als Beispiel reserviert werden soll.The amount of time to reserve after the appointment ends, for cleaning up, as an example. Der Wert wird im ISO8601 -Format ausgedrückt.The value is expressed in ISO8601 format.
preBufferpreBuffer DauerDuration Die Zeitspanne, die vor Beginn des Termins für die Vorbereitung reserviert werden soll, als Beispiel.The amount of time to reserve before the appointment begins, for preparation, as an example. Der Wert wird im ISO8601 -Format ausgedrückt.The value is expressed in ISO8601 format.
Preisprice Gleitkommawert mit doppelter GenauigkeitDouble Der reguläre Preis für einen Termin für die angegebene bookingService.The regular price for an appointment for the specified bookingService.
priceTypepriceType stringstring Eine Einstellung, die Flexibilität für die Preisstruktur von Diensten bereitstellt.A setting to provide flexibility for the pricing structure of services. Mögliche Werte: undefined, fixedPrice, startingAt, hourly, free, priceVaries, callUs, notSet.Possible values are: undefined, fixedPrice, startingAt, hourly, free, priceVaries, callUs, notSet.
Erinnerungenreminders bookingReminder -SammlungbookingReminder collection Die Sammlung von Kunden Erinnerungen, die für diesen Termin gesendet wurden.The collection of customer reminders sent for this appointment. Der Wert dieser Eigenschaft ist nur verfügbar, wenn dieser bookingAppointment durch seine ID gelesen wird.The value of this property is available only when reading this bookingAppointment by its ID.
selfServiceAppointmentIdselfServiceAppointmentId StringString Eine zusätzliche Tracking-ID für den Termin, wenn der Termin direkt vom Kunden auf der Seite "Planung" erstellt wurde, im Gegensatz zu einem Mitarbeiter im Namen des Kunden.An additional tracking ID for the appointment, if the appointment has been created directly by the customer on the scheduling page, as opposed to by a staff member on the behalf of the customer.
ServiceIDserviceId StringString Die ID des bookingService , das diesem Termin zugeordnet ist.The ID of the bookingService associated with this appointment.
serviceLocationserviceLocation locationlocation Der Ort, an dem der Dienst zugestellt wird.The location where the service is delivered.
Wert Service NameserviceName StringString Der Name der bookingService , die diesem Termin zugeordnet ist.The name of the bookingService associated with this appointment.
Diese Eigenschaft ist beim Erstellen eines neuen Termins optional.This property is optional when creating a new appointment. Wenn kein Wert angegeben ist, wird er aus dem Dienst berechnet, der dem Termin durch die Service -Eigenschaft zugeordnet ist.If not specified, it is computed from the service associated with the appointment by the serviceId property.
serviceNotesserviceNotes StringString Notizen aus einer bookingStaffMember.Notes from a bookingStaffMember. Der Wert dieser Eigenschaft ist nur verfügbar, wenn dieser bookingAppointment durch seine ID gelesen wird.The value of this property is available only when reading this bookingAppointment by its ID.
staffMemberIdsstaffMemberIds String collectionString collection Die ID der einzelnen bookingStaffMember , die in diesem Termin geplant sind.The ID of each bookingStaffMember who is scheduled in this appointment.
startstart dateTimeTimeZonedateTimeTimeZone Das Datum, die Uhrzeit und die Zeitzone, die der Termin beginnt.The date, time, and time zone that the appointment begins.

BeziehungenRelationships

KeineNone

JSON-DarstellungJSON representation

Es folgt eine JSON-Darstellung der Ressource.The following is a JSON representation of the resource.

{
  "customerEmailAddress": "String",
  "customerId": "String",
  "customerLocation": {"@odata.type": "microsoft.graph.location"},
  "customerName": "String",
  "customerNotes": "String",
  "customerPhone": "String",
  "duration": "String (timestamp)",
  "end": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "id": "String (identifier)",
  "invoiceAmount": 1024,
  "invoiceDate": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "invoiceId": "String",
  "invoiceStatus": "string",
  "invoiceUrl": "String",
  "optOutOfCustomerEmail": true,
  "postBuffer": "String (timestamp)",
  "preBuffer": "String (timestamp)",
  "price": 1024,
  "priceType": "string",
  "reminders": [{"@odata.type": "microsoft.graph.bookingReminder"}],
  "selfServiceAppointmentId": "String",
  "serviceId": "String",
  "serviceLocation": {"@odata.type": "microsoft.graph.location"},
  "serviceName": "String",
  "serviceNotes": "String",
  "staffMemberIds": ["String"],
  "start": {"@odata.type": "microsoft.graph.dateTimeTimeZone"}
}