bookingAppointment 资源类型

命名空间：microsoft.graph

重要

Microsoft Graph /beta 版本下的 API 可能会发生更改。 不支持在生产应用程序中使用这些 API。 若要确定 API 是否在 v1.0 中可用，请使用 版本 选择器。

表示 bookingService 的客户约会，由Microsoft Bookings业务提供的一组员工执行。

方法

方法	返回类型	Description
List	bookingAppointment 集合	获取指定 bookingbusiness 中的 bookingAppointment 对象列表。
创建	bookingAppointment	为指定的 bookingbusiness 创建新的 bookingAppointment。
Get	bookingAppointment	读取 bookingAppointment 对象的属性和关系。
更新	bookingAppointment	更新 bookingAppointment 对象。
删除	None	删除 bookingAppointment 对象。
取消约会	None	取消 bookingAppointment 对象。

属性

属性	类型	说明
additionalInformation	String	确认约会时发送给客户的其他信息。
anonymousJoinWebUrl	String	要匿名加入的会议 URL。
appointmentLabel	String	用户可以在约会上标记自定义标签。
createdDateTime	DateTimeOffset	创建约会时的日期、时间和时区。
customerEmailAddress	String	预订约会的 bookingCustomer 的 SMTP 地址。
customerId	String	此约会的 bookingCustomer 的 ID。 如果在创建约会时未指定 ID，则会创建新的 bookingCustomer 对象。 设置后，应考虑 customerId 不可变。
customerLocation	location	表示预订约会的 bookingCustomer 的位置信息。
customerName	String	客户的名称。
customerNotes	String	与此约会关联的客户的备注。 仅当按 ID 读取此 bookingAppointment 时，才能获取该值。 仅当最初与新客户创建约会时，才能设置此属性。
customerPhone	String	客户的电话号码。
客户	bookingCustomerInformation 集合	约会的客户属性的集合。 约会将包含客户信息列表，每个单元将指示属于该约会的客户的属性。 可选。
customerTimeZone	String	客户的时区。 有关可能值的列表，请参阅 dateTimeTimeZone。
duration	持续时间	约会的长度，以 ISO8601 格式表示。
end	dateTimeTimeZone	约会结束的日期、时间和时区。
filledAttendeesCount	Int32	约会中的当前客户数。
id	String	bookingAppointment 的 ID。 只读。
invoiceAmount	双精度	发票上的计费金额。
invoiceDate	dateTimeTimeZone	此约会的发票的日期、时间和时区。
invoiceId	String	发票的 ID。
invoiceStatus	string	发票的状态。 可取值为：draft、reviewing、open、canceled、paid、corrective。
invoiceUrl	String	Microsoft Bookings 中发票的 URL。
isCustomerAllowedToManageBooking	布尔值	指示客户可以管理员工创建的预订。 默认值为 false。
isLocationOnline	布尔值	指示约会联机举行。 默认值为 false。
joinWebUrl	String	约会的联机会议的 URL。
lastUpdatedDateTime	DateTimeOffset	上次更新预订业务的日期、时间和时区。
maximumAttendeesCount	Int32	约会中允许的最大客户数。 如果服务的 maximumAttendeesCount 大于 1，请在创建或更新约会时传递有效的客户 ID。 若要创建客户，请使用 创建 bookingCustomer 操作。
optOutOfCustomerEmail	布尔值	True 表示此约会的 bookingCustomer 不希望收到此约会的确认。
postBuffer	持续时间	约会结束后保留的时间量，例如清理时间。 该值以 ISO8601 格式表示。
preBuffer	持续时间	例如，在约会开始前预留的时间量（用于准备）。 该值以 ISO8601 格式表示。
价格	双精度	指定 bookingService 的约会的常规价格。
priceType	bookingPriceType	一个设置，用于为服务的定价结构提供灵活性。 可取值为：undefined、fixedPrice、startingAt、hourly、free、priceVaries、callUs、notSet、unknownFutureValue。
提醒	bookingReminder 集合	为此约会发送的客户提醒集合。 仅当按 ID 读取此 bookingAppointment 时，此属性的值才可用。
selfServiceAppointmentId	String	约会的另一个跟踪 ID（如果约会是由客户直接在计划页上创建的，而不是由代表客户的员工创建）。
服务 Id	String	与此约会关联的 bookingService 的 ID。
serviceLocation	location	交付服务的位置。
serviceName	String	与此约会关联的 bookingService 的名称。 创建新约会时，此属性是可选的。 如果未指定，则通过 serviceId 属性从与约会关联的服务中计算它。
serviceNotes	String	bookingStaffMember 的备注。 仅当按 ID 读取此 bookingAppointment 时，此属性的值才可用。
smsNotificationsEnabled	布尔值	如果为 True，则表示将向客户发送预约的短信通知。 默认值为 false。
staffMemberIds	字符串集合	此约会中计划的每个 bookingStaffMember 的 ID。
start	dateTimeTimeZone	约会开始的日期、时间和时区。

关系

无

JSON 表示形式

以下 JSON 表示形式显示了资源类型。

{
  "@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",
}