ResponseListContactDto¶
Example Json Object
1{
2 "code": "OK",
3 "message": "Successfully retrieved list of Contacts.",
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 "displayId": "CONT-0001",
21 "name": "Jane Doe",
22 "position": "Procurement Manager",
23 "email": "jane.doe@example.com",
24 "phone": "+49 123 456 7890",
25 "address": "123 Business St, Berlin, Germany",
26 "description": "Main point of contact for vendor negotiations.",
27 "group": "string",
28 "buildingName": "string",
29 "fax": "string",
30 "numberRangeIdentifierType": {
31 "name": "COMPANY_CODE"
32 },
33 "numberRangeIdentifierValue": "BU-01",
34 "numberRangeType": {
35 "name": "CONTRACT"
36 },
37 "allowsSystemGenerateNewId": true
38 }
39 ]
40}
📄 Description: Represents a standard response wrapper for returning a list of Contact 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 partner 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 |