Garoon APIドキュメント

スケジュールAPIで使用するデータの構造

目次

EventType

固定リンクがコピーされました

予定を表す型です。
通常のGaroonの予定登録時や変更時と同様、予定の種別によって必要な情報が異なる点に注意してください。
たとえば、予定には通常予定、期間予定、繰り返し予定、仮予定の4つの種類があります。
これらの種類のうち、通常予定、期間予定、仮予定を表す場合はwhenノードで表される予定の期間情報は必須です。
繰り返し予定の場合は、whenノードの情報は不要です。代わりにrepeat_infoノードの繰り返し情報が必須となります。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明 変更履歴
@id base:IDType 1 予定のID
@event_type schedule:EventTypeType 1 種別
@version base:IDType 1 予定のバージョン情報
@public_type schedule:PublicType 0～1 公開方法
@plan xsd:string 0～1 予定メニュー
@detail xsd:string 0～1 タイトル
@description xsd:string 0～1 メモ
@timezone xsd:string 0～1 タイムゾーン
@end_timezone xsd:string 0～1 終了時刻のタイムゾーン パッケージ版Garoon 3.0.3で削除
パッケージ版Garoon 3.1で追加
@allday xsd:boolean 0～1 終日予定否か
@start_only xsd:boolean 0～1 開始時刻のみ設定されているか否か
@hidden_private xsd:boolean 0～1 他のユーザーの予定が非公開で閲覧できない場合にtrue
@facility_using_purpose xsd:string 0～1 施設の利用目的 承認が必須の施設の予定を登録、追加する場合はfacility_using_purposeに値を入力（空文字でもエラー）することが必須になります。
パッケージ版Garoon 4.2で追加
members - 0～1 参加者一覧
未指定で更新すると、空配列で上書きされます。更新前のmembersを残す場合は、必ず値を指定してください。
members/member schedule:MemberType 0～ 無制限 参加者
observers - 0～1 公開先（クラウド版は「共有先」）
パッケージ版5.5.1まで：@public_typeに「公開先を設定する」を設定した場合に指定します。 クラウド版、パッケージ版5.9以降：@public_typeに「公開」「未公開」を設定した場合に指定します。
未指定で更新すると、空配列で上書きされます。更新前のobserversを残す場合は、必ず値を指定してください。
observers/observer schedule:ObserverType 0～ 無制限 公開先（クラウド版は「共有先」） パッケージ版4.6から
クラウド版あり
observers/observer/@id base:IDType 1 GaroonユーザーID パッケージ版4.2.6まで
クラウド版なし
observers/observer/@order xsd:unsignedLong 0～1 表示順序 パッケージ版4.2.6まで
クラウド版なし
customer - 0～1 相手先の会社情報
「相手先の情報を追加する」で入力する会社情報を表します。
customer/@name xsd:string 0～1 会社名
customer/@zipcode xsd:string 0～1 郵便番号
customer/@address xsd:string 0～1 住所
customer/@map xsd:string 0～1 地図URL
customer/@route xsd:string 0～1 路線
customer/@route_time xsd:string 0～1 所要時間
customer/@route_fare xsd:string 0～1 運賃
customer/@phone xsd:string 0～1 電話番号
repeat_info - 0～1 繰り返し予定の情報
repeat_info/condition - 1 繰り返し条件
repeat_info/condition/@type schedule:RepeatEventType 1 繰り返し種別
repeat_info/condition/@start_date xsd:date 1 開始日
repeat_info/condition/@end_date xsd:date 0～1 終了日
repeat_info/condition/@start_time xsd:time 0～1 開始時刻
repeat_info/condition/@end_time xsd:time 0～1 終了時刻
repeat_info/condition/@day xsd:unsignedLong 0～1 日付
repeat_info/condition/@week xsd:unsignedLong 0～1 週（例： "0" を指定した場合は日曜日、"1" を指定した場合は月曜日の繰り返し予定を示す《0～6まで指定可能》）
repeat_info/exclusive_datetimes - 0～1 除外する日時一覧
repeat_info/exclusive_datetimes/exclusive_datetime - 除外する日時
repeat_info/exclusive_datetimes/exclusive_datetime/@start xsd:dateTime 1 開始日時
repeat_info/exclusive_datetimes/exclusive_datetime/@end xsd:dateTime 1 終了日時
when - 0～1 時間情報
when/datetime schedule:EventDateTimeType 1～ 無制限 日時情報
when/date schedule:EventDateType 1～ 無制限 日付情報
follows - 0～1 コメント一覧。予定に対して書き込まれたコメント一覧を表します。
follows/follow - 1～ 無制限 コメント。予定に対して書き込まれた各コメントを表します。
follows/follow/@id base:IDType 1 コメントID
follow/follow/@version base:IDType 1 コメントのバージョン
follows/follow/@text xsd:string 0～1 コメント本文
follows/follow/creator base:ChangeLogType 1 コメント作成者
file - 0～無制限 添付ファイル パッケージ版Garoon 4.0で追加
file/content xsd:base64Binary 1 ファイルの内容 パッケージ版Garoon 4.0で追加
file/@id base:IDType 1 ファイルID パッケージ版Garoon 4.0で追加
file/@name base:NonBlankStringType 1 ファイル名 パッケージ版Garoon 4.0で追加
file/@size xsd:unsignedLong 0～1 ファイルサイズ パッケージ版Garoon 4.0で追加
file/@mime_type xsd:string 0～1 ファイルのMIMEタイプ パッケージ版Garoon 4.0で追加
remove_file_id base:IDType 0～無制限 削除する添付ファイルのファイルID パッケージ版Garoon 4.0で追加

