PartyStatusAdviceV01

reda.016.001.01

Scope: The PartyStatusAdvice message is sent by the executing party to the instructing party to provide details about the processing of a request on party reference data (create or update).

Usage: When processing information is negative - a failure occurred in applying the changes the message accordingly also delivers information about the reason why the creation or update could not be processed. When processing is successfully performed, the message includes the related party identification.

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
%% PartyStatusAdviceV01 recursion level 0 with max 0
PartyStatusAdviceV01 *-- "0..1" MessageHeader12 : MessageHeader
PartyStatusAdviceV01 *-- "1..1" PartyStatus2 : PartyStatus
PartyStatusAdviceV01 *-- "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. Specifies the header data such as the identification and the creation date and time, specific to the message. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% MessageHeader12 recursion level 0 with max 1
class MessageHeader12{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
MessageHeader12 *-- "0..1" OriginalBusinessInstruction1 : OriginalBusinessInstruction
%% OriginalBusinessInstruction1 recursion level 1 with max 1
class OriginalBusinessInstruction1{
    MessageIdentification IsoMax35Text
    MessageNameIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
  

MessageHeader12 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.
CreationDateTime Date and time at which the message was created. IsoISODateTime - Optional 0..1
OriginalBusinessInstruction Unique identification of the original instruction. OriginalBusinessInstruction1 - Optional 0..1

PartyStatus building block

Status of the party involved in the originating message. Business status of the party for processing in the system. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PartyStatus2 recursion level 0 with max 1
class PartyStatus2{
    Status Status6Code
}
PartyStatus2 *-- "0..0" StatusReasonInformation10 : StatusReason
PartyStatus2 *-- "0..1" SystemPartyIdentification8 : SystemPartyIdentification
%% StatusReasonInformation10 recursion level 1 with max 1
class StatusReasonInformation10{
    AdditionalInformation IsoMax140Text
}
StatusReasonInformation10 *-- "1..1" IStatusReason6Choice : Reason
%% SystemPartyIdentification8 recursion level 1 with max 1
SystemPartyIdentification8 *-- "1..1" PartyIdentification136 : Identification
SystemPartyIdentification8 *-- "0..1" PartyIdentification136 : ResponsiblePartyIdentification
  

PartyStatus2 members

Member name Description Data Type / Multiplicity
Status Status of the party maintenance instruction. Status6Code - Required 1..1
StatusReason Specifies the underlying reason for the status of an object. StatusReasonInformation10 - Unknown 0..0
SystemPartyIdentification Specifications of a party defined within a system. SystemPartyIdentification8 - Optional 0..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 PartyStatusAdviceV01 implementation follows a specific implementaiton pattern. First of all, PartyStatusAdviceV01 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, PartyStatusAdviceV01Document implements IOuterDocument. Because PartyStatusAdviceV01 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type PartyStatusAdviceV01.

classDiagram
    class IOuterRecord
    PartyStatusAdviceV01 --|> IOuterRecord : Implements
    PartyStatusAdviceV01Document --|> IOuterDocument~PartyStatusAdviceV01~ : Implements
    class IOuterDocument~PartyStatusAdviceV01~ {
        PartyStatusAdviceV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    PartyStatusAdviceV01Document *-- PartyStatusAdviceV01 : 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.016.001.01">
    <PtyStsAdvc>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <PtySts>
            <!-- PartyStatus inner content -->
        </PtySts>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </PtyStsAdvc>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_5jHEEZeSEeen_cyMrluY4w"
  name="PartyStatusAdviceV01"
  definition="Scope:&#xD;&#xA;The PartyStatusAdvice message is sent by the executing party to the instructing party to provide details about the processing of a request on party reference data (create or update).&#xD;&#xA;&#xD;&#xA;Usage:&#xD;&#xA;When processing information is negative - a failure occurred in applying the changes the message accordingly also delivers information about the reason why the creation or update could not be processed.&#xD;&#xA;When processing is successfully performed, the message includes the related party identification."
  registrationStatus="Registered"
  messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
  xmlTag="PtyStsAdvc"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_eEidoVhGEeih3fUfzR38Ig"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="MsgHdr"
    complexType="_Hm0DQYtSEeih5rmIxWMzEw" />
  <messageBuildingBlock
    xmi:id="_5jHEG5eSEeen_cyMrluY4w"
    name="PartyStatus"
    definition="Status of the party involved in the originating message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="PtySts"
    complexType="_7_fcO1hLEeih3fUfzR38Ig" />
  <messageBuildingBlock
    xmi:id="_5jHEHZeSEeen_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="016"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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