reda.042.001.01
The PartyAuditTrailQuery message is sent by an instructing party to the executing party to query for the party audit trail recorded in the system.
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
%% PartyAuditTrailQueryV01 recursion level 0 with max 0
PartyAuditTrailQueryV01 *-- "0..1" MessageHeader1 : MessageHeader
PartyAuditTrailQueryV01 *-- "1..1" PartyAuditTrailSearchCriteria2 : SearchCriteria
PartyAuditTrailQueryV01 *-- "0..1" SupplementaryData1 : SupplementaryData
Now, we will zero-in one-by-one on each of these building blocks.
MessageHeader building block
Common business identification for the message. Set of characteristics, such as the identification or the creation date and time, specific to the message. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MessageHeader1 recursion level 0 with max 1
class MessageHeader1{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
MessageHeader1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| MessageIdentification | Point to point reference, as assigned by the sender, to unambiguously identify the message. Usage: The sender has to make sure that MessageIdentification is unique for a pre-agreed period. | IsoMax35Text - Required 1..1 |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Optional 0..1 |
SearchCriteria building block
Defines the criteria to be used to query the party audit trail by the executing system. Describes search criteria for party audit trail query. For comparison, see the ISO20022 official specification
classDiagram direction tb %% PartyAuditTrailSearchCriteria2 recursion level 0 with max 1 PartyAuditTrailSearchCriteria2 *-- "0..1" SystemPartyIdentification8 : PartyIdentification PartyAuditTrailSearchCriteria2 *-- "0..1" IDatePeriodSearch1Choice : DatePeriod %% SystemPartyIdentification8 recursion level 1 with max 1 SystemPartyIdentification8 *-- "1..1" PartyIdentification136 : Identification SystemPartyIdentification8 *-- "0..1" PartyIdentification136 : ResponsiblePartyIdentification %% IDatePeriodSearch1Choice recursion level 1 with max 1
PartyAuditTrailSearchCriteria2 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| PartyIdentification | Describes party to be queried. | SystemPartyIdentification8 - Optional 0..1 |
| DatePeriod | Describes date period for querying information. | IDatePeriodSearch1Choice - Optional 0..1 |
SupplementaryData building block
Additional information that cannot be captured in the structured elements and/or any other specific block. Additional information that can not be captured in the structured fields and/or any other specific block. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% SupplementaryData1 recursion level 0 with max 1
class SupplementaryData1{
PlaceAndName IsoMax350Text
}
SupplementaryData1 *-- "1..1" IsoSupplementaryDataEnvelope1 : Envelope
%% IsoSupplementaryDataEnvelope1 recursion level 1 with max 1
SupplementaryData1 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| PlaceAndName | Unambiguous reference to the location where the supplementary data must be inserted in the message instance. In the case of XML, this is expressed by a valid XPath. | IsoMax350Text - Optional 0..1 |
| Envelope | Technical element wrapping the supplementary data. | IsoSupplementaryDataEnvelope1 - Required 1..1 |
Extensibility and generalization considerations
To facilitate generalized design patterns in the system, the PartyAuditTrailQueryV01 implementation follows a specific implementaiton pattern. First of all, PartyAuditTrailQueryV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, PartyAuditTrailQueryV01Document implements IOuterDocument. Because PartyAuditTrailQueryV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type PartyAuditTrailQueryV01.
classDiagram
class IOuterRecord
PartyAuditTrailQueryV01 --|> IOuterRecord : Implements
PartyAuditTrailQueryV01Document --|> IOuterDocument~PartyAuditTrailQueryV01~ : Implements
class IOuterDocument~PartyAuditTrailQueryV01~ {
PartyAuditTrailQueryV01 Message
}
Document wrapper for serialization
The only real purpose PartyAuditTrailQueryV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:reda.042.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using PartyAuditTrailQueryV01.ToDocument() method. The returned PartyAuditTrailQueryV01Document value will serialize correctly according to ISO 20022 standards.
classDiagram
PartyAuditTrailQueryV01Document *-- PartyAuditTrailQueryV01 : 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:reda.042.001.01">
<PtyAudtTrlQry>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<SchCrit>
<!-- SearchCriteria inner content -->
</SchCrit>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</PtyAudtTrlQry>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_-fQN8ZeSEeen_cyMrluY4w"
name="PartyAuditTrailQueryV01"
definition="The PartyAuditTrailQuery message is sent by an instructing party to the executing party to query for the party audit trail recorded in the system."
registrationStatus="Registered"
messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
xmlTag="PtyAudtTrlQry"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_LFFxEVhGEeih3fUfzR38Ig"
name="MessageHeader"
definition="Common business identification for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="MsgHdr"
complexType="_75DzkaMgEeCJ6YNENx4h-w_-613853819" />
<messageBuildingBlock
xmi:id="_-fQN-ZeSEeen_cyMrluY4w"
name="SearchCriteria"
definition="Defines the criteria to be used to query the party audit trail by the executing system."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="SchCrit"
complexType="_W5x_8Z7iEeezh9vfeoBoQw" />
<messageBuildingBlock
xmi:id="_-fQN-5eSEeen_cyMrluY4w"
name="SupplementaryData"
definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
registrationStatus="Provisionally Registered"
minOccurs="0"
xmlTag="SplmtryData"
complexType="_Qn0zC9p-Ed-ak6NoX_4Aeg_468227563" />
<messageDefinitionIdentifier
businessArea="reda"
messageFunctionality="042"
flavour="001"
version="01" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.