SecuritiesAccountAuditTrailQueryV01

reda.036.001.01

The SecuritiesAccountAuditTrailQuery message is sent by an instructing party to the executing party to query for the securities account 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
%% SecuritiesAccountAuditTrailQueryV01 recursion level 0 with max 0
SecuritiesAccountAuditTrailQueryV01 *-- "0..1" MessageHeader1 : MessageHeader
SecuritiesAccountAuditTrailQueryV01 *-- "1..1" SecuritiesAccountAuditTrailSearchCriteria3 : SearchCriteria
SecuritiesAccountAuditTrailQueryV01 *-- "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

SearchCriteria building block

Defines the criteria to be used to query the securities account audit trail by the executing system. Describes search criteria for securities account audit trail query. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SecuritiesAccountAuditTrailSearchCriteria3 recursion level 0 with max 1
SecuritiesAccountAuditTrailSearchCriteria3 *-- "0..1" SecuritiesAccount19 : SecuritiesAccountIdentification
SecuritiesAccountAuditTrailSearchCriteria3 *-- "0..1" IDatePeriodSearch1Choice : DatePeriod
%% SecuritiesAccount19 recursion level 1 with max 1
class SecuritiesAccount19{
    Identification IsoMax35Text
    Name IsoMax70Text
}
SecuritiesAccount19 *-- "0..1" GenericIdentification30 : Type
%% IDatePeriodSearch1Choice recursion level 1 with max 1
  

SecuritiesAccountAuditTrailSearchCriteria3 members

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

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the SecuritiesAccountAuditTrailQueryV01 implementation follows a specific implementaiton pattern. First of all, SecuritiesAccountAuditTrailQueryV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, SecuritiesAccountAuditTrailQueryV01Document implements IOuterDocument. Because SecuritiesAccountAuditTrailQueryV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type SecuritiesAccountAuditTrailQueryV01.

classDiagram
    class IOuterRecord
    SecuritiesAccountAuditTrailQueryV01 --|> IOuterRecord : Implements
    SecuritiesAccountAuditTrailQueryV01Document --|> IOuterDocument~SecuritiesAccountAuditTrailQueryV01~ : Implements
    class IOuterDocument~SecuritiesAccountAuditTrailQueryV01~ {
        SecuritiesAccountAuditTrailQueryV01 Message
     }
  

Document wrapper for serialization

The only real purpose SecuritiesAccountAuditTrailQueryV01Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:reda.036.001.01’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using SecuritiesAccountAuditTrailQueryV01.ToDocument() method. The returned SecuritiesAccountAuditTrailQueryV01Document value will serialize correctly according to ISO 20022 standards.

classDiagram
    SecuritiesAccountAuditTrailQueryV01Document *-- SecuritiesAccountAuditTrailQueryV01 : 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.036.001.01">
    <SctiesAcctAudtTrlQry>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <SchCrit>
            <!-- SearchCriteria inner content -->
        </SchCrit>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </SctiesAcctAudtTrlQry>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_KAlNp52fEem_Be8NuxvF7Q"
  name="SecuritiesAccountAuditTrailQueryV01"
  definition="The SecuritiesAccountAuditTrailQuery message is sent by an instructing party to the executing party to query for the securities account audit trail recorded in the system."
  registrationStatus="Registered"
  messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
  xmlTag="SctiesAcctAudtTrlQry"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_gxeX8J5OEemQg7pJhFUUYg"
    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="_KAlNtZ2fEem_Be8NuxvF7Q"
    name="SearchCriteria"
    definition="Defines the criteria to be used to query the securities account audit trail by the executing system."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SchCrit"
    complexType="_0Ba1cTpzEemk2e6qGBk8IQ" />
  <messageBuildingBlock
    xmi:id="_KAlNt52fEem_Be8NuxvF7Q"
    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="036"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

The following items are used as building blocks to construct this message.