MGCLatticeStatusQueryResponseContract

Data contract for status query responses: document status, type, named status details and, for a failed query, the machine-readable ErrorCode and the Errors that explain it.

Methods

new

Initializes a new instance of the MGCLatticeStatusQueryResponseContract class.

• Visibility: public
• Returns: void

No parameters.

construct

Creates a new instance of the MGCLatticeStatusQueryResponseContract class.

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

No parameters.

parmSuccess

Gets or sets whether the status query 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.

parmMessage

Gets or sets the human-readable message describing the status query result.

• Visibility: public
• Returns: str The Message value.

Name	Type	Optional	Description
_message	str	Yes	The Message value.

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.

parmDocumentId

Gets or sets the document identifier that was queried.

• Visibility: public
• Returns: str The DocumentId value.

Name	Type	Optional	Description
_documentId	str	Yes	The DocumentId value.

parmDocumentStatus

Gets or sets the current document status value.

• Visibility: public
• Returns: str The DocumentStatus value.

Name	Type	Optional	Description
_documentStatus	str	Yes	The DocumentStatus value.

parmDocumentType

Gets or sets the document type identifier.

• Visibility: public
• Returns: str The DocumentType value.

Name	Type	Optional	Description
_documentType	str	Yes	The DocumentType value.

parmLastModifiedDateTime

Gets or sets the last modified date and time of the document, in UTC (LastModifiedDateTimeUtc on the wire).

• Visibility: public
• Returns: utcdatetime The LastModifiedDateTime value.

Name	Type	Optional	Description
_lastModifiedDateTime	utcdatetime	Yes	The LastModifiedDateTime value.

parmStatusDetails

Gets or sets the status details as Name=value strings. This is the list the status queries fill; on the wire it is published as StatusDetails, a list of { Name, Value } objects (parmStatusDetailList).

• Visibility: public
• Returns: List The status detail strings list.

Name	Type	Optional	Description
_statusDetails	List	Yes	The status detail strings list.

parmStatusDetailList

Gets or sets the status details as named values (StatusDetails on the wire): each Name=value entry of parmStatusDetails becomes one MGCLatticeNameValueContract, split at the first =.

• Visibility: public
• Returns: List The status details as named values.

Name	Type	Optional	Description
_details	List	Yes	The named values to set; omitted to read.

parmErrorCode

Gets or sets the machine-readable reason of a failed query (for example ValidationFailed or DocumentNotFound); None on success.

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

Name	Type	Optional	Description
_errorCode	MGCLatticeServiceErrorCode	Yes	The error code.

parmErrors

Gets or sets the error messages of a failed query.

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

Name	Type	Optional	Description
_errors	List	Yes	The error messages.