MemberType

固定リンクがコピーされました

予定の参加者、組織、および施設を表す型です。 参加者、組織、施設のどれを追加するかによって、必要なパラメーターが異なります。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

参加者を追加する場合
パラメーター名 型 パラメーター数 説明
user/@id base:IDType 1 GaroonユーザーID
user/@order base:IDType 0～1 参加者の順番
組織を追加する場合
パラメーター名 型 パラメーター数 説明
organization/@id base:IDType 1 組織ID
organization/@order base:IDType 0～1 組織の順番
施設を追加する場合
パラメーター名 型 パラメーター数 説明
facility/@id base:IDType 1 施設ID
facility/@order base:IDType 0～1 施設の順番
予定の詳細画面では、「order」の値が小さい順にユーザー、組織、および施設が並びます。たとえば次の場合には、参加者欄に「User2」「User1」の順に並びます。
<members xmlns="http://schemas.cybozu.co.jp/schedule/2008">
    <member>
      <user id="3" name="User2" order="0"/>
    </member>
    <member>
      <user id="2" name="User1" order="1"/>
    </member>
  </members>

ObserverType

固定リンクがコピーされました

予定の公開先を表す型です。 ユーザー、組織、ロールのどれを追加するかによって、必要なパラメーターが異なります。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 4.6以降

データ構造

固定リンクがコピーされました

公開先にユーザーを追加する場合
パラメーター名 型 パラメーター数 説明
user/@id base:IDType 1 GaroonユーザーID
user/@order base:IDType 0～1 表示順序
公開先に組織を追加する場合
パラメーター名 型 パラメーター数 説明
organization/@id base:IDType 1 組織ID
organization/@order base:IDType 0～1 表示順序
公開先にロールを追加する場合
パラメーター名 型 パラメーター数 説明
role/@id base:IDType 1 ロールID
role/@order base:IDType 0～1 表示順序

予定の詳細画面では、「order」の値が小さい順にユーザー、組織、およびロールが並びます。次の例の場合、公開先欄に「User1」「Org1」「Role1」「User2」の順に並びます。
<observers xmlns="http://schemas.cybozu.co.jp/schedule/2008">
    <observer>
      <user id="1" name="User1" order="1"/>
    </observer>
    <observer>
      <organization id="1" name="Org1" order="2"/>
    </observer>
    <observer>
      <role id="1" name="Role1" order="3"/>
    </observer>
    <observer>
      <user id="2" name="User2" order="4"/>
    </observer>
  </observers>

FacilityReserveEditableUserType

固定リンクがコピーされました

施設予約の変更権限を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
creator 予約者のみが変更できることを表します。
member 予約者と共有メンバーが変更できることを表します。
grantuser アクセス権のあるすべてのユーザーが変更できることを表します。

EventTypeType

固定リンクがコピーされました

予定の種類を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
normal 通常予定
repeat 繰り返し予定
temporary 仮予定
banner 期間予定

PublicType

固定リンクがコピーされました

予定の公開方法を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
public 公開：すべてのユーザーが閲覧可能です。
private 非公開：参加者のみが閲覧可能です。
qualified 公開先設定：参加者と公開先（observers）のみが閲覧可能です。
クラウド版、パッケージ版Garoon 5.9以降では利用不可

RepeatEventType

固定リンクがコピーされました

