bookingAppointment リソースの種類
名前空間: microsoft.graph
重要
Microsoft Graph の /beta バージョンの API は変更される可能性があります。 実稼働アプリケーションでこれらの API を使用することは、サポートされていません。 v1.0 で API を使用できるかどうかを確認するには、Version セレクターを使用します。
Microsoft Bookings ビジネスによって提供される一連のスタッフ メンバーによって実行される BookingService の顧客の予定を表します。
メソッド
| メソッド | 戻り値の型 | 説明 |
|---|---|---|
| List | bookingAppointment コレクション | 指定した BookingBusiness 内の BookingAppointment オブジェクトの一覧を取得します。 |
| Create | bookingAppointment | 指定した bookingbusiness の新しい bookingAppointment を作成します。 |
| Get | bookingAppointment | bookingAppointment オブジェクトのプロパティとリレーションシップを読み取ります。 |
| Update | bookingAppointment | BookingAppointment オブジェクトを更新します。 |
| Delete | なし | BookingAppointment オブジェクトを削除します。 |
| 予定のキャンセル | なし | BookingAppointment オブジェクトを取り消します。 |
プロパティ
| プロパティ | 型 | 説明 |
|---|---|---|
| additionalInformation | String | 予定が確認されたときに顧客に送信される追加情報。 |
| anonymousJoinWebUrl | String | 匿名で参加する会議の URL。 |
| appointmentLabel | String | ユーザーは、予定にカスタム ラベルをスタンプできます。 |
| createdDateTime | DateTimeOffset | 予定が作成された日付、時刻、タイム ゾーン。 |
| customerEmailAddress | String | 予約を予約している BookingCustomer の SMTP アドレス。 |
| customerId | String | この予定の BookingCustomer の ID。 予定の作成時に ID が指定されていない場合は、新しい bookingCustomer オブジェクトが作成されます。 設定したら、 customerId を不変と考える必要があります。 |
| customerLocation | location | 予定を予約する BookingCustomer の位置情報を表します。 |
| customerName | String | 顧客の名前。 |
| customerNotes | String | この予定に関連付けられている顧客からのメモ。 値は、この BookingAppointment を ID で読み取った場合にのみ取得できます。 このプロパティは、最初に新しい顧客との予定を作成する場合にのみ設定できます。 |
| 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。 |
| isCustomerAllowedToManageBooking | ブール型 | 顧客がスタッフによって作成された予約を管理できることを示します。 既定値は false です。 |
| isLocationOnline | ブール型 | 予定がオンラインで開催されることを示します。 既定値は false です。 |
| joinWebUrl | String | 予定のオンライン会議の URL。 |
| lastUpdatedDateTime | DateTimeOffset | 予約ビジネスが最後に更新された日付、時刻、タイムゾーン。 |
| 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 コレクション | この予定に送信された顧客リマインダーのコレクション。 このプロパティの値は、この 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 | 予定が開始される日付、時刻、タイム ゾーン。 |
リレーションシップ
なし
JSON 表記
次の JSON 表現は、リソースの種類を示しています。
{
"@odata.type": "#microsoft.graph.bookingAppointment",
"id": "String (identifier)",
"createdDateTime": "String (timestamp)",
"lastUpdatedDateTime": "String (timestamp)",
"selfServiceAppointmentId": "String",
"additionalInformation": "String",
"appointmentLabel": "String",
"isLocationOnline": "Boolean",
"joinWebUrl": "String",
"smsNotificationsEnabled": "Boolean",
"customerId": "String",
"customerName": "String",
"customerEmailAddress": "String",
"customerPhone": "String",
"customerLocation": {
"@odata.type": "microsoft.graph.location"
},
"customerTimeZone": "String",
"customerNotes": "String",
"serviceId": "String",
"serviceName": "String",
"start": {
"@odata.type": "microsoft.graph.dateTimeTimeZone"
},
"end": {
"@odata.type": "microsoft.graph.dateTimeTimeZone"
},
"duration": "String (duration)",
"preBuffer": "String (duration)",
"postBuffer": "String (duration)",
"serviceLocation": {
"@odata.type": "microsoft.graph.location"
},
"priceType": "String",
"price": "Double",
"serviceNotes": "String",
"reminders": [
{
"@odata.type": "microsoft.graph.bookingReminder"
}
],
"optOutOfCustomerEmail": "Boolean",
"anonymousJoinWebUrl": "String",
"customers": [
{
"@odata.type": "microsoft.graph.bookingCustomerInformation"
}
],
"maximumAttendeesCount": "Int32",
"filledAttendeesCount": "Int32",
"staffMemberIds": [
"String"
],
"invoiceAmount": "Double",
"invoiceDate": {
"@odata.type": "microsoft.graph.dateTimeTimeZone"
},
"invoiceId": "String",
"invoiceStatus": "String",
"invoiceUrl": "String",
"isCustomerAllowedToManageBooking": "Boolean",
}