ExtendedStatus

Description
The Extended Status aggregate allows a processor to return error messages or informational text about an entity or element.

Type : Aggregate
DataType : ExtendedStatus_Type

Elements
ExtendedStatusCdExtendedStatus must be included if the MsgStatusCd is SuccessWithInfo. ExtendedStatus must NOT be included if the MsgStatusCd is ResponsePending, ResultPendingOutOfBand, Success, or SuccessWithChanges. See the ExtendedStatusText code list processing semantics table for additional information on when to send and how to process these codes. This element uses the ExtendedStatusText code list.
ExtendedStatusDescContains descriptive information about the cause of this extended status. This can be used to elaborate why a specific element or elements of data is causing the MsgStatusCd in this Message. In cases where specific data is not referenced this description field can be used to describe the data element that is the source of the problem. Describe multiple unrelated data elements by repeating the entire ExtendedStatus aggregate. If the cause of the extended status is relational in nature then a single ExtendedStatus should describe all of the related data elements and or the relational cause.
MissingElementPathIncluding this element is highly recommended for an ExtendedStatusCd of DataMissing or VerifyDataAbsence. The expected path of the missing element should be placed here. The path is limited to a location path that should uniquely identify a single piece of data. The path is applied such that the root node of the message is the document node for the path. This path is similar to the path used in the SPX service for identifying fields in field edits.

Attributes
idThis attribute is an identifier to a specific element.
IdRefsThis attribute is an identifier reference to a specific element within the stream. It is recommended that whenever possible this element is used to reference the specific data that is the source of this extended status. Reference multiple unrelated data elements by repeating the entire ExtendedStatus aggregate. If the cause of the extended status is relational in nature then a single ExtendedStatus should reference all of the related data elements. A description of the underlying relational cause can be put in ExtendedStatusDesc