StatusReportV03

tsmt.037.001.03

Scope The StatusReport message is sent by the matching application to the requester of a status report. This message is used to report on the status of transactions registered in the matching application. Usage The StatusReport message can be sent by the matching application to report on the status and sub-status of all transactions that the requester of the report is involved in. The message can be sent in response to a StatusReportRequest message.

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
%% StatusReportV03 recursion level 0 with max 0
StatusReportV03 *-- "1..1" MessageIdentification1 : ReportIdentification
StatusReportV03 *-- "1..1" MessageIdentification1 : RelatedMessageReference
StatusReportV03 *-- "0..1" StatusReportItems2 : ReportedItems
  

Now, we will zero-in one-by-one on each of these building blocks.

ReportIdentification building block

Identifies the report. Identifies a message by a unique identifier and the date and time when the message was created by the sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageIdentification1 recursion level 0 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
  

MessageIdentification1 members

RelatedMessageReference building block

Reference to the previous message requesting the report. Identifies a message by a unique identifier and the date and time when the message was created by the sender. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageIdentification1 recursion level 0 with max 1
class MessageIdentification1{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
  

MessageIdentification1 members

ReportedItems building block

Describes a transaction and its status. Describes a transaction and its status. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% StatusReportItems2 recursion level 0 with max 1
class StatusReportItems2{
    TransactionIdentification IsoMax35Text
    Status BaselineStatus3Code
    SubStatus IsoMax140Text
}
StatusReportItems2 *-- "1..2" BICIdentification1 : ReportedEntity
%% BICIdentification1 recursion level 1 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
  

StatusReportItems2 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    StatusReportV03 --|> IOuterRecord : Implements
    StatusReportV03Document --|> IOuterDocument~StatusReportV03~ : Implements
    class IOuterDocument~StatusReportV03~ {
        StatusReportV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    StatusReportV03Document *-- StatusReportV03 : 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:tsmt.037.001.03">
    <StsRpt>
        <RptId>
            <!-- ReportIdentification inner content -->
        </RptId>
        <RltdMsgRef>
            <!-- RelatedMessageReference inner content -->
        </RltdMsgRef>
        <RptdItms>
            <!-- ReportedItems inner content -->
        </RptdItms>
    </StsRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_1C-AWNE8Ed-BzquC8wXy7w_-145028832"
  name="StatusReportV03"
  definition="Scope&#xD;&#xA;The StatusReport message is sent by the matching application to the requester of a status report.&#xD;&#xA;This message is used to report on the status of transactions registered in the matching application.&#xD;&#xA;Usage&#xD;&#xA;The StatusReport message can be sent by the matching application to report on the status and sub-status of all transactions that the requester of the report is involved in. The message can be sent in response to a StatusReportRequest message."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
  xmlTag="StsRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_1C-AWdE8Ed-BzquC8wXy7w_-145028770"
    name="ReportIdentification"
    definition="Identifies the report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_1C-AWtE8Ed-BzquC8wXy7w_-145028740"
    name="RelatedMessageReference"
    definition="Reference to the previous message requesting the report."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RltdMsgRef"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_1C-AW9E8Ed-BzquC8wXy7w_-145028829"
    name="ReportedItems"
    definition="Describes a transaction and its status."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="RptdItms"
    complexType="_Ra7q9tp-Ed-ak6NoX_4Aeg_-898612372" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="037"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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