ユーザの検索
ユーザ検索APIで取得できるデータの種類を詳しくご説明します。
リクエストURL
- 機能：
- 指定した条件にマッチしたユーザ情報を取得します。
リクエストパラメータ
| パラメータ | 項目名 | 説明 | 値 | デフォルト値 |
|---|---|---|---|---|
| nickname | ニックネーム | ニックネームからユーザを検索 | 文字列 | - |
| interest | 興味 | 興味からユーザを検索 | 文字列 | - |
| contacts | コンタクト | 該当ユーザIDのコンタクトを検索 | 数値 | - |
| followers | コンタクト | 該当ユーザIDをコンタクトに追加しているユーザを検索 | 数値 | - |
| order | 表示順指定 | ユーザのソート順は、以下の指定が可能です。
dict: ニックネームの辞書順 |
文字列 | new_to_old |
| hits | 取得件数 | レスポンス毎に含まれるユーザの件数 | 数値(1-100) | 20 |
| page | 取得ページ | ユーザ一覧のページ番号 | 数値 | 1 |
・GETで文字列の値を設定する場合は、URLエンコードしてください。
レスポンス
| パラメータ | 項目名 | 値 |
|---|---|---|
| response | - | - |
| status | statusタグ内は、共通仕様の応答メッセージを参照してください。 | - |
| result | - | - |
| summary | - | - |
| total | 全件数 | 数値 |
| page | 現在のページ番号 | 数値 |
| page_count | 全ページ数 | 数値 |
| users | - | - |
| user | userタグ内はユーザの詳細情報取得のuserタグと同じ情報が件数分表示されます。 | - |
サンプルレスポンス
ユーザがヒットしない場合
ユーザがヒットしない場合(0人の場合)は以下の様に値を返します。
エラー
検索条件に誤りがある場合は下記の様なエラーとなります。
ステータスのコードについてはステータスコードを参照してください。
