ユーザー取得
TimeLine上のユーザーを取得するAPIについて説明します。
リクエストURL
- 機能：
- 「:id」でIDを指定されたユーザーの情報を取得します。
- 機能：
- 「:name」でニックネームを指定されたユーザーの情報を取得します。
リクエストメソッド
GETまたはPOST
リクエスト
| パラメータ | 項目名 | 説明 | 必須 | 値 | デフォルト値 |
|---|---|---|---|---|---|
| id | ユーザーのID | ユーザーのID (URLのパスに含めてください。) | ※1 | 数値 | なし |
| nickname | ニックネーム | ユーザーのニックネーム | ※1 | 文字列 | なし |
※1 「ユーザのID」もしくは「ニックネーム(nickname)」の指定が必須となります。(同時に指定された場合は「ニックネーム」の指定が優先されます。)
レスポンス
レスポンスは以下の要素から構成されます。
| 要素名 | 説明 | 値 |
|---|---|---|
| response | ||
| status | ||
| code | ステータスコード | 数値 |
| message | ステータスメッセージ | 文字列 |
| language | 言語情報 | 文字列 |
| result | ||
| user | ユーザーの詳細 |
「ユーザーの詳細」は以下の要素から構成されます。
| 要素名 | 説明 | 値 |
|---|---|---|
| nickname | ユーザーのニックネーム | 文字列 |
| link | ユーザーのマイページのURL | URL |
| introduction | ユーザーの紹介文 | 文字列 |
| image | ユーザーの画像のURL | URL |
サンプルレスポンス
以下は、ID=1のユーザーを取得するリクエストに対するレスポンスです。
エラー
存在しないユーザーを指定した場合はエラーとなります。
