bookingsBusiness: getStaffAvailability

名前空間: microsoft.graph

Microsoft Bookings予定表のスタッフ メンバーの空き時間情報を取得します。

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

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

アクセス許可

この API の最小特権としてマークされているアクセス許可またはアクセス許可を選択します。 アプリで必要な場合にのみ、より高い特権のアクセス許可またはアクセス許可を使用します。 委任されたアクセス許可とアプリケーションのアクセス許可の詳細については、「 アクセス許可の種類」を参照してください。 これらのアクセス許可の詳細については、 アクセス許可のリファレンスを参照してください。

アクセス許可の種類	最小特権アクセス許可	特権の高いアクセス許可
委任 (職場または学校のアカウント)	サポートされていません。	サポートされていません。
委任 (個人用 Microsoft アカウント)	サポートされていません。	サポートされていません。
アプリケーション	Bookings.Read.All	Bookings。Manage.All、Bookings。ReadWrite.All、Calendars.Read、Calendars.ReadWrite

HTTP 要求

POST /solutions/bookingBusinesses/{id}/getStaffAvailability

要求ヘッダー

名前	説明
Authorization	ベアラー {code}。 必須です。
Content-Type	application/json. 必須です。

要求本文

要求本文で、スタッフ ID の一覧と、startDateTime と endDateTime という dateTimeTimeZone リソースの種類の他の 2 つのパラメーターを渡します。 これらは、スタッフの可用性が返される 2 つのタイムスタンプに対応します。

応答

成功した場合、このメソッドは 200 OK 応答コードと、応答の staffAvailabilityItem コレクションを返します。

例

要求

次の例は要求を示しています。

HTTP

POST https://graph.microsoft.com/v1.0/solutions/bookingBusinesses/Contosolunchdelivery@contoso.com/getStaffAvailability
Content-Type: application/json

{
    "staffIds": [
        "311a5454-08b2-4560-ba1c-f715e938cb79"
    ],
    "startDateTime": {
        "dateTime": "2022-01-25T00:00:00",
        "timeZone": "India Standard Time"
    },
    "endDateTime": {
        "dateTime": "2022-01-26T17:00:00",
        "timeZone": "Pacific Standard Time"
    }
}

C#

// Code snippets are only available for the latest version. Current version is 5.x

// Dependencies
using Microsoft.Graph.Solutions.BookingBusinesses.Item.GetStaffAvailability;
using Microsoft.Graph.Models;

var requestBody = new GetStaffAvailabilityPostRequestBody
{
	StaffIds = new List<string>
	{
		"311a5454-08b2-4560-ba1c-f715e938cb79",
	},
	StartDateTime = new DateTimeTimeZone
	{
		DateTime = "2022-01-25T00:00:00",
		TimeZone = "India Standard Time",
	},
	EndDateTime = new DateTimeTimeZone
	{
		DateTime = "2022-01-26T17:00:00",
		TimeZone = "Pacific Standard Time",
	},
};

// 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}"].GetStaffAvailability.PostAsGetStaffAvailabilityPostResponseAsync(requestBody);

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

CLI

// THE CLI IS IN PREVIEW. NON-PRODUCTION USE ONLY
mgc solutions booking-businesses get-staff-availability post --booking-business-id {bookingBusiness-id} --body '{\
    "staffIds": [\
        "311a5454-08b2-4560-ba1c-f715e938cb79"\
    ],\
    "startDateTime": {\
        "dateTime": "2022-01-25T00:00:00",\
        "timeZone": "India Standard Time"\
    },\
    "endDateTime": {\
        "dateTime": "2022-01-26T17:00:00",\
        "timeZone": "Pacific Standard Time"\
    }\
}\
'

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

Go

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

graphClient := msgraphsdk.NewGraphServiceClientWithCredentials(cred, scopes)


