Обновление bookingAppointment

Статья
04/19/2024

Пространство имен: microsoft.graph

Важно!

API версии /beta в Microsoft Graph могут быть изменены. Использование этих API в производственных приложениях не поддерживается. Чтобы определить, доступен ли API в версии 1.0, используйте селектор версий.

Обновите свойства объекта 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 , который резервит встречу.
customerId	String	Идентификатор bookingCustomer для этой встречи. Если при создании встречи не указан идентификатор, создается новый объект bookingCustomer . После установки следует считать customerId неизменяемым.
customerLocation	location	Представляет сведения о местоположении для bookingCustomer , который резервирует встречу.
customerName	String	Имя клиента.
customerNotes	String	Заметки от клиента, связанного с этой встречей. Значение можно получить только при чтении этого объекта bookingAppointment по его идентификатору. Это свойство можно задать только при первоначальном создании встречи с новым клиентом. После этого значение вычисляется из клиента, представленного идентификатором customerId.
customerPhone	String	Номер телефона клиента.
Клиентов	коллекция bookingCustomerInformation	В нем перечислены свойства клиента для встречи. Встреча содержит список сведений о клиентах, а каждая единица указывает свойства клиента, который является частью этой встречи. Необязательный параметр.
customerTimeZone	String	Часовой пояс клиента. Список возможных значений см. в разделе dateTimeTimeZone.
duration	Duration (Длительность)	Длина встречи, обозначенная в ISO8601 формате.
end	dateTimeTimeZone	Дата, время и часовой пояс окончания встречи.
invoiceAmount	Двойное с плавающей точкой	Сумма счета в счете.
invoiceDate	dateTimeTimeZone	Дата, время и часовой пояс счета для этой встречи.
invoiceId	String	Идентификатор счета.
invoiceStatus	string	Состояние счета. Возможные значения: `draft`, `reviewing`, `open`, `canceled`, `paid`и `corrective`.
isCustomerAllowedToManageBooking	Логический	Указывает, что клиент может управлять заказами, созданными сотрудниками. Значение по умолчанию — `false`.
invoiceUrl	String	URL-адрес счета в Microsoft Bookings.
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/beta/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"
    },
    "invoiceDate":{
        "@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"
    }
}


// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Beta.Models;

var requestBody = new BookingAppointment
{
	OdataType = "#microsoft.graph.bookingAppointment",
	End = new DateTimeTimeZone
	{
		OdataType = "#microsoft.graph.dateTimeTimeZone",
		DateTime = "2018-05-06T12:30:00.0000000+00:00",
		TimeZone = "UTC",
	},
	InvoiceDate = new DateTimeTimeZone
	{
		OdataType = "#microsoft.graph.dateTimeTimeZone",
		DateTime = "2018-05-06T12:30:00.0000000+00:00",
		TimeZone = "UTC",
	},
	Start = new DateTimeTimeZone
	{
		OdataType = "#microsoft.graph.dateTimeTimeZone",
		DateTime = "2018-05-06T12:00:00.0000000+00:00",
		TimeZone = "UTC",
	},
};

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=csharp
var result = await graphClient.Solutions.BookingBusinesses["{bookingBusiness-id}"].Appointments["{bookingAppointment-id}"].PatchAsync(requestBody);

Важно!

Пакеты SDK для Microsoft Graph по умолчанию используют версию API версии 1.0 и поддерживают не все типы, свойства и API, доступные в бета-версии. Дополнительные сведения о доступе к бета-API с помощью SDK см. в статье Использование пакетов Microsoft Graph SDK с бета-API.

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc-beta solutions booking-businesses appointments patch --booking-business-id {bookingBusiness-id} --booking-appointment-id {bookingAppointment-id} --body '{\
    "@odata.type":"#microsoft.graph.bookingAppointment",\
    "end":{\
        "@odata.type":"#microsoft.graph.dateTimeTimeZone",\
        "dateTime":"2018-05-06T12:30:00.0000000+00:00",\
        "timeZone":"UTC"\
    },\
    "invoiceDate":{\
        "@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"\
    }\
}\
'

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.



import (
	  "context"
	  msgraphsdk "github.com/microsoftgraph/msgraph-beta-sdk-go"
	  graphmodels "github.com/microsoftgraph/msgraph-beta-sdk-go/models"
	  //other-imports
)

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphmodels.NewBookingAppointment()
end := graphmodels.NewDateTimeTimeZone()
dateTime := "2018-05-06T12:30:00.0000000+00:00"
end.SetDateTime(&dateTime) 
timeZone := "UTC"
end.SetTimeZone(&timeZone) 
requestBody.SetEnd(end)
invoiceDate := graphmodels.NewDateTimeTimeZone()
dateTime := "2018-05-06T12:30:00.0000000+00:00"
invoiceDate.SetDateTime(&dateTime) 
timeZone := "UTC"
invoiceDate.SetTimeZone(&timeZone) 
requestBody.SetInvoiceDate(invoiceDate)
start := graphmodels.NewDateTimeTimeZone()
dateTime := "2018-05-06T12:00:00.0000000+00:00"
start.SetDateTime(&dateTime) 
timeZone := "UTC"
start.SetTimeZone(&timeZone) 
requestBody.SetStart(start)

