ReturnMemberV05

camt.014.001.05

Scope The ReturnMember message is sent by the transaction administrator to a member of the system. It is used to provide information on static data maintained by the transaction administrator and related to the participants in the system and their membership status vis-a-vis this system. The ReturnMember message can be sent as a response to a related GetMember message (pull mode) or initiated by the transaction administrator (push mode). The push of information can take place either at prearranged times or as a warning or alarm when a problem has occurred. Usage The transaction administrator is in charge of providing the members with business information. The term business information covers all information related to the management of the system, that is, not related to the transactions entered into in the system. The type of business information available can vary depending on the system. Among other things, it can refer to information about the membership of the system. The member can request information about the members of the system through a series of criteria, corresponding to the known information stored within the transaction administrator. Based on the criteria received within the request, the transaction administrator will select items that will match with the request and report them to the requestor. The transaction administrator may also send a Return Member message with pre-defined information at times previously agreed with the member or to warn the member about a particular problem that may have arisen and which needs the member(s) attention. The message from the transaction administrator can contain information based on the following elements:

identification of the member within the system
membership status
type of member
contact details for the member: name, address
identification of the member’s account
identification of contact persons for the member, their role and details.

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
%% ReturnMemberV05 recursion level 0 with max 0
ReturnMemberV05 *-- "1..1" MessageHeader7 : MessageHeader
ReturnMemberV05 *-- "1..1" IMemberReportOrError7Choice : ReportOrError
ReturnMemberV05 *-- "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
%% MessageHeader7 recursion level 0 with max 1
class MessageHeader7{
    MessageIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
    QueryName IsoMax35Text
}
MessageHeader7 *-- "0..1" IRequestType4Choice : RequestType
MessageHeader7 *-- "0..1" OriginalBusinessQuery1 : OriginalBusinessQuery
%% IRequestType4Choice recursion level 1 with max 1
%% OriginalBusinessQuery1 recursion level 1 with max 1
class OriginalBusinessQuery1{
    MessageIdentification IsoMax35Text
    MessageNameIdentification IsoMax35Text
    CreationDateTime IsoISODateTime
}

MessageHeader7 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
RequestType	Specific actions to be executed through the request.	IRequestType4Choice - Optional 0..1
OriginalBusinessQuery	Unique identification of the original query message.	OriginalBusinessQuery1 - Optional 0..1
QueryName	Recalls the criteria (search and return criteria) defined in a preceding query.	IsoMax35Text - Optional 0..1

ReportOrError building block

Reports on members. It is used to provide information on transactions and booked entries held at the transaction administrator. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% IMemberReportOrError7Choice recursion level 0 with max 1

MemberReportOrError7Choice members

Member name	Description	Data Type / Multiplicity

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

classDiagram
    class IOuterRecord
    ReturnMemberV05 --|> IOuterRecord : Implements
    ReturnMemberV05Document --|> IOuterDocument~ReturnMemberV05~ : Implements
    class IOuterDocument~ReturnMemberV05~ {
        ReturnMemberV05 Message
     }

Document wrapper for serialization

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

classDiagram
    ReturnMemberV05Document *-- ReturnMemberV05 : 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:camt.014.001.05">
    <RtrMmb>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <RptOrErr>
            <!-- ReportOrError inner content -->
        </RptOrErr>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </RtrMmb>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_ThV60db6Eeq_l4BJLVUF2Q"
  previousVersion="_jwlcIRbvEeiyVv5j1vf1VQ"
  name="ReturnMemberV05"
  definition="Scope&#xD;&#xA;The ReturnMember message is sent by the transaction administrator to a member of the system.&#xD;&#xA;It is used to provide information on static data maintained by the transaction administrator and related to the participants in the system and their membership status vis-a-vis this system.&#xD;&#xA;The ReturnMember message can be sent as a response to a related GetMember message (pull mode) or initiated by the transaction administrator (push mode). The push of information can take place either at prearranged times or as a warning or alarm when a problem has occurred.&#xD;&#xA;Usage&#xD;&#xA;The transaction administrator is in charge of providing the members with business information. The term business information covers all information related to the management of the system, that is, not related to the transactions entered into in the system. The type of business information available can vary depending on the system. Among other things, it can refer to information about the membership of the system.&#xD;&#xA;The member can request information about the members of the system through a series of criteria, corresponding to the known information stored within the transaction administrator. Based on the criteria received within the request, the transaction administrator will select items that will match with the request and report them to the requestor.&#xD;&#xA;The transaction administrator may also send a Return Member message with pre-defined information at times previously agreed with the member or to warn the member about a particular problem that may have arisen and which needs the member(s) attention.&#xD;&#xA;The message from the transaction administrator can contain information based on the following elements:&#xD;&#xA;- identification of the member within the system&#xD;&#xA;- membership status&#xD;&#xA;- type of member&#xD;&#xA;- contact details for the member: name, address&#xD;&#xA;- identification of the member's account&#xD;&#xA;- identification of contact persons for the member, their role and details."
  registrationStatus="Registered"
  messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
  xmlTag="RtrMmb"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_ThV62db6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlcIxbvEeiyVv5j1vf1VQ"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgHdr"
    complexType="_imfkUZIhEeect698_YsnIA" />
  <messageBuildingBlock
    xmi:id="_ThV629b6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlcJRbvEeiyVv5j1vf1VQ"
    name="ReportOrError"
    definition="Reports on members."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptOrErr"
    complexType="_fMY0YdcZEeqRFcf2R4bPBw" />
  <messageBuildingBlock
    xmi:id="_ThV63db6Eeq_l4BJLVUF2Q"
    previousVersion="_jwlcJxbvEeiyVv5j1vf1VQ"
    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="camt"
    messageFunctionality="014"
    flavour="001"
    version="05" />
</messageDefinition>

ISO Building Blocks

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