requestBody := graphsolutions.NewGetStaffAvailabilityPostRequestBody()
staffIds := []string {
	"311a5454-08b2-4560-ba1c-f715e938cb79",
}
requestBody.SetStaffIds(staffIds)
startDateTime := graphmodels.NewDateTimeTimeZone()
dateTime := "2022-01-25T00:00:00"
startDateTime.SetDateTime(&dateTime) 
timeZone := "India Standard Time"
startDateTime.SetTimeZone(&timeZone) 
requestBody.SetStartDateTime(startDateTime)
endDateTime := graphmodels.NewDateTimeTimeZone()
dateTime := "2022-01-26T17:00:00"
endDateTime.SetDateTime(&dateTime) 
timeZone := "Pacific Standard Time"
endDateTime.SetTimeZone(&timeZone) 
requestBody.SetEndDateTime(endDateTime)

getStaffAvailability, err := graphClient.Solutions().BookingBusinesses().ByBookingBusinessId("bookingBusiness-id").GetStaffAvailability().PostAsGetStaffAvailabilityPostResponse(context.Background(), requestBody, nil)

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

Java

// Code snippets are only available for the latest version. Current version is 6.x

GraphServiceClient graphClient = new GraphServiceClient(requestAdapter);

com.microsoft.graph.solutions.bookingbusinesses.item.getstaffavailability.GetStaffAvailabilityPostRequestBody getStaffAvailabilityPostRequestBody = new com.microsoft.graph.solutions.bookingbusinesses.item.getstaffavailability.GetStaffAvailabilityPostRequestBody();
LinkedList<String> staffIds = new LinkedList<String>();
staffIds.add("311a5454-08b2-4560-ba1c-f715e938cb79");
getStaffAvailabilityPostRequestBody.setStaffIds(staffIds);
DateTimeTimeZone startDateTime = new DateTimeTimeZone();
startDateTime.setDateTime("2022-01-25T00:00:00");
startDateTime.setTimeZone("India Standard Time");
getStaffAvailabilityPostRequestBody.setStartDateTime(startDateTime);
DateTimeTimeZone endDateTime = new DateTimeTimeZone();
endDateTime.setDateTime("2022-01-26T17:00:00");
endDateTime.setTimeZone("Pacific Standard Time");
getStaffAvailabilityPostRequestBody.setEndDateTime(endDateTime);
var result = graphClient.solutions().bookingBusinesses().byBookingBusinessId("{bookingBusiness-id}").getStaffAvailability().post(getStaffAvailabilityPostRequestBody);

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

JavaScript

const options = {
	authProvider,
};

const client = Client.init(options);

const staffAvailabilityItem = {
    staffIds: [
        '311a5454-08b2-4560-ba1c-f715e938cb79'
    ],
    startDateTime: {
        dateTime: '2022-01-25T00:00:00',
        timeZone: 'India Standard Time'
    },
    endDateTime: {
        dateTime: '2022-01-26T17:00:00',
        timeZone: 'Pacific Standard Time'
    }
};

await client.api('/solutions/bookingBusinesses/Contosolunchdelivery@contoso.com/getStaffAvailability')
	.post(staffAvailabilityItem);

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

PHP

<?php
use Microsoft\Graph\GraphServiceClient;
use Microsoft\Graph\Generated\Models\GetStaffAvailabilityPostRequestBody;
use Microsoft\Graph\Generated\Models\DateTimeTimeZone;


$graphServiceClient = new GraphServiceClient($tokenRequestContext, $scopes);

$requestBody = new GetStaffAvailabilityPostRequestBody();
$requestBody->setStaffIds(['311a5454-08b2-4560-ba1c-f715e938cb79', 	]);
$startDateTime = new DateTimeTimeZone();
$startDateTime->setDateTime('2022-01-25T00:00:00');
$startDateTime->setTimeZone('India Standard Time');
$requestBody->setStartDateTime($startDateTime);
$endDateTime = new DateTimeTimeZone();
$endDateTime->setDateTime('2022-01-26T17:00:00');
$endDateTime->setTimeZone('Pacific Standard Time');
$requestBody->setEndDateTime($endDateTime);

