ResponseVoid

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}

📄 Description: ResponseVoid is a data transfer object that signifies the successful completion of an API request without returning any content, ensuring efficient communication in scenarios where no additional data is required.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Code identifier for the resource

message

string

false

write-only

Contains a brief message providing additional context or information related to the API response.

defaultMessage

string

false

write-only

Default message to be displayed in the absence of a specific response, ensuring consistent communication with users.

debugMessage

string

false

write-only

Optional string that provides additional information about the processing status or errors encountered during the API request, aiding in troubleshooting and system diagnostics.

errors

Errors

false

none

Collection of error messages generated during the API request, providing insights for troubleshooting and resolution.

object

object

false

none

Represents the response structure for operations that do not return any content, ensuring clarity in the API’s interaction.

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