Usage
Represents the result of a requested operation for a specific API-Object.
Definition
Field
|
Type
|
Description
|
(M)andatory / (O)ptional
|
Default Value (If Optional)
|
Id
|
Int
|
Internal ID of the Data record
|
O
|
null
|
Key
|
String(100)
|
Usually the external ID of a data record.
|
O
|
null
|
Successful
|
bool
|
Supplement, e.g. Building
|
M
|
null
|
ErrorCode
|
String(100)
|
If not successful, contains the error code
|
O
|
null
|
Message
|
String(200)
|
A message containing additional information for the operation
|
O
|
null
|
Error Codes
| Code |
Description |
| unknown |
Ups, something unpredictable happened. |
| notfound |
The resource or record was not found. Usually returned with HttpStatus 400 |
BrokenRule_Empty
|
The field {0} must not be empty
|
BrokenRule_Invalid
|
The value is not valid
|
BrokenRule_MinimumLength
|
The field {0} must be at least {2} characters long.
|
BrokenRule_MaximumLength
|
The field {0} can be at least {2} characters long.
|
BrokenRule_NotUnique
|
Title already exists
|
BrokenRule_Number
|
The field {0} must be a number.
|
BrokenRule_TooHigh
|
The Value is too high
|
BrokenRule_TooLow
|
The Value is too low
|
| ServiceException |
See log |
Example
{
"Id": 12,
"Key": "ABC1",
"Successful": true,
"ErrorCode": "",
"Message": ""
}
