予定リスト閲覧

    特定カレンダーの予定を日付単位で閲覧します。閲覧可能な範囲は最大 30 日です。

    API の種類

    サービス API

    Request URL

    https://apis.worksmobile.com/r/{API_ID}/calendar/v2/users/me/calendars/{calendarId}/events

    HTTP Method

    GET

    Path Parameters

    パラメータ タイプ 必須 説明
    calendarId String Y カレンダー ID
    'defaultCalendarId'を入力すると基本カレンダー

    Query Parameters

    パラメータ タイプ 必須 説明
    rangeDateFrom String Y 開始日(yyyyMMdd)。
    この日は閲覧範囲に含む
    rangeDateUntil String Y 終了日(yyyyMMdd)。
    この日は閲覧範囲には含まない。最大 30 日間

    Response

    プロパティ タイプ 必須 説明
    result String Y API 呼び出し結果
    code Integer Y HTTP ステータスコード
    returnValue List Y 予定リスト
         accountId String Y アカウント情報
    アドバンスト/ベーシック/プレミアムプランで利用している場合には、メールアドレスと同じ。
    他のプランで利用している場合には、ID@グループ名。
         calendarId String Y カレンダー ID
         ical String Y iCalendar 形式の予定情報
         viewUrl String Y 予定情報を閲覧できる URL

    Response Example

    {
    "result": "success",
    "code": 200,
    "returnValue": [
        {
            "accountId": "testEmail@worksmobile.com",
            "calendarId": "8a5ae051-0f5b-4937-b243-7f28f4f758e8",
            "ical": "BEGIN:VCALENDAR\r\nVERSION:2.0\r\nPRODID:-//Michael Angstadt//biweekly 0.4.2//EN\r\nBEGIN:VEVENT\r\nDTSTAMP:20191008T080713Z\r\nUID:test_createSchedule_c30660ce-bb9f-47f5-9347-f927fd73d7a9\r\nSUMMARY:summary\r\nDTSTART:20181231T150000Z\r\nDTEND:20181231T160000Z\r\nSEQUENCE:0\r\nX-NAVER-REGISTERER;X-WORKSMOBILE-WID\u003d99976234990;CUTYPE\u003dINDIVIDUAL:\r\nCREATED:20191008T080713Z\r\nLAST-MODIFIED:20191008T080713Z\r\nX-NAVER-LAST-MODIFIER;X-WORKSMOBILE-WID\u003d99976234990;CUTYPE\u003dINDIVIDUAL;CN\u003dnameOf_99976234990:\r\nEND:VEVENT\r\nEND:VCALENDAR\r\n",
            "viewUrl": "https://calendar.worksmobile.com/permanentLink.nhn?url\u003dhttps://calendar.worksmobile.com/schedule.nhn#%7B%22sSection%22:%22scheduleEdit%22,%22oParameter%22:%7B%22sAction%22:%22modify%22,%22calendarId%22:%228a5ae051-0f5b-4937-b243-7f28f4f758e8%22,%22scheduleUid%22:%22test_createSchedule_c30660ce-bb9f-47f5-9347-f927fd73d7a9%22,%22scheduleId%22:%22test_createSchedule_c30660ce-bb9f-47f5-9347-f927fd73d7a9%22,%22selectedDate%22:%222018-12-31%2015:00:00%22%7D%7D"
        }
    ]
}

    Error Code

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