ResponseUserLinkDto

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        "source": {},
11        "errorMessage": "string",
12        "field": "string",
13        "errorKey": "string"
14      }
15    ]
16  },
17  "object": {
18    "id": 0,
19    "displayId": "string",
20    "displayName": "string",
21    "description": "string",
22    "url": "string",
23    "entityId": 0,
24    "entityType": "INVOICE",
25    "allowsSystemGenerateNewId": true,
26    "numberRangeIdentifierValue": "string",
27    "numberRangeIdentifierType": {
28      "name": "string"
29    },
30    "numberRangeType": {
31      "name": "string"
32    }
33  }
34}

📄 Description: Data transfer object representing a user link response, encapsulating essential user identification and relationship details for effective user management and integration within the system.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains the message content related to the user link response, providing context or feedback for the operation performed.

defaultMessage

string

false

write-only

Default message to be displayed for user links when no specific message is provided, enhancing user experience by ensuring consistent communication.

debugMessage

string

false

write-only

Provides detailed information about any errors or issues encountered during the processing of the user link response.

errors

Errors

false

none

Collection of error messages that provide insights into issues encountered during the processing of user link requests.

object

UserLinkDto

false

none

Represents the user link details associated with the response, facilitating user-specific interactions within the system.

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