CalendarQueryV02

reda.064.001.02

The CalendarQuery message is sent by the system member to the system administrator to request information on the the system status for specific calendar days.

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
%% CalendarQueryV02 recursion level 0 with max 0
CalendarQueryV02 *-- "1..1" MessageHeader9 : MessageHeader
CalendarQueryV02 *-- "0..1" CalendarSearchCriteria1 : SearchCriteria
CalendarQueryV02 *-- "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
%% MessageHeader9 recursion level 0 with max 1
class MessageHeader9{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}
MessageHeader9 *-- "0..1" IRequestType4Choice : RequestType
%% IRequestType4Choice recursion level 1 with max 1
  

MessageHeader9 members

SearchCriteria building block

Defines the criteria to extract the calendar information. Defines the criteria used to search for calendar data. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% CalendarSearchCriteria1 recursion level 0 with max 1
class CalendarSearchCriteria1{
    Year IsoISOYear
    Month IsoISOMonth
}
CalendarSearchCriteria1 *-- "0..1" SystemAndCurrency1 : Service
%% SystemAndCurrency1 recursion level 1 with max 1
class SystemAndCurrency1{
    SystemCurrency ActiveCurrencyCode
}
SystemAndCurrency1 *-- "1..1" ISystemIdentification2Choice : SystemIdentification
  

CalendarSearchCriteria1 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 CalendarQueryV02 implementation follows a specific implementaiton pattern. First of all, CalendarQueryV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CalendarQueryV02Document implements IOuterDocument. Because CalendarQueryV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CalendarQueryV02.

classDiagram
    class IOuterRecord
    CalendarQueryV02 --|> IOuterRecord : Implements
    CalendarQueryV02Document --|> IOuterDocument~CalendarQueryV02~ : Implements
    class IOuterDocument~CalendarQueryV02~ {
        CalendarQueryV02 Message
     }
  

Document wrapper for serialization

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

classDiagram
    CalendarQueryV02Document *-- CalendarQueryV02 : 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.064.001.02">
    <CalQry>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <SchCrit>
            <!-- SearchCriteria inner content -->
        </SchCrit>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </CalQry>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_DRJNKFuDEe29lKnE5APnfA"
  name="CalendarQueryV02"
  definition="The CalendarQuery message is sent by the system member to the system administrator to request information on the the system status for specific calendar days."
  registrationStatus="Registered"
  messageSet="_Ly468LRHEe275vtHwLOtdg"
  xmlTag="CalQry"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_DRJNKVuDEe29lKnE5APnfA"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgHdr"
    complexType="_jAUZkZIhEeect698_YsnIA" />
  <messageBuildingBlock
    xmi:id="_DRJNKluDEe29lKnE5APnfA"
    name="SearchCriteria"
    definition="Defines the criteria to extract the calendar information."
    registrationStatus="Provisionally Registered"
    minOccurs="0"
    xmlTag="SchCrit"
    complexType="_w9W9hYm5Eeipw6hHPgB4Sw" />
  <messageBuildingBlock
    xmi:id="_DRJNK1uDEe29lKnE5APnfA"
    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="064"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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