BookingAppointment を更新する

[アーティクル]
03/21/2024

名前空間: microsoft.graph

重要

Microsoft Graph の /beta バージョンの API は変更される可能性があります。実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。

指定した bookingBusiness 内の bookingAppointment オブジェクトのプロパティを更新します。

この API は、次の国内クラウド展開で使用できます。

グローバルサービス	米国政府機関 L4	米国政府機関 L5 (DOD)	21Vianet が運営する中国
✅	✅	✅	❌

アクセス許可

この 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	ベアラー {code}。必須です。

要求本文

要求本文で、更新すべきプロパティの値のみを指定します。要求本文に含まれていない既存のプロパティは、以前の値を維持するか、他のプロパティ値の変更に基づいて再計算されます。

次の表に、更新できるプロパティを示します。

プロパティ	型	説明
customerEmailAddress	String	予約を予約している BookingCustomer の SMTP アドレス。
customerId	String	この予定の BookingCustomer の ID。予定の作成時に ID が指定されていない場合は、新しい bookingCustomer オブジェクトが作成されます。設定したら、 customerId を不変と考える必要があります。
customerLocation	location	予定を予約する BookingCustomer の位置情報を表します。
customerName	String	顧客の名前。
customerNotes	String	この予定に関連付けられている顧客からのメモ。値は、この BookingAppointment を ID で読み取る場合にのみ取得できます。このプロパティは、新しい顧客との予定を最初に作成する場合にのみ設定できます。その時点以降、値は customerId で表される顧客から計算されます。
customerPhone	String	顧客の電話番号。
顧客	bookingCustomerInformation コレクション	予定の顧客プロパティが一覧表示されます。予定には顧客情報の一覧が含まれており、各ユニットは、その予定の一部である顧客のプロパティを示します。省略可能です。
customerTimeZone	String	顧客のタイムゾーン。使用可能な値の一覧については、「 dateTimeTimeZone」を参照してください。
duration	期間	ISO8601形式で示される予定の長さ。
end	dateTimeTimeZone	予定が終了する日付、時刻、タイムゾーン。
invoiceAmount	倍精度浮動小数点数	請求書の請求金額。
invoiceDate	dateTimeTimeZone	この予定の請求書の日付、時刻、タイムゾーン。
invoiceId	String	請求書の ID。
invoiceStatus	文字列	請求書の状態。使用可能な値は、`draft`、、`reviewing`、`open`、`canceledpaid`、および `corrective`です。
isCustomerAllowedToManageBooking	ブール型	顧客がスタッフによって作成された予約を管理できることを示します。既定値は `false` です。
invoiceUrl	String	Microsoft Bookingsの請求書の URL。
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 コレクション	この予定に送信された顧客リマインダーのコレクション。このプロパティの値は、この BookingAppointment を ID で読み取る場合にのみ使用できます。
selfServiceAppointmentId	String	予定のもう 1 つの追跡 ID。予定がスケジュールページで顧客によって直接作成された場合、顧客の代わりにスタッフメンバーが作成した場合。
serviceId	String	この予定に関連付けられている BookingService の ID。
serviceLocation	location	サービスが配信される場所。
serviceName	String	この予定に関連付けられている BookingService の名前。このプロパティは、新しい予定を作成するときに省略可能です。指定しない場合は、 serviceId プロパティによって予定に関連付けられているサービスから計算されます。
serviceNotes	String	BookingStaffMember からのメモ。このプロパティの値は、この BookingAppointment を ID で読み取る場合にのみ使用できます。
smsNotificationsEnabled	ブール型	True は、SMS 通知が予定の顧客に送信されることを示します。既定値は `false` です。
staffMemberIds	String collection	この予定でスケジュールされている各 BookingStaffMember の ID。
開始	dateTimeTimeZone	予定が開始される日付、時刻、タイムゾーン。

注:

サービスで許可されている顧客の最大数 (maximumAttedeesCount) が 1 を超える場合:

顧客が予約カレンダーに存在することを確認します。作成しない場合は、 BookingCustomer の作成操作を使用して作成します。
予定を作成または更新するときに、有効な顧客 ID を渡します。顧客 ID が無効な場合、その顧客は予定オブジェクトに含まれません。

応答

成功した場合、このメソッドは 204 No Content 応答コードを返します。応答本文では何も返されません。

例

要求

次の例では、サービスの日付を 1 日ずつ変更し、請求書の日付を更新します。

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);

重要

Microsoft Graph SDK では、既定で v1.0 バージョンの API が使用され、ベータ版で使用可能なすべての型、プロパティ、API がサポートされているわけではありません。 SDK を使用してベータ API にアクセスする方法の詳細については、「ベータ API で Microsoft Graph SDK を使用する」を参照してください。

プロジェクトに SDK を追加し、authProvider インスタンスを作成する方法の詳細については、SDK のドキュメントを参照してください。



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 のドキュメントを参照してください。



// Code snippets are only available for the latest major version. Current major version is $v0.*

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

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)

// To initialize your graphClient, see https://learn.microsoft.com/en-us/graph/sdks/create-client?from=snippets&tabs=go
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\Beta\GraphServiceClient;
use Microsoft\Graph\Beta\Generated\Models\BookingAppointment;
use Microsoft\Graph\Beta\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_beta import GraphServiceClient
from msgraph_beta.generated.models.booking_appointment import BookingAppointment
from msgraph_beta.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 要求

オプションの要求ヘッダー

要求本文

応答

例

要求

応答

フィードバック

フィードバック

その他のリソース