bookingStaffMember resource type

Important

APIs under the /beta version in Microsoft Graph are subject to change. Use of these APIs in production applications is not supported.

Represents a staff member who provides services in a bookingBusiness.

Staff members can be part of the Office 355 tenant where the booking business is configured, or they can use email services from other email providers.

When booking appointments, the Bookings API considers the following settings to determine a staff member's availability:

  1. By default, the hours of operation of the business (the businessHours property of the bookingBusiness entity) represents the general availability of the staff member.
  2. If useBusinessHours is false, then the staff member's specific work hours (workingHours property of the bookingStaffmember entity) represents that member's general availability.
  3. If availabilityIsAffectedByPersonalCalendar is true, then the Bookings API would first look at the staff member's generally available hours (as determined by either #1 or #2), and verify availability during those hours in the staff member's personal calendar, before making a booking.

Methods

Method Return Type Description
List staff members bookingStaffMember collection Get a list of bookingStaffMember objects in the specified bookingbusiness.
Create bookingStaff bookingStaffMember collection Create a new bookingStaffMember in the specified bookingbusiness.
Get bookingStaffMember bookingStaffMember Get the properties and relationships of a bookingStaffMember in the specified bookingbusiness.
Update bookingStaffMember Update the properties of a bookingStaffMember in the specified bookingbusiness.
Delete None Delete a staff member in the specified bookingbusiness.

Properties

Property Type Description
availabilityIsAffectedByPersonalCalendar Boolean True means that if the staff member is an Office 365 user, the Bookings API would verify the staff member's availability in their personal calendar in Office 365, before making a booking.
colorIndex Int32 Identifies a color to represent the staff member. The color corresponds to the color palette in the Staff details page in the Bookings app.
displayName String The name of the staff member, as displayed to customers. Required.
emailAddress String The email address of the staff member. This can be in the same Office 365 tenant as the business, or in a different email domain. This email address can be used if the sendConfirmationsToOwner property is set to true in the scheduling policy of the business. Required.
id String The ID of the staff member, in a GUID format. Read-only.
role string The role of the staff member in the business. Possible values are: guest, administrator, viewer, externalGuest. Required.
useBusinessHours Boolean True means the staff member's availability is as specified in the businessHours property of the business. False means the availability is determined by the staff member's workingHours property setting.
workingHours bookingWorkHours collection The range of hours each day of the week that the staff member is available for booking. By default, they are initialized to be the same as the businessHours property of the business.

Relationships

None

JSON representation

The following is a JSON representation of the resource.

{
  "availabilityIsAffectedByPersonalCalendar": true,
  "colorIndex": 1024,
  "displayName": "String",
  "emailAddress": "String",
  "id": "String (identifier)",
  "role": "string",
  "useBusinessHours": true,
  "workingHours": [{"@odata.type": "microsoft.graph.bookingWorkHours"}]
}