ここの情報は古いです。ご理解頂いた上でお取り扱いください。

Changeset 12885


Ignore:
Timestamp:
Sep 15, 2009, 1:35:38 PM (10 years ago)
Author:
ebihara
Message:

added samples for member resources and explains for that

Location:
OpenPNE3/doc/branches/develop/OpenPNEWebAPI/docs
Files:
8 edited

Legend:

Unmodified
Added
Removed
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/docs/basic.rst

    r12882 r12885  
    5353メンバ URI
    5454    http://example.com/api.php/feeds/example/1
     55
     56クライアントから送信する Atom エントリ文書について
     57==================================================
     58
     59そのリソースがどういう Atom エントリ文書によって表現されるかについては、各 API のトップページに解説があります。
     60
     61(省略可) と記されている要素は、この要素を含めなくても POST や PUT をおこなうことができることを意味しています。また、これらの要素は編集不可でもあり、リクエストされた Atom 文書中にこれらの要素が含まれていたとしても、単に無視されます。
    5562
    5663エントリの一覧の取得
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/docs/community_api.rst

    r12881 r12885  
    1919
    2020コレクション URI
    21     http://example.com/feeds/community
     21    http://example.com/api.php/feeds/community
    2222
    2323メンバ URI
    24     http://example.com/feeds/community/{community_id}
     24    http://example.com/api.php/feeds/community/{コミュニティのID}
     25
     26エントリ文書の書式
     27==================
     28
     29コミュニティのエントリは以下のような Atom エントリ文書で表現されます。
     30
     31::
     32
     33  <?xml version="1.0" encoding="UTF-8" ?>
     34  <entry xmlns="http://www.w3.org/2005/Atom">
     35    <id>http://example.com/community/{community_id}</id>
     36    <published>2009-01-25T19:40:22+09:00</published>
     37    <updated>2009-01-25T19:40:22+09:00</updated>
     38    <title type="text">コミュニティタイトル</title>
     39    <content type="text">コミュニティ本文</content>
     40    <author>
     41      <name>投稿したメンバーのニックネーム</name>
     42      <uri>http://example.com/member/{member_id}</uri>
     43    </author>
     44    <link rel="edit" type="application/atom+xml" href="http://example.com/api.php/feeds/community/{community_id}"/>
     45    <link rel="self" type="application/atom+xml" href="http://example.com/api.php/feeds/community/1"/>
     46    <link rel="alternate" type="text/html" href="http://example.com/community/{community_id}"/>
     47    <link rel="alternate" href="http://example.com/mobile_frontend.php/community/{community_id}"/>
     48  </entry>
     49
     50このエントリに含まれる要素の解説を以下に示します。
     51
     52 * /entry/id : エントリを識別するための ID となる URN (省略可)
     53 * /entry/published : エントリの作成日時 (省略可)
     54 * /entry/updated : エントリの更新日時 (省略可)
     55 * /entry/title : エントリのタイトル
     56 * /entry/content : エントリの説明文
     57 * /entry/author : エントリの作成者の情報
     58    * /entry/author/name : エントリの作成者のニックネーム
     59    * /entry/auhtor/uri : エントリの作成者を識別するための URN
     60 * /entry/link[@rel="edit"] : OpenPNE Web API でこのエントリを編集するための URI (省略可)
     61 * /entry/link[@rel="self"] : OpenPNE Web API でこのエントリを参照するための URI (省略可)
     62 * /entry/link[@rel="alternate" and @type="text/html"] : PC 版でこのエントリを閲覧するための URL (省略可)
     63 * /entry/link[@rel="alternate" and not(@type)] : 携帯版でこのエントリを閲覧するための URL (省略可)
     64
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/docs/community_event_api.rst

    r12881 r12885  
    1919
    2020コレクション URI
    21     http://example.com/feeds/communityEvent/community/{community_id}
     21    http://example.com/api.php/feeds/communityEvent/community/{コミュニティのID}
    2222
    2323メンバ URI
    24     http://example.com/feeds/communityEvent/{community_event_id}
     24    http://example.com/api.php/feeds/communityEvent/{コミュニティイベントのID}
     25
     26エントリ文書の書式
     27==================
     28
     29コミュニティイベントのエントリは以下のような Atom エントリ文書で表現されます。
     30
     31::
     32
     33  <?xml version="1.0" encoding="UTF-8" ?>
     34  <entry xmlns="http://www.w3.org/2005/Atom">
     35    <id>http://example.com/communityEvent/{community_event_id}</id>
     36    <published>2009-01-25T19:40:22+09:00</published>
     37    <updated>2009-01-25T19:40:22+09:00</updated>
     38    <title type="text">コミュニティイベントタイトル</title>
     39    <content type="text">コミュニティイベント本文</content>
     40    <author>
     41      <name>投稿したメンバーのニックネーム</name>
     42      <uri>http://example.com/member/{member_id}</uri>
     43    </author>
     44    <link rel="edit" type="application/atom+xml" href="http://example.com/api.php/feeds/communityEvent/{community_event_id}"/>
     45    <link rel="self" type="application/atom+xml" href="http://example.com/api.php/feeds/communityEvent/1"/>
     46    <link rel="alternate" type="text/html" href="http://example.com/communityEvent/{community_event_id}"/>
     47    <link rel="alternate" href="http://example.com/mobile_frontend.php/communityEvent/{community_event_id}"/>
     48  </entry>
     49
     50このエントリに含まれる要素の解説を以下に示します。
     51
     52 * /entry/id : エントリを識別するための ID となる URN (省略可)
     53 * /entry/published : エントリの作成日時 (省略可)
     54 * /entry/updated : エントリの更新日時 (省略可)
     55 * /entry/title : エントリのタイトル
     56 * /entry/content : エントリの本文
     57 * /entry/author : エントリの作成者の情報
     58    * /entry/author/name : エントリの作成者のニックネーム
     59    * /entry/auhtor/uri : エントリの作成者を識別するための URN
     60 * /entry/link[@rel="edit"] : OpenPNE Web API でこのエントリを編集するための URI (省略可)
     61 * /entry/link[@rel="self"] : OpenPNE Web API でこのエントリを参照するための URI (省略可)
     62 * /entry/link[@rel="alternate" and @type="text/html"] : PC 版でこのエントリを閲覧するための URL (省略可)
     63 * /entry/link[@rel="alternate" and not(@type)] : 携帯版でこのエントリを閲覧するための URL (省略可)
     64
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/docs/community_event_comment_api.rst

    r12881 r12885  
    1818
    1919コレクション URI
    20     http://example.com/feeds/communityEventComment/communityEvent/{community_event_id}
     20    http://example.com/api.php/feeds/communityEventComment/communityEvent/{コミュニティイベントのID}
    2121
    2222メンバ URI
    23     http://example.com/feeds/communityEventComment/{community_event_comment_id}
     23    http://example.com/api.php/feeds/communityEventComment/{コミュニティイベントコメントのID}
     24
     25エントリ文書の書式
     26==================
     27
     28コミュニティイベントコメントのエントリは以下のような Atom エントリ文書で表現されます。
     29
     30::
     31
     32  <?xml version="1.0" encoding="UTF-8" ?>
     33  <entry xmlns="http://www.w3.org/2005/Atom">
     34    <id>http://example.com/communityEventComment/{community_event_comment_id}</id>
     35    <published>2009-01-25T19:40:22+09:00</published>
     36    <updated>2009-01-25T19:40:22+09:00</updated>
     37    <content type="text">コミュニティイベントコメント本文</content>
     38    <author>
     39      <name>投稿したメンバーのニックネーム</name>
     40      <uri>http://example.com/member/{member_id}</uri>
     41    </author>
     42    <link rel="self" type="application/atom+xml" href="http://example.com/api.php/feeds/communityEventComment/{community_event_comment_id}"/>
     43  </entry>
     44
     45このエントリに含まれる要素の解説を以下に示します。
     46
     47 * /entry/id : エントリを識別するための ID となる URN (省略可)
     48 * /entry/published : エントリの作成日時 (省略可)
     49 * /entry/updated : エントリの更新日時 (省略可)
     50 * /entry/content : エントリの本文
     51 * /entry/author : エントリの作成者の情報
     52    * /entry/author/name : エントリの作成者のニックネーム
     53    * /entry/auhtor/uri : エントリの作成者を識別するための URN
     54 * /entry/link[@rel="self"] : OpenPNE Web API でこのエントリを参照するための URI (省略可)
     55
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/docs/community_member_api.rst

    r12881 r12885  
    1515
    1616コレクション URI
    17     http://example.com/feeds/communityMember/community/{community_id}
     17    http://example.com/api.php/feeds/communityMember/community/{コミュニティのID}
     18
     19エントリ文書の書式
     20==================
     21
     22コミュニティメンバーに関する API にはメンバ URI がありません。
     23
     24Atom フィード文書内に登場する entry 要素の内容は、 メンバーに関する API で取得できるメンバリソースと同様のものです。
     25
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/docs/community_topic_api.rst

    r12881 r12885  
    1919
    2020コレクション URI
    21     http://example.com/feeds/communityTopic/community/{community_id}
     21    http://example.com/api.php/feeds/communityTopic/community/{コミュニティのID}
    2222
    2323メンバ URI
    24     http://example.com/feeds/communityTopic/{community_topic_id}
     24    http://example.com/api.php/feeds/communityTopic/{コミュニティトピックのID}
     25
     26エントリ文書の書式
     27==================
     28
     29コミュニティトピックのエントリは以下のような Atom エントリ文書で表現されます。
     30
     31::
     32
     33  <?xml version="1.0" encoding="UTF-8" ?>
     34  <entry xmlns="http://www.w3.org/2005/Atom">
     35    <id>http://example.com/communityTopic/{community_topic_id}</id>
     36    <published>2009-01-25T19:40:22+09:00</published>
     37    <updated>2009-01-25T19:40:22+09:00</updated>
     38    <title type="text">コミュニティトピックタイトル</title>
     39    <content type="text">コミュニティトピック本文</content>
     40    <author>
     41      <name>投稿したメンバーのニックネーム</name>
     42      <uri>http://example.com/member/{member_id}</uri>
     43    </author>
     44    <link rel="edit" type="application/atom+xml" href="http://example.com/api.php/feeds/communityTopic/{community_topic_id}"/>
     45    <link rel="self" type="application/atom+xml" href="http://example.com/api.php/feeds/communityTopic/1"/>
     46    <link rel="alternate" type="text/html" href="http://example.com/communityTopic/{community_topic_id}"/>
     47    <link rel="alternate" href="http://example.com/mobile_frontend.php/communityTopic/{community_topic_id}"/>
     48  </entry>
     49
     50このエントリに含まれる要素の解説を以下に示します。
     51
     52 * /entry/id : エントリを識別するための ID となる URN (省略可)
     53 * /entry/published : エントリの作成日時 (省略可)
     54 * /entry/updated : エントリの更新日時 (省略可)
     55 * /entry/title : エントリのタイトル
     56 * /entry/content : エントリの本文
     57 * /entry/author : エントリの作成者の情報
     58    * /entry/author/name : エントリの作成者のニックネーム
     59    * /entry/auhtor/uri : エントリの作成者を識別するための URN
     60 * /entry/link[@rel="edit"] : OpenPNE Web API でこのエントリを編集するための URI (省略可)
     61 * /entry/link[@rel="self"] : OpenPNE Web API でこのエントリを参照するための URI (省略可)
     62 * /entry/link[@rel="alternate" and @type="text/html"] : PC 版でこのエントリを閲覧するための URL (省略可)
     63 * /entry/link[@rel="alternate" and not(@type)] : 携帯版でこのエントリを閲覧するための URL (省略可)
     64
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/docs/community_topic_comment_api.rst

    r12881 r12885  
    1818
    1919コレクション URI
    20     http://example.com/feeds/communityTopicComment/communityTopic/{community_topic_id}
     20    http://example.com/api.php/feeds/communityTopicComment/communityTopic/{コミュニティトピックのID}
    2121
    2222メンバ URI
    23     http://example.com/feeds/communityTopicComment/{community_topic_comment_id}
     23    http://example.com/api.php/feeds/communityTopicComment/{コミュニティトピックイベントのID}
     24
     25エントリ文書の書式
     26==================
     27
     28コミュニティトピックコメントのエントリは以下のような Atom エントリ文書で表現されます。
     29
     30::
     31
     32  <?xml version="1.0" encoding="UTF-8" ?>
     33  <entry xmlns="http://www.w3.org/2005/Atom">
     34    <id>http://example.com/communityTopicComment/{community_topic_comment_id}</id>
     35    <published>2009-01-25T19:40:22+09:00</published>
     36    <updated>2009-01-25T19:40:22+09:00</updated>
     37    <content type="text">コミュニティトピックコメント本文</content>
     38    <author>
     39      <name>投稿したメンバーのニックネーム</name>
     40      <uri>http://example.com/member/{member_id}</uri>
     41    </author>
     42    <link rel="self" type="application/atom+xml" href="http://example.com/api.php/feeds/communityTopicComment/{community_topic_comment_id}"/>
     43  </entry>
     44
     45
     46このエントリに含まれる要素の解説を以下に示します。
     47
     48 * /entry/id : エントリを識別するための ID となる URN (省略可)
     49 * /entry/published : エントリの作成日時 (省略可)
     50 * /entry/updated : エントリの更新日時 (省略可)
     51 * /entry/content : エントリの本文
     52 * /entry/author : エントリの作成者の情報
     53    * /entry/author/name : エントリの作成者のニックネーム
     54    * /entry/auhtor/uri : エントリの作成者を識別するための URN
     55 * /entry/link[@rel="self"] : OpenPNE Web API でこのエントリを参照するための URI (省略可)
     56
  • OpenPNE3/doc/branches/develop/OpenPNEWebAPI/docs/member_api.rst

    r12881 r12885  
    1616
    1717コレクション URI
    18     http://example.com/feeds/member
     18    http://example.com/api.php/feeds/member
    1919
    2020メンバ URI
    21     http://example.com/feeds/member/{member_id}
     21    http://example.com/api.php/feeds/member/{メンバーのID}
     22
     23エントリ文書の書式
     24==================
     25
     26メンバーのエントリは以下のような Atom エントリ文書で表現されます。
     27
     28::
     29
     30  <?xml version="1.0" encoding="UTF-8" ?>
     31  <entry xmlns="http://www.w3.org/2005/Atom">
     32    <id>http://example.com/member/{member_id}</id>
     33    <published>2009-01-23T16:21:12+09:00</published>
     34    <updated>2009-01-23T16:21:12+09:00</updated>
     35    <title type="text">メンバーのニックネーム</title>
     36    <content type="xhtml">
     37      <div xmlns="http://www.w3.org/1999/xhtml">
     38        <div id="sex">性別(男性|女性)</div>
     39        <div id="birthday">誕生日(yyyy-mm-dd)</div>
     40        <div id="self_intro">自己紹介文</div>
     41      </div>
     42    </content>
     43    <author>
     44      <email>example@example.com</email>
     45    </author>
     46    <link rel="self" type="application/atom+xml" href="http://example.com/api.php/feeds/member/{member_id}"/>
     47    <link rel="alternate" type="text/html" href="http://example.com/member/{member_id}"/>
     48    <link rel="alternate" href="http://example.com/mobile_frontend.php/member/{member_id}"/>
     49    <link rel="enclosure" href="メンバー画像URL" />
     50  </entry>
     51
     52このエントリに含まれる要素の解説を以下に示します。
     53
     54 * /entry/id : エントリを識別するための ID となる URN (省略可)
     55 * /entry/published : エントリの作成日時 (省略可)
     56 * /entry/updated : エントリの更新日時 (省略可)
     57 * /entry/title : エントリのニックネーム
     58 * /entry/content : エントリのプロフィール情報
     59    * /entry/content/div/div[@id="プロフィールを表す識別子"] : プロフィール設定値
     60 * /entry/author : このエントリのメンバーの情報
     61    * /entry/author/email : このメンバーのメールアドレス (管理者もしくは本人を除いて取得不可)
     62 * /entry/link[@rel="self"]/@href : OpenPNE Web API でこのエントリを参照するための URI (省略可)
     63 * /entry/link[@rel="alternate" and @type="text/html"]/@href : PC 版でこのエントリを閲覧するための URL (省略可)
     64 * /entry/link[@rel="alternate" and not(@type)]/@href : 携帯版でこのエントリを閲覧するための URL (省略可)
     65 * /entry/link[@rel="enclosure"]/@href : このエントリの画像 (省略可)
     66
Note: See TracChangeset for help on using the changeset viewer.