ResponseListContractSubscriptionDto¶
Example Json Object
1{
2 "code": "OK",
3 "message": "Successfully retrieved list of Contact subscription.",
4 "defaultMessage": "Operation completed successfully.",
5 "debugMessage": "No errors occurred during the query execution.",
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 {
19 "id": 10000001,
20 "topic": {
21 "enCaption": "Lease Component Updated",
22 "frCaption": "Composant de bail mis à jour",
23 "name": "LEASE_COMPONENT_UPDATED",
24 "priority": "HIGH"
25 },
26 "username": "super.admin@nakisa.com",
27 "contractId": 10000001,
28 "contractDisplayId": "CT-100000000",
29 "targetId": "CT-100000000",
30 "targetType": "CONTRACT"
31 }
32 ]
33}
📄 Description: Represents a standard response wrapper for returning a list of Contact subscription entities.
Properties
Name |
Type |
Required |
Restrictions |
Description |
|---|---|---|---|---|
code |
string |
false |
none |
Response code indicating success or failure. |
message |
string |
false |
write-only |
A short message describing the response status. |
defaultMessage |
string |
false |
write-only |
Default message in case no specific message is set. |
debugMessage |
string |
false |
write-only |
Detailed message useful for debugging purposes. |
errors |
false |
none |
none |
|
object |
false |
none |
List of Contract subscription entities returned by the request. |
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 |