API_FAV_0104_お気に入りの今日の履歴取得
概要
お気に入りに登録しているユーザの今日の履歴を取得する
リクエスト
HTTPリクエスト
| HTTPメソッド | URL |
| GET | /api/users/{userId}/favorites/records |
パスパラメーター
| 変数名 | 型 | 必須 | 論理名 | デフォルト値 | 制限 | 例 |
| userId | string | ✅ | ユーザID | - | ULID形式 | 01D0KDBRASGD5HRSNDCKA0AH53 |
クエリパラメーター
なし
リクエストボディ
なし
レスポンス
200 OK
| レスポンスサンプル |
|---|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18 | {
"records": [
{
"targetId": "01D0KDBRASGD5HRSNDCKA0AH53",
"name": "佐藤太郎",
"startTime": "08:58",
"endTime": "18:21",
"isHome": true
},
{
"targetId": "01D0KDBRASGD5HRSNDCKA0AH61",
"name": "佐藤太郎",
"startTime": "09:00",
"endTime": "18:01",
"isHome": true
}
]
}
|
| 変数名 | 型 | 必須 | 論理名 | 形式 |
| favorites | array(obj) | ✅ | 履歴一覧 | |
| favorites > targetId | string | ✅ | 対象ユーザID | ULID形式 |
| favorites > name | string | ✅ | ユーザ名 | |
| favorites > startTime | string|null | ✅ | 開始時間 | hh:mm |
| favorites > endTime | string|null | ✅ | 終了時間 | hh:mm |
| favorites > isHome | boolean|null | ✅ | 在宅フラグ | true=在宅 false=出社 |
エラーレスポンス
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. |