User Preferences¶
User Preferences - Update User Preferences¶
HTTP Request
PUT /api/v1/user-preferences
📋 Description: Updates the user preferences for the authenticated user, allowing for personalized settings to enhance user experience and engagement.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
true |
Request body containing user preference settings, including notification preferences, language selection, and theme customization options. |
Body Parameters
1{
2 "id": 0,
3 "userId": 0,
4 "username": "string",
5 "firstName": "string",
6 "lastName": "string",
7 "locale": "string",
8 "captionLanguage": "ENGLISH"
9}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "userId": 0,
17 "username": "string",
18 "firstName": "string",
19 "lastName": "string",
20 "locale": "string",
21 "captionLanguage": "ENGLISH"
22 }
23}
User Preferences - Search¶
HTTP Request
POST /api/v1/user-preferences/search
📋 Description: Submits a request to search for user preferences based on specified criteria, enabling personalized experiences and tailored interactions within the application.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
body |
body |
object |
false |
Request body containing user preference criteria, including filters and sorting options, to facilitate targeted searches for personalized user experiences. |
» filter |
body |
false |
Data transfer object representing user preferences for personalized experiences within the application, enabling tailored interactions and improved user satisfaction. |
|
»» idIn |
body |
[integer] |
false |
Filter by multiple values of id |
»» idEqual |
body |
integer(int64) |
false |
Filter by exact match of id |
»» idLike |
body |
string |
false |
Filter by partial match of id |
»» createdAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is greater than or equal to specified value |
»» createdAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where created at is less than or equal to specified value |
»» createdByLike |
body |
string |
false |
Filter by partial match of created by |
»» createdByEqual |
body |
string |
false |
Filter by exact match of created by |
»» modifiedAtGreaterThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is greater than or equal to specified value |
»» modifiedAtLessThanOrEqual |
body |
string(date-time) |
false |
Filter where modified at is less than or equal to specified value |
»» modifiedByLike |
body |
string |
false |
Filter by partial match of modified by |
»» modifiedByEqual |
body |
string |
false |
Filter by exact match of modified by |
»» userIdEqual |
body |
integer(int64) |
false |
Filter by exact match of user id |
»» usernameLike |
body |
string |
false |
Filter by partial match of username |
»» firstNameLike |
body |
string |
false |
none |
»» lastNameLike |
body |
string |
false |
none |
»» localeLike |
body |
string |
false |
Filter by partial match of locale |
»» localeEqual |
body |
string |
false |
Filter by exact match of locale |
»» captionLanguageEqual |
body |
string |
false |
Filter by exact match of caption language |
» pageable |
body |
false |
Data transfer object representing a paginated collection of results, enabling efficient navigation through large datasets while providing essential metadata for user interaction and data management. |
|
»» page |
body |
integer(int32) |
false |
Page number for pagination |
»» size |
body |
integer(int32) |
false |
Number of items per page |
»» sort |
body |
[string] |
false |
Sort order specification |
Enumerated Values
Attribute |
Value |
|---|---|
»» captionLanguageEqual |
CHINESE, ENGLISH, FRENCH, JAPANESE, SPANISH |
Parameter Constraints¶
Parameter |
Constraints |
|---|---|
»» page |
Min: 0 |
»» size |
Min: 1 |
Body Parameters
1{
2 "filter": {
3 "idIn": [
4 0
5 ],
6 "idEqual": 0,
7 "idLike": "string",
8 "createdAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
9 "createdAtLessThanOrEqual": "2019-08-24T14:15:22Z",
10 "createdByLike": "string",
11 "createdByEqual": "string",
12 "modifiedAtGreaterThanOrEqual": "2019-08-24T14:15:22Z",
13 "modifiedAtLessThanOrEqual": "2019-08-24T14:15:22Z",
14 "modifiedByLike": "string",
15 "modifiedByEqual": "string",
16 "userIdEqual": 0,
17 "usernameLike": "string",
18 "firstNameLike": "string",
19 "lastNameLike": "string",
20 "localeLike": "string",
21 "localeEqual": "string",
22 "captionLanguageEqual": "ENGLISH"
23 },
24 "pageable": {
25 "page": 0,
26 "size": 1,
27 "sort": [
28 "string"
29 ]
30 }
31}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "totalElements": 0,
3 "totalPages": 0,
4 "pageable": {
5 "paged": true,
6 "unpaged": true,
7 "pageNumber": 0,
8 "pageSize": 0,
9 "offset": 0,
10 "sort": {
11 "unsorted": true,
12 "sorted": true,
13 "empty": true
14 }
15 },
16 "numberOfElements": 0,
17 "size": 0,
18 "content": [
19 {
20 "id": 0,
21 "userId": 0,
22 "username": "string",
23 "firstName": "string",
24 "lastName": "string",
25 "locale": "string",
26 "captionLanguage": "ENGLISH"
27 }
28 ],
29 "number": 0,
30 "sort": {
31 "unsorted": true,
32 "sorted": true,
33 "empty": true
34 },
35 "first": true,
36 "last": true,
37 "empty": true
38}
User Preferences - Patch User Preferences¶
HTTP Request
PATCH /api/v1/user-preferences/{id}
📋 Description: Updates the user preferences for a specified user ID, allowing for customization of settings to enhance user experience and engagement.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
id |
path |
integer(int64) |
true |
Unique identifier for the resource |
body |
body |
true |
Request body containing the updated user preference settings, including notification preferences and display options, to enhance user experience. |
Body Parameters
1{}
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "code": "UPDATED",
3 "errors": {
4 "all": [
5 {
6 "type": "GENERIC",
7 "errorMessage": "string",
8 "source": {},
9 "field": "string",
10 "errorKey": "string"
11 }
12 ]
13 },
14 "object": {
15 "id": 0,
16 "userId": 0,
17 "username": "string",
18 "firstName": "string",
19 "lastName": "string",
20 "locale": "string",
21 "captionLanguage": "ENGLISH"
22 }
23}
User Preferences - Get By User ID¶
HTTP Request
GET /api/v1/user-preferences/{userId}
📋 Description: Retrieves user preferences for the specified user ID, allowing businesses to tailor experiences and services based on individual user settings.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
userId |
path |
integer(int64) |
true |
Unique identifier for the user |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
Example Responses
1{
2 "id": 0,
3 "userId": 0,
4 "username": "string",
5 "firstName": "string",
6 "lastName": "string",
7 "locale": "string",
8 "captionLanguage": "ENGLISH"
9}
User Preferences - Get Captionlanguage Locale¶
HTTP Request
GET /api/v1/user-preferences/caption-language-locale/{username}
📋 Description: Retrieves the caption language locale settings for a specified user, enabling personalized content accessibility and enhancing user experience.
Parameters
Name |
In |
Type |
Required |
Description |
|---|---|---|---|---|
username |
path |
string |
true |
Specifies the username of the user for whom the caption language locale preferences are being retrieved. |
Responses
Status |
Meaning |
Description |
Schema |
|---|---|---|---|
200 |
OK |
string |
Example Responses
1"string"