Garoon API ドキュメント

お気に入りを追加または削除する

目次

お気に入りを追加する

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

お気に入りを追加する API です。

API名

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

StarAddStars

利用できるバージョン

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
star_item - 1 ～ 無制限 追加するお気に入り情報
star_item/@module_id star:ModuleIdType 1 アプリケーションID
star_item/@item base:NonBlankStringType 1 お気に入りにするアイテムID
star_item/@date xsd:date 0 ～ 1 予定をお気に入りに追加する場合、日付を指定する
star_ite/@is_draft xsd:boolean 0 ～ 1 お気に入りに追加する掲示の状態
  • true：下書きである
  • false：下書きでない
例
1
2
3

<parameters>
  <star_item xmlns="" module_id="grn.message" item="2"></star_item> 
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
star_data star:StarDataType 0 ～ 無制限 追加されたお気に入り一覧
例
1
2
3
4

<returns> 
  <star_data id="3" module_id="grn.message" 
    item="2" subject="message1" version="1286859209" /> 
</returns>

お気に入りを削除する

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

お気に入りを削除する API です。

API名

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

StarRemoveStars

利用できるバージョン

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
star_item - 1 ～ 無制限 削除するお気に入り
star_item/@module_id star:ModuleIdType 1 アプリケーションID
star_item/@item base:NonBlankStringType 1 お気に入りから削除するアイテムID
star_item/@date xsd:date 0 ～ 1 予定をお気に入りから削除場合、日付を指定する
star_ite/@is_draft xsd:boolean 0 ～ 1 お気に入りから削除する掲示の状態
  • true：下書きである
  • false：下書きでない
例
1
2
3

<parameters> 
  <star_item xmlns="" module_id="grn.message" item="2"></star_item> 
</parameters>

レスポンス

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

なし