appointments, err := graphClient.Solutions().BookingBusinesses().ByBookingBusinessId("bookingBusiness-id").Appointments().ByBookingAppointmentId("bookingAppointment-id").Patch(context.Background(), requestBody, nil)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

BookingAppointment bookingAppointment = new BookingAppointment();
bookingAppointment.setOdataType("#microsoft.graph.bookingAppointment");
DateTimeTimeZone end = new DateTimeTimeZone();
end.setOdataType("#microsoft.graph.dateTimeTimeZone");
end.setDateTime("2018-05-06T12:30:00.0000000+00:00");
end.setTimeZone("UTC");
bookingAppointment.setEnd(end);
DateTimeTimeZone invoiceDate = new DateTimeTimeZone();
invoiceDate.setOdataType("#microsoft.graph.dateTimeTimeZone");
invoiceDate.setDateTime("2018-05-06T12:30:00.0000000+00:00");
invoiceDate.setTimeZone("UTC");
bookingAppointment.setInvoiceDate(invoiceDate);
DateTimeTimeZone start = new DateTimeTimeZone();
start.setOdataType("#microsoft.graph.dateTimeTimeZone");
start.setDateTime("2018-05-06T12:00:00.0000000+00:00");
start.setTimeZone("UTC");
bookingAppointment.setStart(start);
BookingAppointment result = graphClient.solutions().bookingBusinesses().byBookingBusinessId("{bookingBusiness-id}").appointments().byBookingAppointmentId("{bookingAppointment-id}").patch(bookingAppointment);

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


const options = {
	authProvider,
};

const client = Client.init(options);

const bookingAppointment = {
    '@odata.type':'#microsoft.graph.bookingAppointment',
    end: {
        '@odata.type':'#microsoft.graph.dateTimeTimeZone',
        dateTime: '2018-05-06T12:30:00.0000000+00:00',
        timeZone: 'UTC'
    },
    invoiceDate: {
        '@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'
    }
};

await client.api('/solutions/bookingBusinesses/contosolunchdelivery@contoso.com/appointments/AAMkADKnAAA=')
	.version('beta')
	.update(bookingAppointment);

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\BookingAppointment;
use Microsoft\Graph\Generated\Models\DateTimeTimeZone;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new BookingAppointment();
$requestBody->setOdataType('#microsoft.graph.bookingAppointment');
$end = new DateTimeTimeZone();
$end->setOdataType('#microsoft.graph.dateTimeTimeZone');
$end->setDateTime('2018-05-06T12:30:00.0000000+00:00');
$end->setTimeZone('UTC');
$requestBody->setEnd($end);
$invoiceDate = new DateTimeTimeZone();
$invoiceDate->setOdataType('#microsoft.graph.dateTimeTimeZone');
$invoiceDate->setDateTime('2018-05-06T12:30:00.0000000+00:00');
$invoiceDate->setTimeZone('UTC');
$requestBody->setInvoiceDate($invoiceDate);
$start = new DateTimeTimeZone();
$start->setOdataType('#microsoft.graph.dateTimeTimeZone');
$start->setDateTime('2018-05-06T12:00:00.0000000+00:00');
$start->setTimeZone('UTC');
$requestBody->setStart($start);

$result = $graphServiceClient->solutions()->bookingBusinesses()->byBookingBusinessId('bookingBusiness-id')->appointments()->byBookingAppointmentId('bookingAppointment-id')->patch($requestBody)->wait();

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.


from msgraph import GraphServiceClient
from msgraph.generated.models.booking_appointment import BookingAppointment
from msgraph.generated.models.date_time_time_zone import DateTimeTimeZone

graph_client = GraphServiceClient(credentials, scopes)

request_body = BookingAppointment(
	odata_type = "#microsoft.graph.bookingAppointment",
	end = DateTimeTimeZone(
		odata_type = "#microsoft.graph.dateTimeTimeZone",
		date_time = "2018-05-06T12:30:00.0000000+00:00",
		time_zone = "UTC",
	),
	invoice_date = DateTimeTimeZone(
		odata_type = "#microsoft.graph.dateTimeTimeZone",
		date_time = "2018-05-06T12:30:00.0000000+00:00",
		time_zone = "UTC",
	),
	start = DateTimeTimeZone(
		odata_type = "#microsoft.graph.dateTimeTimeZone",
		date_time = "2018-05-06T12:00:00.0000000+00:00",
		time_zone = "UTC",
	),
)

result = await graph_client.solutions.booking_businesses.by_booking_business_id('bookingBusiness-id').appointments.by_booking_appointment_id('bookingAppointment-id').patch(request_body)

Важно!

Подробнее о том, как добавить SDK в свой проект и создать экземпляр authProvider, см. в документации по SDK.

Отклик

Ниже приводится пример отклика.

HTTP/1.1 204 No Content

Обновление bookingAppointment

Разрешения

HTTP-запрос

Необязательные заголовки запросов

Текст запроса

Отклик

Пример

Запрос

Отклик

Обратная связь

Обратная связь

Дополнительные ресурсы