プロパティ
| プロパティ名 | データ型 | 項目 | 参照のみ |
|---|---|---|---|
| id | integer | ID | ○ |
| name | string | 予定名 ※認可スタッフの閲覧権限のない予定では取得不可 | |
| description | string | 説明 ※認可スタッフの閲覧権限のない予定では取得不可 | |
| type | string | 予定タイプ*1 | ○ |
| creator | User | 作成者*2 ※認可スタッフの閲覧権限のない予定では取得不可 | ○ |
| start_datetime | datetime | 開始日時 | |
| end_datetime | datetime | 終了日時 | |
| is_all_day | boolean | 終日の予定か | |
| is_public | boolean | 公開されている予定か ※デフォルトはtrue | |
| is_opaque | boolean | 非公開の場合に表示する設定になっているか ※ is_public=false の場合のみ有効 ※デフォルトはtrue | |
| invite_status | string | 認可ユーザーの招待ステータス 認可ユーザーが招待されていない予定や、認可ユーザー以外のユーザーの予定リストの取得時にはレスポンスに含まれません*3 | ○ |
| repeatable | object | 繰り返しルール*4 | ○ |
| facilities | list | 利用施設IDリスト | |
| users | list | 参加スタッフIDリスト | |
| groups | list | 参加スタッフグループIDリスト | |
| parent_event | Event | 繰り返し予定から派生した予定の場合は親予定 | |
| created_datetime | datetime | 作成日時 | ○ |
| updated_datetime | datetime | 更新日時 | ○ |
*1 typeでは以下の値を返します。
| 値 | 説明 |
|---|---|
| normal | 通常予定 |
*2 creatorでは以下の値を返します。
| 値 | 説明 |
|---|---|
| id | user_idの値 |
| name | ユーザー名 ※フルネーム |
| last_name | 苗字の値 |
| last_name_kana | 苗字の値（カナ） |
| first_name | 名の値 |
| first_name_kana | 名の値（カナ） |
| full_name | ユーザー名 ※フルネーム |
| full_name_kana | ユーザー名（カナ） ※フルネーム |
| memo | メモ値 |
| role | ユーザータイプ |
| mail_address1 | メールアドレス値 |
| mail_address2 | サブメールアドレス値 |
*3 invite_statusでは以下の値を返します。
| 値 | 説明 |
|---|---|
| unknown | 未回答 |
| accepted | 参加 |
| declined | 不参加 |
*4 繰り返しありの予定では、repeat_ruleとして以下のJSONデータを返します。
| プロパティ名 | データ型 | 項目 | 参照のみ |
|---|---|---|---|
| frequency | string | 繰り返し頻度 | |
| stop_date | date | 繰り返し終了日時 | |
| interval | integer | 繰り返し間隔 | |
| month_day_list | list | 月ごとに特定の日付で繰り返す場合、その日付のリスト | |
| day_list | list | 週ごとや月ごとの特定曜日の繰り返しの場合、その曜日番号及び週インデックスのオブジェクトリスト ※週インデックスは月繰り返しの場合のみ ※0:月～6:日 | |
| exdates | list | 繰り返しの除外日リスト ※["YYYY-MM-DD"] |
メソッド
| メソッド名 | HTTPメソッド | パス | 処理 |
|---|---|---|---|
| リスト | GET | /events/ | 予定のリストを返す ※レスポンスには予約も含まれる |
| 取得 | GET | /events/[event_id] | 指定された予定の要素を取得する ※予約にも対応しているが、予約特有のプロパティには非対応 |
| 作成 | POST | /events/ | 予定を作成する |
| 変更 | PUT | /events/[event_id] | 指定された予定情報を変更する（全項目差し替え） ※予約は変更不可 ※繰り返し予定の一部を変更する場合は部分変更予定追加の使用が必要 |
| 削除 | DELETE | /events/[event_id] | 指定されたトピックを削除する ※予約は削除不可 ※繰り返し予定の一部を変更する場合は繰り返し除外日追加の使用が必要 |
| 部分変更予定追加 | POST | /events/[event_id]/exevents/ | 繰り返し予定の一部を変更して新しい予定を追加する |
| 繰り返し除外日追加 | POST | /events/[event_id]/exdates/ | 繰り返し予定から除外する日を追加する |
関連リソース
| リソース名 | パス | 説明 |
|---|---|---|
| messages | /events/[event_id]/messages/ | 該当予定の関連トピックリストを取得、作成する |
| users | /events/[event_id]/messages/users/ | 参加ユーザーのリストを取得 |