bookingAppointment リソースの種類

名前空間: microsoft.graph

重要

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

Microsoft Bookingsビジネスによって提供される一連のスタッフ メンバーによって実行される bookingService の顧客の予定を表します。

注意

アプリケーションのアクセス許可を使用してカスタム アプリを作成する場合は、 ビジネス ルールの検証に従う必要があります。

メソッド

メソッド	戻り値の型	説明
予定を一覧表示する	bookingAppointment コレクション	指定した Bookingbusiness 内の bookingAppointment オブジェクトの一覧を取得します。
bookingAppointment を作成する	bookingAppointment	指定した bookingbusiness の新しい bookingAppointment を作成します。
BookingAppointment を取得する	bookingAppointment	bookingAppointment オブジェクトのプロパティとリレーションシップを読み取ります。
Update	なし	bookingAppointment オブジェクトを更新します。
削除	なし	bookingAppointment オブジェクトを削除します。
Cancel	なし	bookingAppointment オブジェクトをキャンセルします。

プロパティ

プロパティ	種類	説明
additionalInformation	String	予定が確認されたときに顧客に送信される追加情報。
anonymousJoinWebUrl	String	匿名で参加する会議の URL。
customerEmailAddress	String	予定を予約している bookingCustomer の SMTP アドレス。
customerId	String	この 予定の bookingCustomer の ID。 予定の作成時に ID が指定されていない場合は、新しい bookingCustomer オブジェクトが作成されます。 設定したら、 customerId を変更できないと考える必要があります。
customerLocation	location	予定を予約している bookingCustomer の位置情報を表します。
customerName	String	顧客の名前。
customerNotes	String	この予定に関連付けられている顧客からのメモ。 この値は、ID でこの bookingAppointment を 読み取る場合にのみ取得できます。 このプロパティは、最初に新しい顧客との予定を作成する場合にのみ設定できます。 その後、 customerId で表される顧客から値が計算されます。
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。
isLocationOnline	ブール値	True は、予定がオンラインで保持されることを示します。 既定値は False です。
joinWebUrl	String	予定のオンライン会議の URL。
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。
serviceId	String	この予定に関連付けられている bookingService の ID。
serviceLocation	location	サービスが配信される場所。
serviceName	String	この予定に関連付けられている bookingService の名前。 このプロパティは、新しい予定を作成するときに省略可能です。 指定しない場合は、予定に関連付けられているサービスから serviceId プロパティによって計算されます。
serviceNotes	String	bookingStaffMember からのメモ。 このプロパティの値は、ID でこの bookingAppointment を 読み取る場合にのみ使用できます。
smsNotificationsEnabled	ブール値	True は、携帯ショートメール通知が予定の顧客に送信されることを示します。 既定値は False です。
staffMemberIds	String collection	この予定でスケジュールされている各 bookingStaffMember の ID。
開始	dateTimeTimeZone	予定が開始される日付、時刻、タイム ゾーン。

リレーションシップ

なし。

JSON 表記

リソースの JSON 表記を次に示します。

{
  "customerEmailAddress": "String",
  "customerId": "String",
  "customerLocation": {"@odata.type": "microsoft.graph.location"},
  "customerName": "String",
  "customerNotes": "String",
  "customerPhone": "String",
  "customerTimeZone": "String",
  "customers": [
    {
      "@odata.type": "microsoft.graph.bookingCustomerInformation"
    }
  ],
  "duration": "String (timestamp)",
  "end": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "id": "String (identifier)",
  "invoiceAmount": 1024,
  "invoiceDate": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "invoiceId": "String",
  "invoiceStatus": "string",
  "invoiceUrl": "String",
  "isLocationOnline": "Boolean",
  "joinWebUrl": "String",
  "optOutOfCustomerEmail": true,
  "anonymousJoinWebUrl": "String",
  "postBuffer": "String (timestamp)",
  "preBuffer": "String (timestamp)",
  "price": 1024,
  "priceType": {"@odata.type": "microsoft.graph.bookingPriceType"},
  "reminders": [{"@odata.type": "microsoft.graph.bookingReminder"}],
  "selfServiceAppointmentId": "String",
  "serviceId": "String",
  "serviceLocation": {"@odata.type": "microsoft.graph.location"},
  "serviceName": "String",
  "serviceNotes": "String",
  "smsNotificationsEnabled": "Boolean",
  "staffMemberIds": ["String"],
  "start": {"@odata.type": "microsoft.graph.dateTimeTimeZone"},
  "maximumAttendeesCount": "Integer",
  "filledAttendeesCount": "Integer"
}