Skip to main content

MGCLatticeBulkItemResultContract

Per-item result contract within a bulk operation response, carrying the item index, individual success/failure status, the affected document identifier, and any error messages for that specific item.

Methods​

new​

Initializes a new instance of the MGCLatticeBulkItemResultContract class.

  • Visibility: public
  • Returns: void

No parameters.

construct​

Creates a new instance of the MGCLatticeBulkItemResultContract class.

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

No parameters.

parmItemIndex​

Gets or sets the one-based index of this item within the original bulk request array.

  • Visibility: public
  • Returns: int The one-based item position.
NameTypeOptionalDescription
_itemIndexintYesThe one-based item position.

parmRequestId​

Gets or sets the caller-supplied request identifier for this individual item, used for idempotency.

  • Visibility: public
  • Returns: Guid The unique request GUID for this item.
NameTypeOptionalDescription
_requestIdGuidYesThe unique request GUID for this item.

parmSuccess​

Gets or sets whether this individual item was processed successfully.

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

parmStatus​

Gets or sets the lifecycle status of this individual item (Succeeded or Failed).

  • Visibility: public
  • Returns: MGCLatticeServiceCallStatus The item lifecycle status value.
NameTypeOptionalDescription
_statusMGCLatticeServiceCallStatusYesThe item lifecycle status value.

parmErrorCode​

Gets or sets the machine-readable error code categorizing the failure cause for this individual item.

  • Visibility: public
  • Returns: MGCLatticeServiceErrorCode The item error code value.
NameTypeOptionalDescription
_errorCodeMGCLatticeServiceErrorCodeYesThe item error code value.

parmIsRetryable​

Gets or sets whether the failed operation for this individual item can be safely retried by the caller.

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

parmMessage​

Gets or sets the human-readable result message for this individual item.

  • Visibility: public
  • Returns: str The item result message text.
NameTypeOptionalDescription
_messagestrYesThe item result message text.

parmDocumentId​

Gets or sets the business document identifier produced or affected by this individual item operation.

  • Visibility: public
  • Returns: str The business document identifier for this item.
NameTypeOptionalDescription
_documentIdstrYesThe business document identifier for this item.

parmPostedDocumentId​

Gets or sets the number of the document this item produced (invoice, packing slip, confirmation, journal or created order); empty when the item produced no numbered document.

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

parmErrors​

Gets or sets the collection of error messages specific to this individual item.

  • Visibility: public
  • Returns: List The item-level error messages list.
NameTypeOptionalDescription
_errorsListYesThe item-level error messages list.