設定情報の取得
説明
指定した ID の設定情報を取得します。
必要権限
アカウント設定の変更
URL
GET /system/users/{userIds}/preference
パスパラメーター
名前 | 型 | 必須か | 説明 |
---|---|---|---|
userIds | string | ○ | ユーザーID |
レスポンス
名前 | 型 | 説明 |
---|---|---|
ー | UserPreference[] | ユーザー分のレスポンスを返す。 |
エラーケース
- なし
特記事項
- 必要権限がないユーザーからの要求に対しては、空データを返します。
- 必要権限が「アカウント設定の変更」のみの場合、ログインユーザーの情報のみ取得できます。
サンプル
ユーザーを指定して休憩時間を取得する
GET /system/users/21/preference
Response
200 OK
[
{
"userId":"21",
"breakTimes":[
{
"startTime":"12:00",
"endTime":"13:00"
}
],
"firstVisibleTimeStartTime": "8:00",
"showNameWithMemo": false
}
]
型定義
UserPreference
名前 | 型 | 説明 |
---|---|---|
userId | string | ユーザーID |
breakTimes | BreakTime[] | 休憩時間 |
firstVisibleTimeStartTime | string | 初期表示時刻 |
ShowNameWithMemo | boolean | メモ登録時にアイテム名称を表示するか |
BreakTime
名前 | 型 | 説明 |
---|---|---|
startTime | string | 開始時刻 |
endTime | string | 終了時刻 |