bookingBusiness 资源类型bookingBusiness resource type

重要

Microsoft Graph 中/beta的版本下的 api 可能会发生更改。APIs under the /beta version in Microsoft Graph are subject to change. 不支持在生产应用程序中使用这些 API。Use of these APIs in production applications is not supported.

表示 Microsoft 预订中的企业。Represents a business in Microsoft Bookings. 这是 Microsoft 记帐 API 中的顶级对象。This is the top level object in the Microsoft Bookings API. 它包含业务信息和相关业务对象, 如约会、客户、服务和员工成员。It contains business information and related business objects such as appointments, customers, services, and staff members.

方法Methods

方法Method 返回类型Return Type 说明Description
列出 ErrorexceededfindcountlimitList bookingBusinesses bookingBusiness集合bookingBusiness collection 获取租户中的 bookingbusiness 对象的集合。Get a collection of bookingbusiness objects in the tenant.
创建 bookingBusinessCreate bookingBusiness bookingBusinessbookingBusiness 创建新的 Microsoft 预订业务。Create a new Microsoft Bookings business.
获取 bookingBusinessGet bookingBusiness bookingBusinessbookingBusiness 读取 bookingBusiness 对象的属性和关系。Read properties and relationships of bookingBusiness object.
更新Update bookingBusinessbookingBusiness 更新bookingBusiness对象中的属性。Update properties in a bookingBusiness object.
删除Delete None 删除bookingBusiness对象。Delete a bookingBusiness object.
创建 bookingAppointmentCreate bookingAppointment bookingAppointmentbookingAppointment 通过发布到 "约会" 集合创建新的 bookingAppointment。Create a new bookingAppointment by posting to the appointments collection.
列出约会List appointments bookingAppointment集合bookingAppointment collection 获取 bookingAppointment 对象集合。Get a bookingAppointment object collection.
创建 bookingCustomerCreate bookingCustomer bookingCustomerbookingCustomer 通过发布到 "客户" 集合创建新的 bookingCustomer。Create a new bookingCustomer by posting to the customers collection.
列出客户List customers bookingCustomer集合bookingCustomer collection 获取 bookingCustomer 对象集合。Get a bookingCustomer object collection.
创建 bookingServiceCreate bookingService bookingServicebookingService 通过发布到服务集合创建新的 bookingService。Create a new bookingService by posting to the services collection.
列出服务List services bookingService集合bookingService collection 获取 bookingService 对象集合。Get a bookingService object collection.
创建 bookingStaffMemberCreate bookingStaffMember bookingStaffMemberbookingStaffMember 通过发布到 staffMembers 集合创建新的 bookingStaffMember。Create a new bookingStaffMember by posting to the staffMembers collection.
列出 staffMembersList staffMembers bookingStaffMember集合bookingStaffMember collection 获取 bookingStaffMember 对象集合。Get a bookingStaffMember object collection.
列出 calendarViewList calendarView bookingAppointment集合bookingAppointment collection 获取在指定日期范围内发生的bookingAppointment对象的集合。Get the collection of bookingAppointment objects that occurs in the specified date range.
发布publish None 使此业务的日程安排页面对外部客户可用。Make the scheduling page of this business available to external customers. isPublished属性设置为 true, 并将publicUrl属性设置为计划页面的 URL。Set the isPublished property to true, and publicUrl property to the URL of the scheduling page.
取消发布unpublish None 使此业务的计划页面对外部客户不可用。Make the scheduling page of this business not available to external customers. isPublished属性设置为 false, 并将publicUrl属性设置为 null。Set the isPublished property to false, and publicUrl property to null.

属性Properties

属性Property 类型Type 说明Description
addressaddress physicalAddressphysicalAddress 企业的街道地址。The street address of the business. Address属性以及手机webSiteUrl将显示在 "业务计划" 页的页脚中。The address property, together with phone and webSiteUrl, appear in the footer of a business scheduling page.
businessHoursbusinessHours bookingWorkHours集合bookingWorkHours collection 业务的运行时间。The hours of operation for the business.
businessTypebusinessType StringString 企业的类型。The type of business.
defaultCurrencyIsodefaultCurrencyIso StringString 业务在 Microsoft 预订中所运行的货币的代码。The code for the currency that the business operates in on Microsoft Bookings.
displayNamedisplayName 字符串String 业务的名称, 与客户的接口。The name of the business, which interfaces with customers. 此名称显示在 "业务计划" 页的顶部。This name appears at the top of the business scheduling page.
emailemail StringString 企业的电子邮件地址。The email address for the business.
idid 字符串String 企业的唯一编程标识符。A unique programmatic identifier for the business. 只读。Read-only.
isPublishedisPublished BooleanBoolean 计划页面已提供给外部客户。The scheduling page has been made available to external customers. 使用 "发布" 和 "取消发布" 操作设置此属性。Use the publish and unpublish actions to set this property. 只读。Read-only.
phonephone StringString 企业的电话号码。The telephone number for the business. Phone属性, 以及addresswebSiteUrl将显示在 "业务计划" 页的页脚中。The phone property, together with address and webSiteUrl, appear in the footer of a business scheduling page.
publicUrlpublicUrl StringString 计划页面的 URL, 在发布取消发布页面之后设置。The URL for the scheduling page, which is set after you publish or unpublish the page. 只读。Read-only.
schedulingPolicyschedulingPolicy bookingSchedulingPolicybookingSchedulingPolicy 指定如何为此公司创建预订。Specifies how bookings can be created for this business.
webSiteUrlwebSiteUrl StringString 业务网站的 URL。The URL of the business web site. WebSiteUrl属性 (与addressphone) 显示在 "业务计划" 页的页脚中。The webSiteUrl property, together with address, phone, appear in the footer of a business scheduling page.

关系Relationships

关系Relationship 类型Type 说明Description
appointmentsappointments bookingAppointment集合bookingAppointment collection 此业务的所有约会。All the appointments of this business. 只读。Read-only. 可为 Null。Nullable.
calendarViewcalendarView bookingAppointment集合bookingAppointment collection 在指定日期范围内此公司的一组约会。The set of appointments of this business in a specified date range. 只读。Read-only. 可为 Null。Nullable.
各地customers bookingCustomer集合bookingCustomer collection 此业务的所有客户。All the customers of this business. 只读。Read-only. 可为 Null。Nullable.
服务行业services bookingService集合bookingService collection 此业务提供的所有服务。All the services offered by this business. 只读。Read-only. 可为 Null。Nullable.
staffMembersstaffMembers bookingStaffMember集合bookingStaffMember collection 在此公司中提供服务的所有教职员工成员。All the staff members that provide services in this business. 只读。Read-only. 可为 Null。Nullable.

JSON 表示形式JSON representation

下面是资源的 JSON 表示形式。The following is a JSON representation of the resource.

{
  "address": {"@odata.type": "microsoft.graph.physicalAddress"},
  "businessHours": [{"@odata.type": "microsoft.graph.bookingWorkHours"}],
  "businessType": "String",
  "defaultCurrencyIso": "String",
  "displayName": "String",
  "email": "String",
  "id": "String (identifier)",
  "isPublished": true,
  "phone": "String",
  "publicUrl": "String",
  "schedulingPolicy": {"@odata.type": "microsoft.graph.bookingSchedulingPolicy"},
  "webSiteUrl": "String"
}

另请参阅See also