いいね!新着情報

サイボウズLive であなたの投稿にいいね!がつけられた情報を管理します。

リクエスト

エンドポイント

https://api.cybozulive.com/api/goodNotification/V2

利用可能な HTTP メソッド

GET, POST

リクエスト制限

  • 1回のリクエストで確認済みにマークできるのは100件までです。

必須パラメータ

ありません。

オプションパラメータ

  • start-index - コレクションを取得する場合のインデクスを指定します。値は正数のみ可能です。デフォルトは “0” です。
  • max-results - コレクションを取得する場合の最大件数を指定します。値は正数のみ可能です。デフォルトは “20” です。上限は “100” です。
  • unconfirmed - 未確認のいいね!通知情報のみ取得する場合に使います。値は “true” のみ可能です。

すべてのいいね!通知情報を取得する

確認済み、未確認を問わず、全てのいいね!通知情報を取得します。データ量を制御するためには max-results パラメータを指定してください。

Examples

リクエストの例:

GET /api/goodNotification/V2

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2010-08-01T17:25:00Z</updated>
  <dc:date>2010-08-01T17:25:00Z</dc:date>
  <author>
    <name>佐藤 昇</name>
    <email>sato@example.com</email>
    <uri>1:1</uri>
  </author>
  <cbl:totalCount>2</cbl:totalCount>
  <entry>
    <title>健康診断の案内</title>
    <link rel="alternate" href="https://cybozulive.com/mpMessage/view?mid=1%3A1&amp;fid=1&amp;focusOn=follow" />
    <link rel="mobile" href="https://m.cybozulive.com/m/mpMessage/view?mid=1%3A1&amp;fid=1#follow" />
    <category term="MYPAGE" />
    <category term="MESSAGE" />
    <category term="GOOD" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>MYPAGE,1:1,MESSAGE,1:1,COMMENT,1</id>
    <updated>2011-08-01T17:25:00Z</updated>
    <summary>健康診断の日程が確定しました</summary>
    <cbl:confirmed>false</cbl:confirmed>
  </entry>
  <entry>
    <title>はじめまして</title>
    <link rel="alternate" href="https://cybozulive.com/1_1/gwBoard/view?bid=1%3A1" />
    <link rel="mobile" href="https://m.cybozulive.com/m/1_1/gwBoard/view?bid=1%3A1" />
    <category term="GROUP" />
    <category term="BOARD" />
    <category term="GOOD" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <author>
      <name>田中 美子</name>
      <uri>1:5</uri>
    </author>
    <id>GROUP,1:1,BOARD,1:1</id>
    <updated>2011-07-31T15:05:00Z</updated>
    <summary>本日より総務部に配属された佐藤です。よろしくお願いします。</summary>
    <cbl:confirmed>true</cbl:confirmed>
    <cbl:group valueString="グループウェア1" id="1:1" />
  </entry>
</feed>

ユーザーが確認していない情報を取得する

GET リクエストで unconfirmed パラメータに true を指定します。

Examples

リクエストの例:

GET /api/goodNotification/V2?unconfirmed=true

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2010-08-01T17:25:00Z</updated>
  <dc:date>2010-08-01T17:25:00Z</dc:date>
  <author>
    <name>佐藤 昇</name>
    <email>sato@example.com</email>
    <uri>1:1</uri>
  </author>
  <cbl:totalCount>1</cbl:totalCount>
  <entry>
    <title>健康診断の案内</title>
    <link rel="alternate" href="https://cybozulive.com/mpMessage/view?mid=1%3A1&amp;fid=1&amp;focusOn=follow" />
    <link rel="mobile" href="https://m.cybozulive.com/m/mpMessage/view?mid=1%3A1&amp;fid=1#follow" />
    <category term="MYPAGE" />
    <category term="MESSAGE" />
    <category term="GOOD" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>MYPAGE,1:1,MESSAGE,1:1,COMMENT,1</id>
    <updated>2011-08-01T17:25:00Z</updated>
    <summary>健康診断の日程が確定しました</summary>
    <cbl:confirmed>false</cbl:confirmed>
  </entry>
</feed>

いいね!通知情報を確認済みにする

取得したいいね!通知情報の ID を指定して確認済みにできます。確認済みになったエントリが返されます。 存在しない ID を指定した場合、そのエントリは無視されます。エラーにはなりません。 既に確認済みのいいね!通知情報を指定した場合も、そのエントリは無視されます。

リクエスト

Atom 名前空間 (http://www.w3.org/2005/Atom) の feedentry を使います。

要素 説明
/feed/entry/id 確認済みにマークするいいね!通知情報の ID。

Examples

リクエストの例:

POST /api/goodNotification/V2
Content-Type: application/atom+xml
<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom">
  <entry>
    <id>MYPAGE,1:1,MESSAGE,1:1,COMMENT,1</id>
  </entry>
  <entry>
    <id>GROUP,1:1,BOARD,1:1</id>
  </entry>
  <entry>
    <id>UNKNOWN-IDENTIFIER</id>
  </entry>
</feed>

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:dc="http://purl.org/dc/elements/1.1/">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com" />
  <updated>2010-08-01T17:25:00Z</updated>
  <dc:date>2010-08-01T17:25:00Z</dc:date>
  <author>
    <name>佐藤 昇</name>
    <email>sato@example.com</email>
    <uri>1:1</uri>
  </author>
  <cbl:totalCount>1</cbl:totalCount>
  <entry>
    <title>健康診断の案内</title>
    <link rel="alternate" href="https://cybozulive.com/mpMessage/view?mid=1%3A1&amp;fid=1&amp;focusOn=follow" />
    <link rel="mobile" href="https://m.cybozulive.com/m/mpMessage/view?mid=1%3A1&amp;fid=1#follow" />
    <category term="MYPAGE" />
    <category term="MESSAGE" />
    <category term="GOOD" />
    <author>
      <name>高橋 健太</name>
      <uri>1:4</uri>
    </author>
    <id>MYPAGE,1:1,MESSAGE,1:1,COMMENT,1</id>
    <updated>2011-08-01T17:25:00Z</updated>
    <summary>健康診断の日程が確定しました</summary>
    <cbl:confirmed>false</cbl:confirmed>
  </entry>
</feed>

エラーコード

ありません。