掲示板を取得する

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

掲示板の更新情報を取得する

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

掲示板のバージョン情報を取得するAPIです。

API名

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

BulletinGetTopicVersions

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

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

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

リクエスト

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

パラメーター名	型	パラメーター数	説明
@start	xsd:dateTime	1	掲示の最終更新日時（検索対象の開始日時）
@end	xsd:dateTime	0～1	掲示の最終更新日時（検索対象の終了日時）
topic_item	base:ItemVersionType	0～無制限	掲示板のバージョン情報
category_id/text()	base:IDType	0～無制限	カテゴリーID 次のいずれかの値を指定します。 1〜：カテゴリーーID（通常掲示のみ） -1：掲示開始待ちの掲示

例

1
2
3
4


<parameters start="2010-11-02T08:00:00Z"  end="2010-11-04T08:00:00Z">
  <topic_item xmlns="" id="4" version="1288029380">
  </topic_item>
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
topic_item	base:ItemVersionResultType	0～無制限	掲示板の更新情報

例

1
2
3
4
5


<returns>
  <topic_item id="4" version="1288838258" operation="add" />
  <topic_item id="2" version="1288842674" operation="add" />
  <topic_item id="6" version="1288843195" operation="add" />
</returns>

エラー

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

エラー番号	説明
GRN_BLLT_16006	@startが@endより後の場合
FW00034	日時情報が間違っている場合。月に13、日に35が含まれているなど。

掲示板の下書きの更新情報を取得する

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

掲示板の下書きのバージョン情報を取得するAPIです。

API名

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

BulletinGetDraftTopicVersions

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

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

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

リクエスト

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

パラメーター名	型	パラメーター数	説明
@start	xsd:dateTime	1	掲示の最終更新日時（検索対象の開始日時）
@end	xsd:dateTime	0～1	掲示の最終更新日時（検索対象の終了日時）
topic_item	base:ItemVersionType	0～無制限	掲示板の下書きのバージョン情報

例

1
2
3
4


<parameters start="2010-11-03T08:00:00Z" end="2010-11-10T08:00:00Z">
  <topic_item xmlns="" id="1" version="11111111111">
  </topic_item>
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
topic_item	base:ItemVersionResultType	0～無制限	掲示板の下書きの更新情報

例

1
2
3
4


<returns>
  <topic_item id="1" version="0" operation="remove" />
  <topic_item id="2" version="1288839022" operation="add" />
</returns>

掲示板の一覧を取得する

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

掲示板を取得するAPIです。このAPIは、カテゴリーのIDをリクエストとして受け取り、指定したカテゴリーに属す掲示板のリストをレスポンスとして返します。

API名

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

BulletinGetTopics

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

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

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

リクエスト

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

パラメーター名	型	パラメーター数	説明
category_id	base:IDType	1～無制限	カテゴリーID 次のいずれかの値を指定します。 1〜：カテゴリーID（通常掲示のみ） -1：掲示開始待ちの掲示 -2：下書きの掲示

例

1
2
3


<parameters>
  <category_id xmlns="">3</category_id>
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
category	bulletin:TopicListType	0～無制限	カテゴリーに属する掲示板の一覧

例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12


<returns xmlns="">
  <category category_id="3">
    <topic id="10" />
    <topic id="9" />
    <topic id="8" />
    <topic id="7" />
    <topic id="6" />
    <topic id="4" />
    <topic id="3" />
    <topic id="2" />
  </category>
</returns>

エラー

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

エラー番号	説明
GRN_BLLT_16002	カテゴリーが存在しない場合
GRN_BLLT_16050	カテゴリーの閲覧権限がないユーザーが実行した場合

掲示板の情報を取得する

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

掲示板の詳細情報を取得するAPIです。このAPIは、掲示板のIDをリクエストとして受け取り、掲示板の詳細情報をレスポンスとして返します。

API名

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

BulletinGetTopicByIds

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

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

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

リクエスト

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

パラメーター名	型	パラメーター数	説明
@topic_id	base:IDType	1～無制限	取得する掲示板ID
@is_draft	xsd:boolean	1～無制限	true：下書き false：下書きでない

例

1
2
3


<parameters>
  <topics xmlns="" topic_id="2" is_draft="false"></topics>
</parameters>

レスポンス

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

パラメーター名	型	パラメーター数	説明
topic	bulletin:TopicType	0～無制限	取得した掲示板情報

例

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19


<returns>
  <topic xmlns:th="http://schemas.cybozu.co.jp/bulletin/2008"
   id="2" version="1288755034"
   category_id="3"
   can_follow="true"
   subject="modify"
   is_draft="false"
   published="true"
   unread="true"
   expired="false" >
    <th:content body="body" >
      <th:file id="4" name="test.txt" size="100" mime_type="text/plain"/>
      <th:file id="5" name="test2.txt" size="100" mime_type="text/plain"/>
    </th:content>
    <th:follow id="1" number="12" />
    <th:creator user_id="1" name="Administrator" date="2010-11-03T11:45:57Z" />
    <th:modifier user_id="1" name="Administrator" date="2010-11-03T12:30:34Z" />
  </topic>
</returns>

エラー

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

エラー番号	説明
GRN_BLLT_16005	指定した下書きが存在しない場合

Garoon API

Garoon APIドキュメント