$result = $graphServiceClient->solutions()->bookingBusinesses()->byBookingBusinessId('bookingBusiness-id')->getStaffAvailability()->post($requestBody)->wait();

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

PowerShell

Import-Module Microsoft.Graph.Bookings

$params = @{
	staffIds = @(
	"311a5454-08b2-4560-ba1c-f715e938cb79"
)
startDateTime = @{
	dateTime = "2022-01-25T00:00:00"
	timeZone = "India Standard Time"
}
endDateTime = @{
	dateTime = "2022-01-26T17:00:00"
	timeZone = "Pacific Standard Time"
}
}

Get-MgBookingBusinessStaffAvailability -BookingBusinessId $bookingBusinessId -BodyParameter $params

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

Python

from msgraph import GraphServiceClient
from msgraph.generated.models.get_staff_availability_post_request_body import GetStaffAvailabilityPostRequestBody
from msgraph.generated.models.date_time_time_zone import DateTimeTimeZone

graph_client = GraphServiceClient(credentials, scopes)

request_body = GetStaffAvailabilityPostRequestBody(
	staff_ids = [
		"311a5454-08b2-4560-ba1c-f715e938cb79",
	],
	start_date_time = DateTimeTimeZone(
		date_time = "2022-01-25T00:00:00",
		time_zone = "India Standard Time",
	),
	end_date_time = DateTimeTimeZone(
		date_time = "2022-01-26T17:00:00",
		time_zone = "Pacific Standard Time",
	),
)

result = await graph_client.solutions.booking_businesses.by_booking_business_id('bookingBusiness-id').get_staff_availability.post(request_body)

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

応答

次の例は応答を示しています。

HTTP/1.1 200 OK
Content-type: application/json

{
    "staffAvailabilityItem": [
        {
            "staffId": "311a5454-08b2-4560-ba1c-f715e938cb79",
            "availabilityItems": [
                {
                    "status": "Available",
                    "startDateTime": {
                        "dateTime": "2022-01-24T08:00:00",
                        "timeZone": "(UTC-08:00) Pacific Time (US & Canada)"
                    },
                    "endDateTime": {
                        "dateTime": "2022-01-24T15:00:00",
                        "timeZone": "(UTC-08:00) Pacific Time (US & Canada)"
                    },
                    "serviceId": ""
                },
                {
                    "status": "Busy",
                    "startDateTime": {
                        "dateTime": "2022-01-24T15:00:00",
                        "timeZone": "(UTC-08:00) Pacific Time (US & Canada)"
                    },
                    "endDateTime": {
                        "dateTime": "2022-01-24T16:00:00",
                        "timeZone": "(UTC-08:00) Pacific Time (US & Canada)"
                    },
                    "serviceId": "57da6774-a087-4d69-b0e6-6fb82c339976"
                },
                {
                    "status": "Available",
                    "startDateTime": {
                        "dateTime": "2022-01-24T16:00:00",
                        "timeZone": "(UTC-08:00) Pacific Time (US & Canada)"
                    },
                    "endDateTime": {
                        "dateTime": "2022-01-24T17:00:00",
                        "timeZone": "(UTC-08:00) Pacific Time (US & Canada)"
                    },
                    "serviceId": ""
                },
                {
                    "status": "Available",
                    "startDateTime": {
                        "dateTime": "2022-01-25T08:00:00",
                        "timeZone": "(UTC-08:00) Pacific Time (US & Canada)"
                    },
                    "endDateTime": {
                        "dateTime": "2022-01-25T17:00:00",
                        "timeZone": "(UTC-08:00) Pacific Time (US & Canada)"
                    },
                    "serviceId": ""
                },
                {
                    "status": "Available",
                    "startDateTime": {
                        "dateTime": "2022-01-26T08:00:00",
                        "timeZone": "(UTC-08:00) Pacific Time (US & Canada)"
                    },
                    "endDateTime": {
                        "dateTime": "2022-01-26T17:00:00",
                        "timeZone": "(UTC-08:00) Pacific Time (US & Canada)"
                    },
                    "serviceId": ""
                }
            ]
        }
    ]
}