PartyModificationRequestV01

reda.022.001.01

Scope: The PartyModificationRequest message is sent by the instructing party to the executing party to request for an update of the party reference data of a party defined in the executing system.

Usage: It aims at instructing the update of an existing party by amending its existing details or by providing additional details. Processing and confirmation of the party modification request message are provided via a party status advice.

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
%% PartyModificationRequestV01 recursion level 0 with max 0
PartyModificationRequestV01 *-- "0..1" MessageHeader1 : MessageHeader
PartyModificationRequestV01 *-- "1..1" SystemPartyIdentification8 : SystemPartyIdentification
PartyModificationRequestV01 *-- "1..1" SystemPartyModification2 : Modification
PartyModificationRequestV01 *-- "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

SystemPartyIdentification building block

Unique identification, as assigned by the executing system, to unambiguously identify the party to be modified. Unique and unambiguous identification of a party within a system. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SystemPartyIdentification8 recursion level 0 with max 1
SystemPartyIdentification8 *-- "1..1" PartyIdentification136 : Identification
SystemPartyIdentification8 *-- "0..1" PartyIdentification136 : ResponsiblePartyIdentification
%% PartyIdentification136 recursion level 1 with max 1
class PartyIdentification136{
    LEI IsoLEIIdentifier
}
PartyIdentification136 *-- "1..1" IPartyIdentification120Choice : Identification
%% PartyIdentification136 recursion level 1 with max 1
class PartyIdentification136{
    LEI IsoLEIIdentifier
}
PartyIdentification136 *-- "1..1" IPartyIdentification120Choice : Identification
  

SystemPartyIdentification8 members

Member name Description Data Type / Multiplicity
Identification Unique identification to unambiguously identify the party within the system. PartyIdentification136 - Required 1..1
ResponsiblePartyIdentification Unique identification of the party responsible for the maintenance of the party reference data. PartyIdentification136 - Optional 0..1

Modification building block

Identifies the list of requested modifications to be executed by the system. Information about the kind of modification request for party reference data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% SystemPartyModification2 recursion level 0 with max 1
class SystemPartyModification2{
    ScopeIndication DataModification1Code
}
SystemPartyModification2 *-- "1..1" ISystemPartyModification2Choice : RequestedModification
%% ISystemPartyModification2Choice recursion level 1 with max 1
  

SystemPartyModification2 members

Member name Description Data Type / Multiplicity
ScopeIndication Specifies the type of requested modification. DataModification1Code - Required 1..1
RequestedModification Specifies the set of elements to be modified for the party reference data. ISystemPartyModification2Choice - Required 1..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 PartyModificationRequestV01 implementation follows a specific implementaiton pattern. First of all, PartyModificationRequestV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, PartyModificationRequestV01Document implements IOuterDocument. Because PartyModificationRequestV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type PartyModificationRequestV01.

classDiagram
    class IOuterRecord
    PartyModificationRequestV01 --|> IOuterRecord : Implements
    PartyModificationRequestV01Document --|> IOuterDocument~PartyModificationRequestV01~ : Implements
    class IOuterDocument~PartyModificationRequestV01~ {
        PartyModificationRequestV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    PartyModificationRequestV01Document *-- PartyModificationRequestV01 : 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.022.001.01">
    <PtyModReq>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <SysPtyId>
            <!-- SystemPartyIdentification inner content -->
        </SysPtyId>
        <Mod>
            <!-- Modification inner content -->
        </Mod>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </PtyModReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_xJQSoZeREeen_cyMrluY4w"
  name="PartyModificationRequestV01"
  definition="Scope:&#xA;The PartyModificationRequest message is sent by the instructing party to the executing party to request for an update of the party reference data of a party defined in the executing system.&#xA;&#xA;Usage:&#xA;It aims at instructing the update of an existing party by amending its existing details or by providing additional details.&#xA;Processing and confirmation of the party modification request message are provided via a party status advice."
  registrationStatus="Registered"
  messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
  xmlTag="PtyModReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_AvsDgVhGEeih3fUfzR38Ig"
    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="_xJQSqZeREeen_cyMrluY4w"
    name="SystemPartyIdentification"
    definition="Unique identification, as assigned by the executing system, to unambiguously identify the party to be modified."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SysPtyId"
    complexType="_7KrUEVhLEeih3fUfzR38Ig" />
  <messageBuildingBlock
    xmi:id="_xJQSq5eREeen_cyMrluY4w"
    name="Modification"
    definition="Identifies the list of requested modifications to be executed by the system."
    registrationStatus="Provisionally Registered"
    minOccurs="1"
    xmlTag="Mod"
    complexType="_xtxKwYv-Eei289CGNqs21g" />
  <messageBuildingBlock
    xmi:id="_xJQSrZeREeen_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="022"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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