API_FAV_0103_お気に入り一覧取得¶

概要¶

お気に入りに登録したユーザの一覧を取得する

リクエスト¶

HTTPリクエスト¶

HTTPメソッド	URL
GET	/api/users/{userId}/favorites

パスパラメーター¶

変数名	型	必須	論理名	デフォルト値	制限	例
userId	string	✅	ユーザID	-	ULID形式	01D0KDBRASGD5HRSNDCKA0AH53

クエリパラメーター¶

なし

リクエストボディ¶

なし

レスポンス¶

200 OK¶

レスポンスサンプル
{
  "favorites": [
    {
      "targetId": "01D0KDBRASGD5HRSNDCKA0AH53",
      "name": "佐藤太郎",
      "nameKana": "さとうたろう"
    },
    {
      "targetId": "01D0KDBRASGD5HRSNDCKA0AH61",
      "name": "佐藤次郎",
      "nameKana": "さとうじろう"
    }
  ]
}

変数名	型	必須	論理名	形式
favorites	array(obj)	✅	お気に入り一覧
favorites > targetId	string	✅	対象ユーザID	ULID形式
favorites > name	string	✅	ユーザ名
favorites > nameKana	string	✅	ユーザ名(かな)

エラーレスポンス¶

404 Not Found¶

err_code	err_message	説明
E4041	userId is not found.	ユーザが見つからなかった場合

500 Internal Server Error¶

err_code	err_message
E5001	Failed to auth server.