予定の繰り返し条件を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
day 毎日
例）10日 ～15日までの繰り返し
weekday 毎日（土日を除く）
例）平日のみの繰り返し
week 毎週
例）毎週月曜日
once_every_two_weeks 2週間ごと *1
once_every_three_weeks 3週間ごと *1
week 毎週
例）毎週月曜日
1stweek 毎月第一週
例）毎月第一週の月曜日の繰り返し
2ndweek 毎月第二週
例）毎月第二週の火曜日の繰り返し
3rdweek 毎月第三週
例）毎月第三週の水曜日の繰り返し
4thweek 毎月第四週
例）毎月第四週の木曜日の繰り返し
lastweek 毎月最終週
例）毎月最終週の金曜日の繰り返し

*1 クラウド版およびパッケージ版Garoon 6.0以降でのみ指定できます。 ^

FacilityType

固定リンクがコピーされました

施設を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@key base:IDType 1 施設ID
@name base:NonBlankStringType 1 施設名
@facility_code base:NonBlankStringType 1 施設コード
@version base:IDType 1 バージョン
@order xsd:unsignedLong 0～1 表示順序
@description xsd:string 0～1 メモ
@belong_facility_group base:IDType 0～1
  • 0：施設グループに属していない
  • 1：施設グループに属している
 所属する組織グループ

「表示順序」の例：表示順序は小さな値をもつ施設が上に表示されます。下記例では、Facility2がFacility1よりも上に表示されます。

1
2

<facility key="2" name="Facility2" order="0" version="1378873545" facility_code="Facility2"/>
<facility key="1" name="Facility1" order="1" version="1378873545" facility_code="Facility1"/>

FacilityProfileType

固定リンクがコピーされました

施設の設定情報を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 4.2以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@key base:IDType 1 施設ID
@approval_required xsd:boolean 1 施設の利用申請の設定
  • true:有効
  • false:無効

EventDateTimeType

固定リンクがコピーされました

予定の日時を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@start xsd:dateTime 1 開始日時
@end xsd:dateTime 0～1 終了日時
@facility_id base:IDType 0～1 施設ID

EventDateType

固定リンクがコピーされました

予定の日付を表す型です。終日予定や期間予定などの、日付のみを指定する予定に、この型を利用します。時間の指定がない予定には施設を登録できないため、EventDateTimeTypeと異なりfacility_id属性は存在しません。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@start xsd:dateTime 1 開始日時
@end xsd:dateTime 1 終了日時

SchedulePersonalProfileType

固定リンクがコピーされました

スケジュールの個人設定を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@start_time_in_dayview xsd:unsignedInt 0～1 日表示予定で表示する時間帯の開始時間
@end_time_in_dayview xsd:unsignedInt 0～1 日表示予定で表示する時間帯の終了時間
@show_sunday xsd:boolean 0～1 日曜日の表示
  • true：月表示において日曜日を右側に表示する
  • false：月表示において日曜日を左側に表示する
@show_end_time xsd:boolean 0～1 スケジュールのグループ週表示／月表示での、終了時刻の表示
  • true：表示する
  • false：表示しない
@plan_menu xsd:string 0～1
  • 0：予定メニューが登録されていない
  • 1：予定メニューが登録されている
 予定メニューの設定
@notify_mail xsd:boolean 0～1 予定の通知のメール転送
  • true：する
  • ffalse：しない
@is_user_address_mail xsd:boolean 0～1 通知を受け取るメールアドレス
  • true：ユーザー情報のメールアドレス<
  • false：@notify_mail_addressパラメーターで指定したメールアドレス
@notify_mail_address xsd:string 0～1
  • 0：メールアドレスが設定されていない
 @is_user_address_mailパラメーターにfalseを指定した場合のみ指定します。

ScheduleSystemProfileType

固定リンクがコピーされました

スケジュールのシステム設定を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明 変更履歴
@plan_menu xsd:string 0～1
  • 0：予定メニューが登録されていない
  • 1：予定メニューが登録されている
 予定メニュー
@event_reserve_unit xsd:unsignedInt 0～1 予定（予約）を設定する単位（分単位）
@event_repeat_max_time xsd:unsignedInt 0～1 繰り返し予定の最大登録期間（月単位）
@register_private_event xsd:boolean 0～ １ 非公開の予定
  • true：登録できる
  • false：登録できない
@show_memo xsd:boolean 0～1 施設の一覧でのメモ表示の初期設定
  • true：表示する
  • false：表示しない
@show_private_event xsd:boolean 0～1 非公開の予定の表示
  • true：完全に隠す
  • false：（非公開）と表示する
