StatusReportRequestV03

tsmt.038.001.03

Scope The StatusReportRequest message is sent by a party involved in a transaction to the matching application. This message is used to request a report on the status of transactions registered in the matching application. Usage The StatusReportRequest message can be sent by either party involved in a transaction to request a report on the status and sub-statuses of all transactions that the requester is involved in. The application will respond to the request by sending a StatusReport 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
%% StatusReportRequestV03 recursion level 0 with max 0
StatusReportRequestV03 *-- "1..1" MessageIdentification1 : RequestIdentification
StatusReportRequestV03 *-- "0..1" BICIdentification1 : EntitiesToBeReported
  

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

RequestIdentification building block

Identifies the request message. 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

EntitiesToBeReported building block

Specifies the entities of the submitter for which the transactions have to be reported. Unique and unambiguous identifier of a financial institution, as assigned under an internationally recognised or proprietary identification scheme. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% BICIdentification1 recursion level 0 with max 1
class BICIdentification1{
    BIC IsoBICIdentifier
}
  

BICIdentification1 members

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    StatusReportRequestV03 --|> IOuterRecord : Implements
    StatusReportRequestV03Document --|> IOuterDocument~StatusReportRequestV03~ : Implements
    class IOuterDocument~StatusReportRequestV03~ {
        StatusReportRequestV03 Message
     }
  

Document wrapper for serialization

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

classDiagram
    StatusReportRequestV03Document *-- StatusReportRequestV03 : 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.038.001.03">
    <StsRptReq>
        <ReqId>
            <!-- RequestIdentification inner content -->
        </ReqId>
        <NttiesToBeRptd>
            <!-- EntitiesToBeReported inner content -->
        </NttiesToBeRptd>
    </StsRptReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_0n_7mNE8Ed-BzquC8wXy7w_-619721878"
  name="StatusReportRequestV03"
  definition="Scope&#xD;&#xA;The StatusReportRequest message is sent by a party involved in a transaction to the matching application.&#xD;&#xA;This message is used to request a report on the status of transactions registered in the matching application.&#xD;&#xA;Usage&#xD;&#xA;The StatusReportRequest message can be sent by either party involved in a transaction to request a report on the status and sub-statuses of all transactions that the requester is involved in.&#xD;&#xA;The application will respond to the request by sending a StatusReport message."
  registrationStatus="Registered"
  messageSet="_wRx2yk2rEeG_I4xRYCA_7g _1a374FXOEeOkkLyrDUP66g"
  xmlTag="StsRptReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_0n_7mdE8Ed-BzquC8wXy7w_-619721785"
    name="RequestIdentification"
    definition="Identifies the request message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="ReqId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_0n_7mtE8Ed-BzquC8wXy7w_-619721446"
    name="EntitiesToBeReported"
    definition="Specifies the entities of the submitter for which the transactions have to be reported."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="NttiesToBeRptd"
    complexType="_QEp0kNp-Ed-ak6NoX_4Aeg_792527554" />
  <messageDefinitionIdentifier
    businessArea="tsmt"
    messageFunctionality="038"
    flavour="001"
    version="03" />
</messageDefinition>

ISO Building Blocks

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