Iso20022

RequestForOrderStatusReportV04

setr.018.001.04

Scope The RequestForOrderStatusReport message is sent by an instructing party, for example, an investment manager or its authorised representative, to the executing party, for example, a transfer agent, to request the status of one or more order instructions or order cancellation requests. Usage The RequestForOrderStatusReport message is used to request the status of:

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
%% RequestForOrderStatusReportV04 recursion level 0 with max 0
RequestForOrderStatusReportV04 *-- "1..1" MessageIdentification1 : MessageIdentification
RequestForOrderStatusReportV04 *-- "1..1" MessageAndBusinessReference10 : RequestDetails
RequestForOrderStatusReportV04 *-- "0..1" Extension1 : Extension

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

MessageIdentification building block

Reference that uniquely identifies the message from a business application standpoint. 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

Member name Description Data Type / Multiplicity
Identification Identification of the message. IsoMax35Text - Required 1..1
CreationDateTime Date of creation of the message. IsoISODateTime - Required 1..1

RequestDetails building block

Information to identify the order(s) for which the status is requested. Information to identify funds order(s). For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageAndBusinessReference10 recursion level 0 with max 1
MessageAndBusinessReference10 *-- "0..1" IReferences62Choice : Reference
MessageAndBusinessReference10 *-- "0..1" AdditionalReference8 : RelatedReference
MessageAndBusinessReference10 *-- "0..0" InvestmentFundOrder8 : OrderReference
%% IReferences62Choice recursion level 1 with max 1
%% AdditionalReference8 recursion level 1 with max 1
class AdditionalReference8{
    Reference IsoMax35Text
    MessageName IsoMax35Text
}
AdditionalReference8 *-- "0..1" PartyIdentification113 : ReferenceIssuer
%% InvestmentFundOrder8 recursion level 1 with max 1
class InvestmentFundOrder8{
    MasterReference IsoMax35Text
    OrderReference IsoMax35Text
    ClientReference IsoMax35Text
    CancellationReference IsoMax35Text
    DealReference IsoMax35Text
}
InvestmentFundOrder8 *-- "0..1" InvestmentAccount58 : InvestmentAccountDetails
InvestmentFundOrder8 *-- "0..1" FinancialInstrument57 : FinancialInstrumentDetails

MessageAndBusinessReference10 members

Member name Description Data Type / Multiplicity
Reference Reference to a linked message that was previously sent. IReferences62Choice - Optional 0..1
RelatedReference Reference to a linked message that was previously received. AdditionalReference8 - Optional 0..1
OrderReference Unique and unambiguous identifiers of one or more individual order instructions or individual order cancellation requests. InvestmentFundOrder8 - Unknown 0..0

Extension 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
%% Extension1 recursion level 0 with max 1
class Extension1{
    PlaceAndName IsoMax350Text
    Text IsoMax350Text
}

Extension1 members

Member name Description Data Type / Multiplicity
PlaceAndName Name qualifying the information provided in the Text field, and place where this information should be inserted. IsoMax350Text - Required 1..1
Text Text of the extension. IsoMax350Text - Required 1..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    RequestForOrderStatusReportV04 --|> IOuterRecord : Implements
    RequestForOrderStatusReportV04Document --|> IOuterDocument~RequestForOrderStatusReportV04~ : Implements
    class IOuterDocument~RequestForOrderStatusReportV04~ {
        RequestForOrderStatusReportV04 Message
     }

Document wrapper for serialization

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

