PartyQueryV01

reda.015.001.01

Scope: The PartyQuery message is sent by a central securities depository, a national central bank, a central securities depository participant, a central counter party, a payment bank, a trading party or a stock exchange to the executing party to query for the party reference data of a party defined in the system.

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
%% PartyQueryV01 recursion level 0 with max 0
PartyQueryV01 *-- "0..1" MessageHeader2 : MessageHeader
PartyQueryV01 *-- "1..1" PartyDataSearchCriteria2 : SearchCriteria
PartyQueryV01 *-- "0..1" PartyDataReturnCriteria2 : ReturnCriteria
PartyQueryV01 *-- "0..1" SupplementaryData1 : SupplementaryData
  

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

MessageHeader building block

Point to point reference elements, as assigned by the instructing party, to unambiguously identify the query 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
%% MessageHeader2 recursion level 0 with max 1
class MessageHeader2{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
MessageHeader2 *-- "0..1" IRequestType2Choice : RequestType
%% IRequestType2Choice recursion level 1 with max 1
  

MessageHeader2 members

SearchCriteria building block

Defines the criteria to be used to query the party reference data by the executing system. Set of search criteria for querying party reference data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PartyDataSearchCriteria2 recursion level 0 with max 1
class PartyDataSearchCriteria2{
    RestrictionIdentification IsoMax35Text
    ResidenceType ResidenceType1Code
}
PartyDataSearchCriteria2 *-- "0..1" IDatePeriodSearch1Choice : OpeningDate
PartyDataSearchCriteria2 *-- "0..1" IDatePeriodSearch1Choice : ClosingDate
PartyDataSearchCriteria2 *-- "0..1" ISystemPartyType1Choice : Type
PartyDataSearchCriteria2 *-- "0..1" PartyIdentification136 : ResponsiblePartyIdentification
PartyDataSearchCriteria2 *-- "0..1" PartyIdentification136 : PartyIdentification
PartyDataSearchCriteria2 *-- "0..1" IDateAndDateTimeSearch4Choice : RestrictionIssueDate
PartyDataSearchCriteria2 *-- "0..1" PartyLockStatus1 : LockStatus
%% IDatePeriodSearch1Choice recursion level 1 with max 1
%% IDatePeriodSearch1Choice recursion level 1 with max 1
%% ISystemPartyType1Choice recursion level 1 with max 1
%% 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
%% IDateAndDateTimeSearch4Choice recursion level 1 with max 1
%% PartyLockStatus1 recursion level 1 with max 1
class PartyLockStatus1{
    ValidFrom IsoISODate
    Status LockStatus1Code
    LockReason IsoMax35Text
}
  

PartyDataSearchCriteria2 members

ReturnCriteria building block

Defines the expected party reference data to be returned. Return criteria for information to be returned in the report deriving from a query about party reference data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% PartyDataReturnCriteria2 recursion level 0 with max 1
class PartyDataReturnCriteria2{
    OpeningDate IsoRequestedIndicator
    ClosingDate IsoRequestedIndicator
    Type IsoRequestedIndicator
    PartyIdentification IsoRequestedIndicator
    ResponsiblePartyIdentification IsoRequestedIndicator
    RestrictionIdentification IsoRequestedIndicator
    RestrictedOnDate IsoRequestedIndicator
    Name IsoRequestedIndicator
    ShortName IsoRequestedIndicator
    Address IsoRequestedIndicator
    TechnicalAddress IsoRequestedIndicator
    ContactDetails IsoRequestedIndicator
    ResidenceType IsoRequestedIndicator
    LockStatus IsoRequestedIndicator
    MarketSpecificAttribute IsoRequestedIndicator
}
  

PartyDataReturnCriteria2 members

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

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    PartyQueryV01 --|> IOuterRecord : Implements
    PartyQueryV01Document --|> IOuterDocument~PartyQueryV01~ : Implements
    class IOuterDocument~PartyQueryV01~ {
        PartyQueryV01 Message
     }
  

Document wrapper for serialization

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

classDiagram
    PartyQueryV01Document *-- PartyQueryV01 : 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.015.001.01">
    <PtyQry>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <SchCrit>
            <!-- SearchCriteria inner content -->
        </SchCrit>
        <RtrCrit>
            <!-- ReturnCriteria inner content -->
        </RtrCrit>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </PtyQry>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_6z5WgZeSEeen_cyMrluY4w"
  name="PartyQueryV01"
  definition="Scope:&#xA;The PartyQuery message is sent by a central securities depository, a national central bank, a central securities depository participant, a central counter party, a payment bank, a trading party or a stock exchange to the executing party to query for the party reference data of a party defined in the system."
  registrationStatus="Registered"
  messageSet="_Fl3iMBHREeqzEaNIFJIN-g"
  xmlTag="PtyQry"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_6z5Wg5eSEeen_cyMrluY4w"
    name="MessageHeader"
    definition="Point to point reference elements, as assigned by the instructing party, to unambiguously identify the query message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="MsgHdr"
    complexType="_746poqMgEeCJ6YNENx4h-w_-152680373" />
  <messageBuildingBlock
    xmi:id="_6z5WiZeSEeen_cyMrluY4w"
    name="SearchCriteria"
    definition="Defines the criteria to be used to query the party reference data by the executing system."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="SchCrit"
    complexType="_5ry10Z9wEeejnerJgFeC2w" />
  <messageBuildingBlock
    xmi:id="_6z5Wi5eSEeen_cyMrluY4w"
    name="ReturnCriteria"
    definition="Defines the expected party reference data to be returned."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="0"
    xmlTag="RtrCrit"
    complexType="_bwbnYYwXEei289CGNqs21g" />
  <messageBuildingBlock
    xmi:id="_6z5WjZeSEeen_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="015"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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