ResponseUserPreferencesDto

Example Json Object

 1{
 2  "code": "UPDATED",
 3  "message": "string",
 4  "defaultMessage": "string",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "errorMessage": "string",
11        "source": {},
12        "field": "string",
13        "errorKey": "string"
14      }
15    ]
16  },
17  "object": {
18    "id": 0,
19    "userId": 0,
20    "username": "string",
21    "firstName": "string",
22    "lastName": "string",
23    "locale": "string",
24    "captionLanguage": "ENGLISH"
25  }
26}

📄 Description: Data transfer object representing user preferences within the application, facilitating personalized experiences and tailored interactions to enhance user engagement and satisfaction.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Textual representation of the user’s preferences or notifications, providing insights into user engagement and personalization.

defaultMessage

string

false

write-only

Default message to be displayed to users, enhancing communication and user experience within the application.

debugMessage

string

false

write-only

Provides detailed information about any issues encountered during the processing of user preferences, aiding in troubleshooting and enhancing user experience.

errors

Errors

false

none

Collection of error messages related to user preferences, providing insights for troubleshooting and enhancing user experience.

object

UserPreferencesDto

false

none

Represents the user preferences associated with the response, enabling personalized interactions and improved user experience.

Enumerated Values

Attribute

Value

code

API_CALL_FAILED, ATTACHED, BAD_REQUEST, DATA_VALIDATION_ERROR, DELETED, DETACHED, INTERNAL_SYSTEM_ERROR, NULL_RESPONSE, OK, OK_BUT_RESPONSE_INVALID, REQUEST_VALIDATION_ERROR, SERVICE_VALIDATION_ERROR, UPDATED