classDiagram
    RequestForOrderStatusReportV04Document *-- RequestForOrderStatusReportV04 : 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:setr.018.001.04">
    <ReqForOrdrStsRpt>
        <MsgId>
            <!-- MessageIdentification inner content -->
        </MsgId>
        <ReqDtls>
            <!-- RequestDetails inner content -->
        </ReqDtls>
        <Xtnsn>
            <!-- Extension inner content -->
        </Xtnsn>
    </ReqForOrdrStsRpt>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_Aab7UzbLEead9bDRE_1DAQ"
  previousVersion="_wy_OWNE7Ed-BzquC8wXy7w_1331513670"
  name="RequestForOrderStatusReportV04"
  definition="Scope&#xD;&#xA;The RequestForOrderStatusReport message is sent by an instructing party, for example, an investment manager or its authorised representative, to the executing party, for example, a transfer agent, to request the status of one or more order instructions or order cancellation requests.&#xD;&#xA;Usage&#xD;&#xA;The RequestForOrderStatusReport message is used to request the status of:&#xD;&#xA;- one or several individual order instructions, or,&#xD;&#xA;- one or several order messages, or&#xD;&#xA;- one or several individual order cancellation requests, or,&#xD;&#xA;- one or several order cancellation request messages.&#xD;&#xA;The response to a RequestForOrderStatusReport message is the OrderInstructionStatusReport message or OrderCancellationStatusReport message.&#xD;&#xA;If the RequestForOrderStatusReport message is used to request the status of several individual order instructions or one or more order instruction messages, then the instructing party may receive several OrderInstructionStatusReport messages from the executing party.&#xD;&#xA;If the RequestForOrderStatusReport message is used to request the status of several individual order cancellation requests or one or more order cancellation messages, then the instructing party may receive several OrderCancellationStatusReport messages from the executing party.&#xD;&#xA;When the RequestForOrderStatusReport is used to request the status of one or more individual orders or order cancellations, each individual order is identified with its order reference. The investment account and/or financial instrument related to the order can also be identified. The message identification of the message in which the individual order was conveyed may also be quoted in PreviousReference.&#xD;&#xA;When the RequestForOrderStatusReport is used to request the status of an order message or an order cancellations request message, then the message identification of the order or cancellation message is identified in PreviousReference.&#xD;&#xA;The RequestForOrderStatusReport message may not be used to request the status of an investment account, a transfer or the status of a financial instrument."
  registrationStatus="Registered"
  messageSet="_hijK0WiLEeOuqdLlpUIWBw _qCumkAFwEeu2__1EbNXzuA"
  xmlTag="ReqForOrdrStsRpt"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <constraint
    xmi:id="_5PizQqJ7EeasRMONNp89pg"
    name="OtherReferenceGuideline"
    definition="RequestDetails/Reference/OtherReference should be used to reference an order instruction or cancellation 'message' sent in a proprietary way or used for a system reference. If RequestDetails/Reference/OtherReference is present, RequestDetails/Reference/OtherReference/MessageName must contain 'fax' or 'phone' or 'email', etc."
    registrationStatus="Provisionally Registered" />
  <constraint
    xmi:id="_5PizQ6J7EeasRMONNp89pg"
    name="PreviousReferenceGuideline"
    definition="If RequestDetails/Reference/PreviousReference/MessageName is present, it must contain 502 or must start with setr.001, setr.002, setr.004, setr.005, setr.007, setr.008, setr.010, setr.011, setr.013 or setr.014 and RequestDetails/Reference/PreviousReference/Reference must contain the reference of a message in this list."
    registrationStatus="Provisionally Registered" />
  <messageBuildingBlock
    xmi:id="_Aab7VTbLEead9bDRE_1DAQ"
    previousVersion="_wy_OWdE7Ed-BzquC8wXy7w_390506052"
    name="MessageIdentification"
    definition="Reference that uniquely identifies the message from a business application standpoint."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgId"
    complexType="_Q7pG5Np-Ed-ak6NoX_4Aeg_-967008570" />
  <messageBuildingBlock
    xmi:id="_Aab7VzbLEead9bDRE_1DAQ"
    previousVersion="_wy_OWtE7Ed-BzquC8wXy7w_1331513937"
    name="RequestDetails"
    definition="Information to identify the order(s) for which the status is requested."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="ReqDtls"
    complexType="_IGLlRzbtEead9bDRE_1DAQ" />
  <messageBuildingBlock
    xmi:id="_Aab7WTbLEead9bDRE_1DAQ"
    previousVersion="_wy_OW9E7Ed-BzquC8wXy7w_-800406650"
    name="Extension"
    definition="Additional information that cannot be captured in the structured elements and/or any other specific block."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="Xtnsn"
    complexType="_Q6vvCNp-Ed-ak6NoX_4Aeg_1503007069" />
  <messageDefinitionIdentifier
    businessArea="setr"
    messageFunctionality="018"
    flavour="001"
    version="04" />
</messageDefinition>

ISO Building Blocks

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