Skip to main content

Result

Represents the result of the API call, could be success or failure.

Properties

PropertyTypeDescription
SucceededbooleanIndicates if the operation was successful.
DataobjectThe actual result data (only present if Succeeded is true).
ErrorErrorDomain-level error details (only present if Succeeded is false).
SystemErrorSystemErrorMore detailed internal error in system level.
CapturedValuesobjectAdditional contextual metadata in key-value based format (optional).

Error Object

PropertyTypeDescription
CodestringThe code of error, could be usefule for programmatic handling.
MessagestringThe message of error.

SystemError Object

PropertyTypeDescription
MessagestringThe message of error.
ModelStateobjectkey-value based model state error details, key is string, value type is an array of string.