アイコン画像

グループアイコンやプロフィール画像を操作するためのAPIです。

リクエスト

エンドポイント

  • https://api.cybozulive.com/api/icon/V2

利用可能な HTTP メソッド

GET

リクエスト制限

必須パラメータ

  • type - 取得したいアイコンの種別を指定します。 “group” または “user”
  • group - アイコンを取得したいグループの ID を指定します。( type が “group” のとき)
  • user - アイコンを取得したいユーザーの ID を指定します。( type が “user” のとき)

オプションパラメータ

  • group - グループでのアイコンを取得したい場合のグループの ID を指定します。( type が “user” のとき)
  • scale - full を指定すると、原寸大の画像を取得します。
  • key - 招待コードを指定すると、招待中のグループのロゴを取得することができます。

パラメータ組み合わせと取得できるアイコン

  • type が “group” の場合
group 取得できるアイコン
所属するグループのID グループアイコン
  • type が “user” の場合
user group 取得できるアイコン
自分のユーザーID 指定しない 自分のメインプロフィール のプロフィール画像
他人のユーザーID 指定しない 指定ユーザーが自分に開示しているプロフィール [1] のプロフィール画像
自分のユーザーID 自分が所属するグループのID 自分が指定グループに開示しているプロフィール [1] のプロフィール画像
他人のユーザーID 自分と指定ユーザーが所属するグループのID 指定ユーザーが指定グループに開示している [1] プロフィールのプロフィール画像
[1](1, 2, 3) プロフィールがひとつの場合は、メインプロフィール

グループアイコンを取得する

グループを指定して、グループアイコンを取得します。

Examples

リクエストの例:

GET /api/icon/V2?type=group&group=1:1
レスポンスの例::
レスポンスヘッダ
Content-Type: image/jpegimage/png など
レスポンスボディ
グループアイコンのバイナリデータ

注釈

エラーが発生した場合は、Atom 形式のレスポンスとなります。

自分のメインプロフィールのプロフィール画像を取得する

自分のユーザーID( 2:10 )を指定して、自分のメインプロフィールのプロフィール画像を取得します。

Examples

リクエストの例:

GET /api/icon/V2?type=user&user=2:10
レスポンスの例::
レスポンスヘッダ
Content-Type: image/jpegimage/png など
レスポンスボディ
プロフィール画像のバイナリデータ

注釈

エラーが発生した場合は、Atom形式のレスポンスとなります。

エラーコード

パラメータが不正な場合などにはエラーの XML が返ります。 <error> 要素の中身を確認してください。

  • パラメータ type が “group” のとき
  • パラメータ group に所属していないグループを指定した場合
  • パラメータ group に存在しないグループを指定した場合
  • パラメータ type が “user” のとき
  • パラメータ user にコネクションに含まれていないユーザーを指定した場合
  • パラメータ user に存在しないユーザーを指定した場合
  • パラメータ user に自分を指定し、パラメータ group に自分が所属しないグループを指定した場合
  • パラメータ user に他人を指定し、パラメータ group に自分も指定ユーザーも所属しないグループを指定した場合
  • パラメータ group に存在しないグループを指定した場合

アプリケーションに権限が不足している場合もエラーが返ります。