@managed_notify xsd:boolean 0～1 予定の公開先のユーザーへの通知設定
  • true：通知しない
  • false：通知する
 パッケージ版Garoon 4.6で追加
@show_group_event xsd:boolean 0～1 組織の予定の表示
  • true：表示する
  • false：表示しない
@show_holiday xsd:boolean 0～1 祝日の表示- true：表示する
  • false：表示しない
@allow_file_attachment xsd:boolean 0～1 ファイルの添付
  • true：許可する
  • false：許可しない
 パッケージ版Garoon 4.0で追加
@allow_attendance_check xsd:boolean 0～1 出欠確認の使用
  • true：許可する
  • false：許可しない
 パッケージ版Garoon 4.2で追加
@visibility_default xsd:unsignedInt 0～1 予定の公開設定の初期状態
  • 0: 公開
  • 1: 非公開
  • 2: 公開先を設定する
 パッケージ版Garoon 4.6で追加

ScheduleRepeatModifyType

固定リンクがコピーされました

繰り返し予定の変更期間を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
this 指定した日付の予定のみを変更します。
after 指定した日付以降の予定を変更します。
all 指定した繰り返し予定のすべての予定を変更します。

ScheduleModifyRepeatEventsOperationType

固定リンクがコピーされました

繰り返し予定の変更内容を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
schedule_event schedule:EventType 1 予定の変更内容
@type shedule:ScheduleRepeatModifyType 1 繰り返し予定の変更期間
@date xsd:date 0～1 変更の基準となる日付

ScheduleModifyRepeatEventsResultType

固定リンクがコピーされました

繰り返し予定の変更結果を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
original schedule:EventType 1 変更後の予定の内容
modified schedule:EventType 1 予定を変更することによって、新しいIDの予定が作成された場合は、作成された予定の内容が表示されます。作成された予定がない場合には、変更した予定の内容が表示されます。

ScheduleRemoveEventsFromRepeatEventOperationType

固定リンクがコピーされました

繰り返し予定の削除内容を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@event_id base:IDType 1 予定ID
@type schedule:ScheduleRepeatModifyType 1 繰り返し予定の削除期間
@date xsd:date 0～1 削除の基準となる日付

ScheduleSearchConditionType

固定リンクがコピーされました

予定を調整する際に指定する、施設の条件を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

この型は単一の文字列を表すスカラー値です。また、この型が取り得る値は次のいずれかです。

値 説明
and すべての施設を使用します。
or 1つの施設を使用します。

ScheduleSearchFreeTimesCandidateType

固定リンクがコピーされました

予定を調整する際に指定する、時間候補の範囲を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@start xsd:dateTime 1 時間候補の範囲の開始時刻
@end xsd:dateTime 1 時間候補の範囲の終了時刻

ScheduleFreeTimeType

固定リンクがコピーされました

予定の日時候補を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@start xsd:dateTime 1 日時候補の範囲の開始時刻
@end xsd:dateTime 1 日時候補の範囲の終了時刻
@facility_id base:IDType 0～1 候補となる施設ID

ScheduleFollowContentType

固定リンクがコピーされました

コメントの内容を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@event_id base:IDType 1 予定ID
@content xsd:string 1 コメントの内容

ScheduleFollowToRepeatEventContentType

固定リンクがコピーされました

繰り返し予定のコメントの内容を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@event_id base:IDType 1 予定ID
@date xsd:date 1 予定の日付
@content xsd:string 1 コメントの内容

ScheduleAddFollowsToRepeatEventResultType

固定リンクがコピーされました

繰り返し予定の変更結果を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
original schedule:EventType 1 変更後の予定の内容
modified schedule:EventType 1 予定を変更することによって、新しいIDの予定が作成された場合は、作成された予定の内容が表示されます。

ScheduleCandidateItemType

固定リンクがコピーされました

仮予定の候補を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@event_id base:IDType 1 予定ID
@start xsd:dateTime 1 予定の開始日時
@end xsd:dateTime 1 予定の終了日時
@facility_id base:IDType 0～1 施設ID

ScheduleParticipateEventsToRepeatEventOperationType

固定リンクがコピーされました

繰り返し予定への参加を表す型です。

使用可能なGaroonのバージョン

固定リンクがコピーされました

  • クラウド版Garoon
  • パッケージ版Garoon 3.0以降

データ構造

固定リンクがコピーされました

パラメーター名 型 パラメーター数 説明
@event_id base:IDType 1 予定ID
@type schedule:ScheduleRepeatModifyType 1 繰り返し予定の参加期間
@date xsd:date 0～1 繰り返し予定の参加期間