Обновление bookingAppointment
Пространство имен: microsoft.graph
Обновите свойства объекта bookingAppointment в указанном bookingBusiness.
Этот API доступен в следующих национальных облачных развертываниях.
| Глобальная служба | Правительство США L4 | Правительство США L5 (DOD) | Китай управляется 21Vianet |
|---|---|---|---|
| ✅ | ✅ | ✅ | ❌ |
Разрешения
Выберите разрешение или разрешения, помеченные как наименее привилегированные для этого API. Используйте более привилегированное разрешение или разрешения только в том случае, если это требуется приложению. Дополнительные сведения о делегированных разрешениях и разрешениях приложений см. в разделе Типы разрешений. Дополнительные сведения об этих разрешениях см. в справочнике по разрешениям.
| Тип разрешения | Разрешения с наименьшими привилегиями | Более высокие привилегированные разрешения |
|---|---|---|
| Делегированные (рабочая или учебная учетная запись) | BookingsAppointment.ReadWrite.All | Bookings. Manage.All, Bookings. ReadWrite.All |
| Делегированные (личная учетная запись Майкрософт) | Не поддерживается. | Не поддерживается. |
| Приложение | BookingsAppointment.ReadWrite.All | Bookings. Manage.All, Bookings. Read.All, Bookings. ReadWrite.All |
Примечание.
При создании пользовательского приложения с разрешениями приложения необходимо выполнить проверку бизнес-правил.
HTTP-запрос
PATCH /solutions/bookingBusinesses/{id}/appointments/{id}
Заголовки запросов
| Имя | Описание |
|---|---|
| Авторизация | Bearer {код}. Обязательно. |
Текст запроса
В тексте запроса укажите только значения свойств для обновления. Существующие свойства, которые не включены в текст запроса, сохраняют свои предыдущие значения или пересчитываются на основе изменений других значений свойств.
В следующей таблице указаны свойства, которые можно обновить.
| Свойство | Тип | Описание |
|---|---|---|
| customerEmailAddress | String | SMTP-адрес bookingCustomer , который заказит встречу. |
| customerName | String | Имя клиента. |
| customerNotes | String | Заметки от клиента, связанного с этой встречей. Значение можно получить только при чтении этого объекта bookingAppointment по его идентификатору. Это свойство можно задать только при первоначальном создании встречи с новым клиентом. |
| customerPhone | String | Номер телефона клиента. |
| Клиентов | коллекция bookingCustomerInformation | В нем перечислены свойства клиента для встречи. Встреча содержит список сведений о клиентах, а каждая единица указывает свойства клиента, который является частью этой встречи. Необязательный параметр. |
| customerTimeZone | String | Часовой пояс клиента. Список возможных значений см. в разделе dateTimeTimeZone. |
| duration | Duration (Длительность) | Длина встречи, обозначенная в ISO8601 формате. |
| end | dateTimeTimeZone | Дата, время и часовой пояс окончания встречи. |
| invoiceStatus | string | Состояние счета. Возможные значения: draft, reviewing, open, canceled, paidи corrective. |
| isCustomerAllowedToManageBooking | Логический | Указывает, что клиент может управлять заказами, созданными сотрудниками. Значение по умолчанию — false. |
| filledAttendeesCount | Int32 | Текущее число клиентов в встрече. Обязательно. |
| isLocationOnline | Логический |
True указывает, что встреча проводится в режиме онлайн. Значение по умолчанию — false. |
| maximumAttendeesCount | Int32 | Максимальное число клиентов, разрешенных в встрече. Обязательно. |
| optOutOfCustomerEmail | Логический |
True указывает, что bookingCustomer для этой встречи не хочет получать подтверждение для этой встречи. |
| postBuffer | Duration (Длительность) | Количество времени, которое необходимо зарезервировать после окончания встречи для очистки, в качестве примера. Значение выражается в формате ISO8601 . |
| preBuffer | Duration (Длительность) | Количество времени, которое необходимо зарезервировать до начала встречи для подготовки, в качестве примера. Значение выражается в формате ISO8601 . |
| цена | Двойное с плавающей точкой | Обычная цена за встречу для указанной bookingService. |
| priceType | bookingPriceType | Параметр, обеспечивающий гибкость структуры ценообразования служб. Возможные значения: undefined, fixedPrice, startingAt, hourly, free, priceVaries, callUs, notSet, unknownFutureValue. |
| Напоминания | коллекция bookingReminder | Коллекция напоминаний клиентов, отправленных для этой встречи. Значение этого свойства доступно только при чтении этого объекта bookingAppointment по его идентификатору. |
| selfServiceAppointmentId | String | Другой идентификатор отслеживания для встречи, если встреча была создана непосредственно клиентом на странице планирования, а не сотрудником от имени клиента. |
| serviceId | Строка | Идентификатор bookingService , связанного с этой встречей. |
| serviceLocation | location | Расположение, в котором доставляется служба. |
| serviceName | String | Имя службы bookingService , связанной с этой встречей. Это свойство является необязательным при создании новой встречи. Если этот параметр не указан, он вычисляется из службы, связанной с встречей, с помощью свойства serviceId . |
| serviceNotes | String | Заметки из bookingStaffMember. Значение этого свойства доступно только при чтении этого объекта bookingAppointment по его идентификатору. |
| smsNotificationsEnabled | Логический |
True указывает, что клиентам отправляются SMS-уведомления о встрече. Значение по умолчанию — false. |
| staffMemberIds | Коллекция строк | Идентификатор каждого bookingStaffMember , запланированного на эту встречу. |
| начать | dateTimeTimeZone | Дата, время и часовой пояс, когда начинается встреча. |
Примечание.
Если максимальное число клиентов (maximumAttedeesCount) в службе больше 1:
- Убедитесь, что клиенты существуют в календаре резервирования. Если это не так, создайте с помощью операции Создать bookingCustomer .
- Передайте действительные идентификаторы клиентов при создании или обновлении встречи. Если идентификатор клиента недопустим, этот клиент не будет включен в объект встречи.
Отклик
В случае успешного выполнения этот метод возвращает код отклика 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",
"end":{
"@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"
}
}
Отклик
Ниже приводится пример отклика.
HTTP/1.1 204 No Content