Garoon APIドキュメント

カテゴリを取得する

目次

カテゴリの更新情報を取得する

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

カテゴリの情報をリクエストとして受け取り、カテゴリ情報をレスポンスとして返すAPIです。

API名

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

BulletinGetCategoryVersions

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

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

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

リクエスト

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

パラメーター名 型 パラメーター数 説明
category_item base:ItemVersionType 0～ 無制限 カテゴリのバージョン情報
例
1
2
3
4

<parameters> 
  <category_item xmlns=""  id="4"  version="1302934875"> 
  </category_item> 
</parameters>

レスポンス

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

パラメーター名 型 パラメーター数 説明
category_item base:ItemVersionResultType 0～ 無制限 カテゴリの更新情報
例
1
2
3
4
5

<returns> 
  <category_item id="4" version="0" operation="remove"/> 
  <category_item id="1" version="1288837933" operation="add"/> 
  <category_item id="2" version="1288838176" operation="add"/> 
</returns>

カテゴリを取得する

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

カテゴリを取得するAPIです。 このAPIは、リクエストにパラメーターは不要です。カテゴリ一覧の情報をレスポンスとして返します。

API名

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

BulletinGetCategories

リクエスト

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

なし

レスポンス

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

パラメーター名 型 パラメーター数 説明
categories bulletin:CategoryInformationType 0～ 無制限 カテゴリ一覧の情報
例
 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

<returns xmlns="">  
  <categories> 
    <root id="1" code="ROOT_CATEGORY">
      <name>Root</name>
      <description/><creator_id/><creator_login_naame/> 
      <creator_display_name>Administrator</creator_display_name> 
      <create_time>2010-11-03T11:17:29+0900</create_time><modifier_id/> 
      <modifier_login_name/> 
      <modifier_display_name>Administrator</modifier_display_name> 
      <modify_time>2010-11-03T11:17:29+0900</modify_time> 
      <categories parent_id="1" parent_code="ROOT_CATEGORY"> 
        <category id="3" code="Category1" list_index="2147483647"> 
          <name>Category1</name><description/> 
          <creator_id>1</creator_id> 
          <creator_login_name>Administrator</creator_login_name> 
          <creator_display_name>Administrator</creator_display_name> 
          <create_time>2010-11-03T11:34:01+0900</create_time> 
          <modifier_id>1</modifier_id> 
          <modifier_login_name>Administrator</modifier_login_name> 
          <modifier_display_name>Administrator</modifier_display_name> 
          <modify_time>2010-11-03T11:34:01+0900</modify_time> 
        </category> 
        <category id="4" code="Category2" list_index="2147483647"> 
          <name>Category2</name> 
          <description><!\[CDATA\[memo\]\]></description> 
          <creator_id>1</creator_id> 
          <creator_login_name>Administrator</creator_login_name> 
          <creator_display_name>Administrator</creator_display_name> 
          <create_time>2010-11-03T11:34:26+0900</create_time> 
          <modifier_id>1</modifier_id> 
          <modifier_login_name>Administrator</modifier_login_name> 
          <modifier_display_name>Administrator</modifier_display_name> 
          <modify_time>2010-11-03T11:34:26+0900</modify_time> 
        </category> 
      </categories> 
    </root> 
  </categories> 
</returns>

エラー

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

エラー番号 説明
GRN_CBPAPI_16050 カテゴリの閲覧権限のないユーザーが操作した場合