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        "errorMessage": "string",
11        "source": {},
12        "field": "string",
13        "errorKey": "string"
14      }
15    ]
16  },
17  "object": {}
18}

📄 Description: ResponseVoid is a data transfer object used to signify the successful completion of an API request that does not return 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 the response message providing additional context or information regarding the API request outcome.

defaultMessage

string

false

write-only

Default message to be displayed when no specific message is provided in the response.

debugMessage

string

false

write-only

Provides a detailed message for debugging purposes, assisting in the identification and resolution of issues within the API response.

errors

Errors

false

none

Contains details of any errors encountered during the API request, providing essential insights for troubleshooting and ensuring operational efficiency.

object

object

false

none

Represents the structured response object containing the outcome of the API request, facilitating seamless integration and data handling.

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