bookingAppointment 资源类型bookingAppointment resource type


Microsoft Graph 中/beta的版本下的 api 可能会发生更改。APIs under the /beta version in Microsoft Graph are subject to change. 不支持在生产应用程序中使用这些 API。Use of these APIs in production applications is not supported.

表示由 Microsoft 记帐业务提供的一组员工执行的bookingService的客户约会。Represents a customer appointment for a bookingService, performed by a set of staff members, provided by a Microsoft Bookings business.


方法Method 返回类型Return Type 说明Description
列出约会List appointments bookingAppointment集合bookingAppointment collection 获取指定bookingbusiness中的bookingAppointment对象的列表。Get a list of bookingAppointment objects in the specified bookingbusiness.
创建 bookingAppointmentCreate bookingAppointment bookingAppointmentbookingAppointment 为指定的bookingbusiness创建新的bookingAppointmentCreate a new bookingAppointment for the specified bookingbusiness.
获取 bookingAppointmentGet bookingAppointment bookingAppointmentbookingAppointment 读取bookingAppointment对象的属性和关系。Read the properties and relationships of bookingAppointment object.
更新Update bookingAppointmentbookingAppointment 更新bookingAppointment对象。Update a bookingAppointment object.
删除Delete None 删除bookingAppointment对象。Delete a bookingAppointment object.
CancelCancel None 取消bookingAppointment对象。Cancel a bookingAppointment object.


属性Property 类型Type 说明Description
customerEmailAddresscustomerEmailAddress StringString 预订约会的bookingCustomer的 SMTP 地址。The SMTP address of the bookingCustomer who is booking the appointment.
customerIdcustomerId StringString 此约会的bookingCustomer的 ID。The ID of the bookingCustomer for this appointment. 如果创建约会时未指定 ID, 则会创建一个新的bookingCustomer对象。If no ID is specified when an appointment is created, then a new bookingCustomer object is created. 设置后, 应考虑customerId不可变。Once set, you should consider the customerId immutable.
customerLocationcustomerLocation locationlocation 表示预订约会的bookingCustomer的位置信息。Represents location information for the bookingCustomer who is booking the appointment.
customerNamecustomerName StringString 客户的名称。The customer's name.
customerNotescustomerNotes StringString 来自与此约会相关联的客户的注释。Notes from the customer associated with this appointment. 仅当按 ID 读取此bookingAppointment时, 才能获取该值。You can get the value only when reading this bookingAppointment by its ID.
只有在最初创建新客户的约会时, 才能设置该属性。You can set this property only when initially creating an appointment with a new customer. 然后, 将从customerId表示的客户计算该值。After that point, the value is computed from the customer represented by customerId.
customerPhonecustomerPhone StringString 客户的电话号码。The customer's phone number.
durationduration 持续时间Duration 约会的长度, 以ISO8601格式表示。The length of the appointment, denoted in ISO8601 format.
endend dateTimeTimeZonedateTimeTimeZone 约会结束的日期、时间和时区。The date, time, and time zone that the appointment ends.
idid StringString BookingAppointment的 ID。The ID of the bookingAppointment. 只读。Read-only.
invoiceAmountinvoiceAmount 双精度Double 发票上的计费金额。The billed amount on the invoice.
invoiceDateinvoiceDate dateTimeTimeZonedateTimeTimeZone 此约会的发票的日期、时间和时区。The date, time, and time zone of the invoice for this appointment.
invoiceIdinvoiceId StringString 发票的 ID。The ID of the invoice.
invoiceStatusinvoiceStatus stringstring 发票的状态。The status of the invoice. 可取值为:draftreviewingopencanceledpaidcorrectivePossible values are: draft, reviewing, open, canceled, paid, corrective.
invoiceUrlinvoiceUrl StringString Microsoft 预订中发票的 URL。The URL of the invoice in Microsoft Bookings.
optOutOfCustomerEmailoptOutOfCustomerEmail BooleanBoolean 如果为 True, 则表示此约会的bookingCustomer不希望收到此约会的确认。True indicates that the bookingCustomer for this appointment does not wish to receive a confirmation for this appointment.
postBufferpostBuffer 持续时间Duration 在约会结束后保留的时间长度, 例如, 进行清理。The amount of time to reserve after the appointment ends, for cleaning up, as an example. 值以ISO8601格式表示。The value is expressed in ISO8601 format.
preBufferpreBuffer 持续时间Duration 在约会开始之前保留的时间量 (以供准备) 为例。The amount of time to reserve before the appointment begins, for preparation, as an example. 值以ISO8601格式表示。The value is expressed in ISO8601 format.
特价price 双精度Double 指定bookingService的约会的常规价格。The regular price for an appointment for the specified bookingService.
priceTypepriceType stringstring 一种设置, 可为服务的定价结构提供灵活性。A setting to provide flexibility for the pricing structure of services. 可取值为:undefinedfixedPricestartingAthourlyfreepriceVariescallUsnotSetPossible values are: undefined, fixedPrice, startingAt, hourly, free, priceVaries, callUs, notSet.
提醒reminders bookingReminder集合bookingReminder collection 为此约会发送的客户提醒的集合。The collection of customer reminders sent for this appointment. 此属性的值仅在按 ID 读取此bookingAppointment时可用。The value of this property is available only when reading this bookingAppointment by its ID.
selfServiceAppointmentIdselfServiceAppointmentId StringString 约会的其他跟踪 ID, 如果约会是由客户在日程安排页面上直接创建的, 而不是代表客户由教职员工成员创建的。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.
服务 IdserviceId StringString 与此约会相关联的bookingService的 ID。The ID of the bookingService associated with this appointment.
serviceLocationserviceLocation locationlocation 服务的传递位置。The location where the service is delivered.
serviceNameserviceName StringString 与此约会相关联的bookingService的名称。The name of the bookingService associated with this appointment.
创建新约会时, 此属性是可选的。This property is optional when creating a new appointment. 如果未指定, 则通过serviceId属性从与约会关联的服务计算。If not specified, it is computed from the service associated with the appointment by the serviceId property.
serviceNotesserviceNotes StringString 来自bookingStaffMember的注释。Notes from a bookingStaffMember. 此属性的值仅在按 ID 读取此bookingAppointment时可用。The value of this property is available only when reading this bookingAppointment by its ID.
staffMemberIdsstaffMemberIds String collectionString collection 在此约会中计划的每个bookingStaffMember的 ID。The ID of each bookingStaffMember who is scheduled in this appointment.
startstart dateTimeTimeZonedateTimeTimeZone 约会开始的日期、时间和时区。The date, time, and time zone that the appointment begins.



JSON 表示形式JSON representation

下面是资源的 JSON 表示形式。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"}