Garoon APIドキュメント

設定情報を取得または設定する

目次

設定情報を取得する

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

スケジュールに関する設定を取得するAPIです。 APIを実行するユーザーのスケジュールに関する個人設定を取得します。 リクエスト内のパラメーターでシステム設定情報の出力を指定すると、システム設定も合わせて取得します。

API名

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

ScheduleGetProfiles

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

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
@include_system_profile xsd:boolean 0～1 システム設定を取得するかどうか
  • true：取得する
  • false：取得しない
例
1
2

<parameters include_system_profile="true"> 
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
personal_profile schedule:SchedulePersonalProfileType 1 スケジュールの個人設定
system_profile schedule:ScheduleSystemProfileType 1 スケジュールのシステム設定
例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12

<returns>
  <personal_profile start_time_in_dayview="8"
    end_time_in_dayview="19" show_sunday="false"
    show_end_time="true" notify_mail="false"
    is_user_address_mail="true" />
  <system_profile event_reserve_unit="30"
    event_repeat_max_time="12" register_private_event="true"
    show_memo="false" show_private_event="false"
    show_group_event="false" show_holiday="true"
    allow_file_attachment="true" allow_attendance_check="true">
  </system_profile>
</returns>

設定情報を更新する

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

スケジュールに関する設定を更新するAPIです。

API名

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

ScheduleSetProfiles

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

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
personal_profile schedule:SchedulePersonalProfileType 1 スケジュールの個人設定
例
1
2
3
4
5

<parameters> 
  <personal_profile start_time_in_dayview="7" 
   end_time_in_dayview="23" show_sunday="true"> 
  </personal_profile> 
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
personal_profile schedule:SchedulePersonalProfileType 1 変更した個人設定
例
1
2
3
4

<returns> 
   <personal_profile start_time_in_dayview="7" 
    end_time_in_dayview="23" show_sunday="true" /> 
</returns>