メンバー名簿

メンバー名簿の情報を取得します。

リクエスト

エンドポイント

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

利用可能な HTTP メソッド

GET

必須パラメータ

  • group - グループの ID を指定します。

オプションパラメータ

  • start-index - コレクションを取得する場合のインデクスを指定します。値は正数のみ可能です。デフォルトは “0” です。
  • max-results - コレクションを取得する場合の最大件数を指定します。値は正数のみ可能です。デフォルトは “20” です。上限は “100” です。
  • member-status - 絞り込むメンバーステータスを指定します。”JOIN” を指定すると参加中、”INVITE” を指定すると招待中のメンバーを取得します。デフォルトは “JOIN” です。
  • user - 取得するメンバーIDを指定します。user を指定した場合、他のオプションパラメータは無視されます。

メンバーを取得する

Examples

リクエストの例:

GET /api/gwMemberList/V2?group=1:1

レスポンスの例:

<feed xmlns="http://www.w3.org/2005/Atom"
      xmlns:cbl="http://schemas.cybozulive.com/common/2010"
      xmlns:cblGrp="http://schemas.cybozulive.com/group/2010"
      xmlns:cblPrfl="http://schemas.cybozulive.com/profile/2010">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com/" />
  <author>
    <name>高橋 健太</name>
    <email>takahashi@example.com</email>
    <uri>1:5</uri>
  </author>
  <cbl:totalCount>2</cbl:totalCount>
  <entry>
    <id>1:26</id>
    <title>佐藤 昇</title>
    <link rel="mobile" 
          href="https://m.cybozulive.com/m/1_1/gwMemberList/view?groupwareMemberId=1%3A26" />
    <cbl:group valueString="グループウェア1" id="1:1"/>
    <cbl:who valueString="佐藤 昇" id="1:1"/>
    <cblPrfl:familyKana>さとう</cblPrfl:familyKana>
    <cblPrfl:givenKana>のぼる</cblPrfl:givenKana>
    <updated>2015-07-17T15:53:08Z</updated>
    <cblGrp:groupwareMemberId>1:26</cblGrp:groupwareMemberId>
    <cblGrp:manager>true</cblGrp:manager> 
    <cblGrp:invitable authority="true">true</cblGrp:invitable>
    <cblGrp:leavable>false</cblGrp:leavable>
    <cblGrp:deletable authority="true">false</cblGrp:deletable>
  </entry>
  <entry>
    <id>1:27</id>
    <title>高橋 健太</title>
    <cbl:group valueString="グループウェア1" id="1:1"/>
    <cbl:who valueString="高橋 健太" id="1:5"/>
    <cblPrfl:familyKana>たかはし</cblPrfl:familyKana>
    <cblPrfl:givenKana>けんた</cblPrfl:givenKana>
    <updated>2015-08-12T08:26:12Z</updated>
    <cblGrp:groupwareMemberId>1:27</cblGrp:groupwareMemberId>
    <cblGrp:manager>false</cblGrp:manager> 
    <cblGrp:invitable authority="false">false</cblGrp:invitable>
    <cblGrp:leavable>true</cblGrp:leavable>
    <cblGrp:deletable authority="false">false</cblGrp:deletable>
  </entry>
</feed>

注釈

グループメンバーID は <id> 要素と <cblGrp:groupwareMemberId> 要素に同じ値を含みます。 将来的に <id> 要素は廃止します。<cblGrp:groupwareMemberId> 要素を使用してください。

招待中のメンバーを取得する

Examples

リクエストの例:

GET /api/gwMemberList/V2?group=1:1&member-status=INVITE

レスポンスの例:

<?xml version="1.0" encoding="UTF-8"?>
<feed xmlns="http://www.w3.org/2005/Atom" 
      xmlns:cblGrp="http://schemas.cybozulive.com/group/2010" 
      xmlns:cbl="http://schemas.cybozulive.com/common/2010">
  <title>サイボウズLive</title>
  <link rel="alternate" href="https://cybozulive.com/" />
  <author>
    <name>高橋 健太</name>
    <email>takahashi@example.com</email>
    <uri>1:5</uri>
  </author>
  <cbl:totalCount>1</cbl:totalCount>
  <entry>
    <title>松田さん</title>
    <link rel="mobile" 
     href="https://m.cybozulive.com/m/1_1/gwMemberList/invitationView?groupwareMemberId=1%3A13" />
    <author>
      <name />
    </author>
    <id>1:13</id>
    <cbl:when endTime="2015-08-20T14:59:59Z" />
    <cbl:group valueString="グループウェア1" id="1:1"/>
    <cblGrp:groupwareMemberId>1:13</cblGrp:groupwareMemberId>
    <cblGrp:manager>false</cblGrp:manager>
    <cblGrp:invitable authority="false">false</cblGrp:invitable>
    <cblGrp:leavable>false</cblGrp:leavable>
    <cblGrp:deletable authority="false">false</cblGrp:deletable>
  </entry>
</feed>

指定メンバーを取得する

Examples

リクエストの例:

GET /api/gwMemberList/V2?group=1:1&user=1:5

レスポンスの例:

メンバーを取得する と同様の形式のレスポンスを返します。

エラーコード

ありません。