MGCLatticeOrderOperationResponseContract

Standard response contract returned by all Lattice integration service operations, carrying success/failure status, execution timing, correlation and idempotency identifiers, the affected document ID, the number of the document the operation produced, and categorized diagnostic messages.

Methods

new

Initializes a new instance of the MGCLatticeOrderOperationResponseContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeOrderOperationResponseContract class.

• Visibility: public
• Returns: MGCLatticeOrderOperationResponseContract A new MGCLatticeOrderOperationResponseContract instance.

No parameters.

parmSuccess

Gets or sets whether the service operation completed successfully.

• Visibility: public
• Returns: boolean True if the operation succeeded; otherwise, false.

Name	Type	Optional	Description
_success	boolean	Yes	True if the operation succeeded; otherwise, false.

parmStatus

Gets or sets the operation lifecycle status (None, Queued, Processing, Succeeded, or Failed).

• Visibility: public
• Returns: MGCLatticeServiceCallStatus The lifecycle status value.

Name	Type	Optional	Description
_status	MGCLatticeServiceCallStatus	Yes	The lifecycle status value.

parmErrorCode

Gets or sets the machine-readable error code categorizing the failure cause.

• Visibility: public
• Returns: MGCLatticeServiceErrorCode The error code value.

Name	Type	Optional	Description
_errorCode	MGCLatticeServiceErrorCode	Yes	The error code value.

parmIsRetryable

Gets or sets whether the failed operation can be safely retried by the caller.

• Visibility: public
• Returns: boolean True if the operation is retryable; otherwise, false.

Name	Type	Optional	Description
_isRetryable	boolean	Yes	True if the operation is retryable; otherwise, false.

parmMessage

Gets or sets the human-readable result message describing the operation outcome.

• Visibility: public
• Returns: str The result message text.

Name	Type	Optional	Description
_message	str	Yes	The result message text.

parmCorrelationId

Gets or sets the correlation identifier for tracing the request across systems.

• Visibility: public
• Returns: Guid The CorrelationId value.

Name	Type	Optional	Description
_correlationId	Guid	Yes	The CorrelationId value.

parmExecutionId

Gets or sets the server-generated execution identifier uniquely identifying this invocation.

• Visibility: public
• Returns: Guid The unique execution GUID.

Name	Type	Optional	Description
_executionId	Guid	Yes	The unique execution GUID.

parmStartDateTimeUtc

Gets or sets the UTC timestamp when the operation began executing.

• Visibility: public
• Returns: utcdatetime The operation start timestamp in UTC.

Name	Type	Optional	Description
_startDateTimeUtc	utcdatetime	Yes	The operation start timestamp in UTC.

parmEndDateTimeUtc

Gets or sets the UTC timestamp when the operation finished executing.

• Visibility: public
• Returns: utcdatetime The operation end timestamp in UTC.

Name	Type	Optional	Description
_endDateTimeUtc	utcdatetime	Yes	The operation end timestamp in UTC.

parmDurationMs

Gets or sets the total elapsed execution time in milliseconds.

• Visibility: public
• Returns: int64 The elapsed time in milliseconds.

Name	Type	Optional	Description
_durationMs	int64	Yes	The elapsed time in milliseconds.

parmErrors

Gets or sets the collection of error-level diagnostic messages captured from the infolog during execution.

• Visibility: public
• Returns: List The error messages list.

Name	Type	Optional	Description
_errors	List	Yes	The error messages list.

parmWarnings

Gets or sets the collection of warning-level diagnostic messages captured from the infolog during execution.

• Visibility: public
• Returns: List The warning messages list.

Name	Type	Optional	Description
_warnings	List	Yes	The warning messages list.

parmInformationalMessages

Gets or sets the collection of informational diagnostic messages captured from the infolog during execution.

• Visibility: public
• Returns: List The informational messages list.

Name	Type	Optional	Description
_informationalMessages	List	Yes	The informational messages list.

parmRequestId

Gets or sets the caller-supplied request identifier used for idempotency checking.

• Visibility: public
• Returns: Guid The unique request GUID.

Name	Type	Optional	Description
_requestId	Guid	Yes	The unique request GUID.

parmDocumentId

Gets or sets the business document identifier produced or affected by the operation (e.g., SalesId, PurchId, JournalNum).

• Visibility: public
• Returns: str The business document identifier.

Name	Type	Optional	Description
_documentId	str	Yes	The business document identifier.

parmPostedDocumentId

Gets or sets the number of the document the operation produced: the invoice, packing slip, confirmation, journal or created order. Empty when the operation produces no numbered document. A cached replay of the same RequestId returns the value recorded by the original execution.

• Visibility: public
• Returns: str The produced document number.

Name	Type	Optional	Description
_postedDocumentId	str	Yes	The produced document number.

parmPreviewMode

Gets or sets whether the operation ran as a preview: the request was validated and nothing was posted.

• Visibility: public
• Returns: boolean

Name	Type	Optional	Description
_previewMode	boolean	Yes

parmPreviewApplied

Gets or sets whether the preview completed cleanly: validation passed and no idempotency claim or open transaction was left behind.

• Visibility: public
• Returns: boolean

Name	Type	Optional	Description
_previewApplied	boolean	Yes

parmPreviewFidelity

Gets or sets the preview fidelity: None when the operation did not run as a preview, ValidationOnly for a preview.

• Visibility: public
• Returns: MGCLatticePreviewFidelity

Name	Type	Optional	Description
_previewFidelity	MGCLatticePreviewFidelity	Yes