user.getInfo

user.getInfo

オリジナル: http://wiki.lingr.com/dev/show/UserGetInfo

翻訳日: 2007/02/25

原文リビジョン: 14


現在存在するAPIセッションにてログインしたユーザ情報を取得する。1分に1回以上のポーリングはしないで下さい。

HTTPメソッド

GET

パラメータ

session(必須)

session.createで得たセッションID

format(オプション)

希望の応答フォーマット。指定する場合、"xml"か"json"を指定します。指定しない場合、デフォルトxmlとなります。

callback(オプション)

フォーマットjsonを指定した場合に指定できます。コールバック関数名を指定します。

認証

このメソッドを呼び出すセッションではあらかじめ認証にパスしておく必要があります。


応答の例

<?xml version="1.0" encoding="UTF-8"?>
<response>
  <status>ok</status>
  <user_id>duWDM2k3Eho</user_id>
  <email>foo@bar.com</email>
  <default_nickname>The Foo Guy</default_nickname>
  <description>Check out my blog at  http://blog.fooguy.com</description>
  <counter>7</counter>
  <owned_rooms>
    <owned_room>
      <id>1dKi3NA0vgf</id>
      <name>Frog Lovers</name>
      <description>All about frogs</description>
      <url>http://www.lingr.com/room/1dKi3NA0vgf</url>
      <icon_url>http://images.lingr.com/room/1dKi3NA0vgf/16x16.gif</icon_url>
      <counter>123</counter>
      <max_user_message_id>120</max_user_message_id>
      <tags/>
    </owned_room>
    <owned_room>
      <id>gcnZ3vAcZDA</id>
      <name>Cow Lovers</name>
      <description>All about cows</description>
      <url>http://www.lingr.com/room/gcnZ3vAcZDA</url>
      <icon_url>http://images.lingr.com/room/gcnZ3vAcZDA/16x16.gif</icon_url>
      <tags/>
    </owned_room>
  </owned_rooms>
  <favorite_rooms>
  </favorite_rooms>
  <monitored_rooms>
  </monitored_rooms>
  <visited_rooms>
  </visited_rooms>
  <occupied_rooms>
  </occupied_rooms>
  <icon_url>http://images.lingr.com/user/duWDM2k3Eho/80x80.gif</icon_url>
</response>

応答の内容

成功したメソッド呼び出しの応答は以下の要素を持ちます。

user_id

このユーザユニークID

email

Lingrに登録されたE-mailアドレス

default_nickname

このユーザデフォルトニックネーム

description

このユーザプロフィール説明

counter

ユーザプロフィールバージョン番号

owned_rooms

このユーザが作成したルームの情報を格納した配列です。それぞれのルーム情報は次のページに記載された要素を持ちます。→Room

favorite_rooms

このユーザがお気に入りとしてマークしたルームの情報を格納した配列です。それぞれのルーム情報は次のページに記載された要素を持ちます。→Room

monitored_rooms

このユーザモニターするように指定したルームの情報を格納した配列です。それぞれのルーム情報は次のページに記載された要素を持ちます。→Room

visited_rooms

このユーザが訪れたことのあるルームの情報を格納した配列です。それぞれのルーム情報は次のページに記載された要素を持ちます。→Room

occupied_rooms

このユーザ現在入室しているルーム情報を格納した配列です。

それぞれのルーム情報は次のページに記載された要素を持ちます。→Room

icon_url

このユーザアバターアイコン画像URLですこのURLは次のページに記載された構造をしています。→Image URLs

エラーコード

100: 不正HTTPメソッド

HTTPメソッドが間違っています。

102: 不正セッション

セッションID不正です。

104: 不正な応答フォーマット

要求された応答フォーマットサポートされていません。

106: ログインしていない

与えられたセッションログインしていないユーザの物です。

112: 制限以上のレートでのリクエスト

許可されたレート以上でリクエストポーリングが行われた。

120: 不正文字コードエンコーディング

あなたが入力したデータUTF-8として不正エンコーディングを含んでいます。

詳細は「APIの基礎について学ぶ」を参照してください。