ResponseVoid

Example Json Object

 1{
 2  "code": "OK",
 3  "message": "Operation completed successfully",
 4  "defaultMessage": "Success",
 5  "debugMessage": "string",
 6  "errors": {
 7    "all": [
 8      {
 9        "type": "GENERIC",
10        "source": {},
11        "field": "string",
12        "errorKey": "string",
13        "errorMessage": "string"
14      }
15    ]
16  },
17  "object": {}
18}

📄 Description: Represents a generic response structure for void operations, including status, messages, and errors.

Properties

Name

Type

Required

Restrictions

Description

code

string

false

none

Status code representing the outcome of the operation.

message

string

false

write-only

User-friendly message describing the result of the operation.

defaultMessage

string

false

write-only

Default message if no custom message is provided.

debugMessage

string

false

write-only

Optional debug information, useful for developers.

errors

Errors

false

none

none

object

object

false

none

The payload returned by the operation; for void operations this is null.

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