カレンダー照会
ログインしたユーザーアカウントの持つ特定のカレンダーを照会します。
APIの種類
サービスAPI
Request URL
https://apis.worksmobile.com/r/{API_ID}/calendar/v3/users/me/calendarList/{calendarId}
HTTP Method
GET
Path Parameters
パラメータ | タイプ | 必須 | 説明 |
---|---|---|---|
calendarId | String | Y | カレンダーID |
Response
プロパティ | タイプ | 必須 | 説明 |
---|---|---|---|
calendarUid | String | Y | カレンダーID |
displayName | String | Y | カレンダー名 |
description | String | Y | カレンダー説明 |
ctag | String | Y | カレンダー更新日時(UTC:yyyyMMddHHmmss) |
color | String | Y | カレンダーの色 |
dateAlarm | String | Y | 終日予定の通知時間の既定値 |
dateTimeAlarm | String | N | 予定の通知時間の既定値 |
defaultReminderMedia | List | Y | 既定の通知方法 enumのvalue: MAIL, POPUP |
showContent | boolean | Y | ブラウザ版でこのカレンダーの予定を表示するかどうか |
showOnList | boolean | Y | カレンダーリストに表示するかどうか |
isDefaultCalendar | boolean | Y | 閲覧するユーザーの基本カレンダーかどうか |
isSharedCalendar | boolean | Y | オーナーが共有したカレンダーかどうか |
calendarMembers | List | Y | カレンダーを共有するメンバーリスト |
member | Map | Y | メンバー Mapのkey: type, accountId |
roleId | Integer | Y | 権限タイプ 1: カレンダーマスター 2: カレンダーおよび予定の管理 3: 予定の管理 4: 予定の詳細を閲覧 8: 予定の時間枠のみ閲覧 |
status | String | Y | メンバーの状態(承諾、未定、辞退) |
- memberのタイプはカレンダーのメンバータイプです。
- カレンダーのメンバータイプは、下記の通りです。
type | 説明 |
---|---|
INDIVIDUAL | 個人 |
MAILING_LIST | グループ |
GROUP | 組織 |
DOMAIN | ドメイン |
TENANT | テナント |
Response Example
{
"calendarUid": "2f66dbb2-0db7-4f3a-9164-07b08b40362e",
"displayName": "nameOf_99517579704",
"description": "",
"ctag": "20201103110516",
"color": "#FF9C71",
"dateAlarm": "-PT12H",
"dateTimeAlarm": "-PT10M",
"defaultReminderMedia": [
"MAIL",
"POPUP"
],
"showContent": true,
"showOnList": true,
"isDefaultCalendar": true,
"isSharedCalendar": false,
"calendarMembers": [
{
"member": {
"accountId": "99517579704@individual.com",
"type": "INDIVIDUAL"
},
"roleId": 1,
"status": "ACCEPT"
}
]
}
Error Code
HTTPステータス | エラーコード | 説明 |
---|---|---|
400 | BAD_REQUEST | 不正なリクエスト |
403 | FORBIDDEN | 権限のないリソースへのアクセス |
404 | NOT_FOUND | 対象リソースがない |
500 | INTERNAL_SERVER_ERROR | 内部エラー |