更新 bookingAppointment
命名空间:microsoft.graph
更新指定 bookingBusiness 中 bookingAppointment 对象的属性。
此 API 可用于以下国家级云部署。
全局服务 | 美国政府 L4 | 美国政府 L5 (DOD) | 由世纪互联运营的中国 |
---|---|---|---|
✅ | ✅ | ✅ | ❌ |
权限
为此 API 选择标记为最低特权的权限。 只有在应用需要它时,才使用更高的特权权限。 有关委派权限和应用程序权限的详细信息,请参阅权限类型。 要了解有关这些权限的详细信息,请参阅 权限参考。
权限类型 | 最低特权权限 | 更高特权权限 |
---|---|---|
委派(工作或学校帐户) | BookingsAppointment.ReadWrite.All | Bookings。Manage.All、Bookings。ReadWrite.All |
委派(个人 Microsoft 帐户) | 不支持。 | 不支持。 |
应用程序 | BookingsAppointment.ReadWrite.All | Bookings。Manage.All、Bookings。Read.All,Bookings。ReadWrite.All |
注意
如果使用应用程序权限创建自定义应用,则必须遵循 业务规则验证。
HTTP 请求
PATCH /solutions/bookingBusinesses/{id}/appointments/{id}
请求标头
名称 | 说明 |
---|---|
Authorization | Bearer {code}。 必需。 |
请求正文
在请求正文中,仅提供应更新的属性的值。 请求正文中未包含的现有属性会保留其以前的值,或者根据对其他属性值的更改重新计算。
下表指定可更新的属性。
属性 | 类型 | 说明 |
---|---|---|
客户 | bookingCustomerInformation 集合 | 它列出约会的客户属性。 约会将包含客户信息列表,每个单元将指示属于该约会的客户的属性。 可选。 |
customerTimeZone | String | 客户的时区。 有关可能值的列表,请参阅 dateTimeTimeZone。 |
duration | 持续时间 | 约会的长度,以 ISO8601 格式表示。 |
endDateTime | dateTimeTimeZone | 约会结束的日期、时间和时区。 |
filledAttendeesCount | Int32 | 约会中的当前客户数。 必填。 |
isLocationOnline | 布尔值 | 如果 true 为 ,则指示约会将联机举行。 默认值为 false。 |
maximumAttendeesCount | Int32 | 约会中允许的最大客户数。 必填。 |
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,而不是由代表客户的员工创建。 仅当 maxAttendeeCount 为 1 时,才支持约会。 |
服务 Id | String | 与此约会关联的 bookingService 的 ID。 |
serviceLocation | location | 交付服务的位置。 |
serviceName | String | 与此约会关联的 bookingService 的名称。 创建新约会时,此属性是可选的。 如果未指定,则通过 serviceId 属性从与约会关联的服务中计算它。 |
serviceNotes | String | bookingStaffMember 的备注。 仅当按 ID 读取此 bookingAppointment 时,此属性的值才可用。 |
smsNotificationsEnabled | 布尔值 | 如果 true 为 ,则指示将向客户发送预约的短信通知。 默认值为 false。 |
staffMemberIds | 字符串集合 | 此约会中计划的每个 bookingStaffMember 的 ID。 |
startDateTime | dateTimeTimeZone | 约会开始的日期、时间和时区。 |
注意
如果服务中允许的最大客户数 (maximumAttedeesCount) 大于 1:
- 确保客户位于“预订日历”中。 否则,请使用 创建 bookingCustomer 操作进行创建 。
- 创建或更新约会时传递有效的客户 ID。 如果客户 ID 无效,则约会对象中不会包含该客户。
响应
如果成功,此方法返回 204 No Content
响应代码。 它不会在响应正文中返回任何内容。
示例
请求
以下示例将服务日期更改为一天。
PATCH https://graph.microsoft.com/v1.0/solutions/bookingBusinesses/Contosolunchdelivery@contoso.com/appointments/AAMkADKnAAA=
Content-type: application/json
{
"@odata.type":"#microsoft.graph.bookingAppointment",
"endDateTime":{
"@odata.type":"#microsoft.graph.dateTimeTimeZone",
"dateTime":"2018-05-06T12:30:00.0000000+00:00",
"timeZone":"UTC"
},
"startDateTime":{
"@odata.type":"#microsoft.graph.dateTimeTimeZone",
"dateTime":"2018-05-06T12:00:00.0000000+00:00",
"timeZone":"UTC"
}
}
响应
以下示例显示了相应的响应。
HTTP/1.1 204 No Content
反馈
https://aka.ms/ContentUserFeedback。
即将发布:在整个 2024 年,我们将逐步淘汰作为内容反馈机制的“GitHub 问题”,并将其取代为新的反馈系统。 有关详细信息,请参阅:提交和查看相关反馈