予定あり/予定なし照会

    指定ユーザー基本カレンダーの予定あり/予定なし情報を照会します。

    APIの種類

    サービスAPI

    Request URL

    https://apis.worksmobile.com/r/{API_ID}/calendar/v2/users/me/freeBusy

    HTTP Method

    GET

    Query Parameters

    パラメータ タイプ 必須 説明
    accountIdList List<String> Y ユーザーアカウントIDリスト。
    最大30件まで処理できます。
    date String N 照会対象日(yyyyMMdd)。
    空の値の場合は「今日」に設定されます。
    freeBusyType String N 照会タイプ(大文字)
    ● FREE: 予定のない時間を返します(既定値)。
    ● BUSY: 予定のある時間を返します。

    Response

    プロパティ タイプ 必須 説明
    result String Y API呼び出し成功
    code Integer Y HTTPステータスコード
    returnValue List Y 予定あり/予定なし情報のオブジェクトリスト
    accountId String Y 照会対象者のaccountId
    freeBusyMask Object Y 予定あり/予定なし情報が保存されたオブジェクト
      freeBusyMask.fbType.name String Y FBTYPE(固定値)
      freeBusyMask.fbType.value String Y FREEまたはBUSY
      ranges List Y FREEまたはBUSY期間のリスト
      ranges.from.epochSecond Long Y FREEまたはBUSY期間の開始時間。UNIX時間で表示(単位:sec)。
      ranges.from.nano Long Y FREEまたはBUSY期間の開始時間。UNIX時間で表示(単位:nanosec)。
      ranges.until.epochSecond Long Y FREEまたはBUSY期間の終了時間。UNIX時間で表示(単位:sec)。
      ranges.until.nano Long Y FREEまたはBUSY期間の終了時間。UNIX時間で表示(単位:nanosec)。
      viewRange Object Y FREEまたはBUSY期間の照会対象の範囲
      viewRange.from.epochSecond Long Y FREEまたはBUSY期間の照会対象範囲の開始時間。UNIX時間で表示(単位:sec)。
      viewRange.from.nano Long Y FREEまたはBUSY期間の照会対象範囲の開始時間。UNIX時間で表示(単位:nanosec)。
      viewRange.until.epochSecond Long Y FREEまたはBUSY期間の照会対象範囲の終了時間。UNIX時間で表示(単位:sec)。
      viewRange.until.nano Long Y FREEまたはBUSY期間の照会対象範囲の終了時間。UNIX時間で表示(単位:nanosec)。

    Response Example

    {
        "result": "success",
        "code": 200,
        "returnValue": [
            {
                "accountId": "99152397210@individual.com",
                "freeBusyMask": {
                    "fbType": {
                        "value": "FREE",
                        "name": "FBTYPE",
                        "factory": {
                            "supportedNames": [
                                "FBTYPE"
                            ]
                        }
                    },
                    "ranges": [
                        {
                            "from": {
                                "seconds": 1546354800,
                                "nanos": 0
                            },
                            "until": {
                                "seconds": 1546441200,
                                "nanos": 0
                            }
                        }
                    ],
                    "viewRange": {
                        "from": {
                            "seconds": 1546354800,
                            "nanos": 0
                        },
                        "until": {
                            "seconds": 1546441200,
                            "nanos": 0
                        }
                    }
                }
            }
        ]
    }
    

    Error Code

    HTTPステータス エラーコード 説明
    400 BAD_REQUEST 不正なリクエスト
    403 FORBIDDEN 権限のないリソースへのアクセス
    404 NOT_FOUND 対象リソースがない
    500 INTERNAL_SERVER_ERROR 内部エラー