admi.002.001.01
Scope The MessageReject message is sent by a central system to notify the rejection of a previously received message. Usage The message provides specific information about the rejection reason.
Message Construction
Every ISO20022 message has at the highest level what we call ‘building blocks’. Because the message is constructed as immutable records, the association is by composition. Below you can see the relationship between the message and its constituent building blocks: For comparison, see the ISO20022 official specification
classDiagram
direction LR
%% MessageRejectV01 recursion level 0 with max 0
MessageRejectV01 *-- "1..1" MessageReference : RelatedReference
MessageRejectV01 *-- "1..1" RejectionReason2 : Reason
Now, we will zero-in one-by-one on each of these building blocks.
RelatedReference building block
Refers to the identification of the message previously received and for which the rejection is notified. Message reference of relevance to the present message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MessageReference recursion level 0 with max 1
class MessageReference{
Reference IsoMax35Text
}
MessageReference members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| Reference | Business reference of the present message assigned by the party issuing the message. This reference must be unique amongst all messages of the same name sent by the same party. | IsoMax35Text - Required 1..1 |
Reason building block
General information about the reason of the message rejection. General information about the reason of the rejection. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% RejectionReason2 recursion level 0 with max 1
class RejectionReason2{
RejectingPartyReason IsoMax35Text
RejectionDateTime IsoISODateTime
ErrorLocation IsoMax350Text
ReasonDescription IsoMax350Text
AdditionalData IsoMax20000Text
}
RejectionReason2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| RejectingPartyReason | Reason of the rejection provided by the rejecting party. | IsoMax35Text - Required 1..1 |
| RejectionDateTime | Date and time at which the rejection was generated. | IsoISODateTime - Optional 0..1 |
| ErrorLocation | Description of the precise location of the potential error in a message. | IsoMax350Text - Optional 0..1 |
| ReasonDescription | Detailed description of the rejection reason. | IsoMax350Text - Optional 0..1 |
| AdditionalData | Additional information related to the rejection and meant to allow for the precise identification of the rejection reason. This could include a copy of the rejected message in part or in full. | IsoMax20000Text - Optional 0..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the MessageRejectV01 implementation follows a specific implementaiton pattern. First of all, MessageRejectV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, MessageRejectV01Document implements IOuterDocument. Because MessageRejectV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type MessageRejectV01.
classDiagram
class IOuterRecord
MessageRejectV01 --|> IOuterRecord : Implements
MessageRejectV01Document --|> IOuterDocument~MessageRejectV01~ : Implements
class IOuterDocument~MessageRejectV01~ {
MessageRejectV01 Message
}
Document wrapper for serialization
The only real purpose MessageRejectV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:admi.002.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using MessageRejectV01.ToDocument() method. The returned MessageRejectV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
MessageRejectV01Document *-- MessageRejectV01 : Document
Sample of message format
This is an abbreviated version of what the message should look like.
<Document xmlns="urn:iso:std:iso:20022:tech:xsd:admi.002.001.01">
<admi.002.001.01>
<RltdRef>
<!-- RelatedReference inner content -->
</RltdRef>
<Rsn>
<!-- Reason inner content -->
</Rsn>
</admi.002.001.01>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_8LH5WNE9Ed-BzquC8wXy7w_-1942533103"
name="MessageRejectV01"
definition="Scope
The MessageReject message is sent by a central system to notify the rejection of a previously received message.
Usage
The message provides specific information about the rejection reason."
registrationStatus="Registered"
messageSet="_wiatARJsEeSstbhSoCHcWw"
xmlTag="admi.002.001.01"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_8LH5WdE9Ed-BzquC8wXy7w_-1383804009"
name="RelatedReference"
definition="Refers to the identification of the message previously received and for which the rejection is notified."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RltdRef"
complexType="_RB5f4tp-Ed-ak6NoX_4Aeg_1955131952" />
<messageBuildingBlock
xmi:id="_8LH5WtE9Ed-BzquC8wXy7w_-223860119"
name="Reason"
definition="General information about the reason of the message rejection."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="Rsn"
complexType="_UsSuA9p-Ed-ak6NoX_4Aeg_-521235445" />
<messageDefinitionIdentifier
businessArea="admi"
messageFunctionality="002"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.