camt.013.001.04
Scope The GetMember message is sent by a member to the transaction administrator. It is used to request 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. 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 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. At any time during the operating hours of the system, the member can query the transaction administrator to get information about the static data related to the members of the system. The member can request 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
- account number of the member
- identification of contact persons for the member This message will be replied to by a ReturnMember message. Additional information on the generic design of the Get/Return messages can be found in the MDR Part 1 section How to Use the Cash Management Messages.
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
%% GetMemberV04 recursion level 0 with max 0
GetMemberV04 *-- "1..1" MessageHeader9 : MessageHeader
GetMemberV04 *-- "0..1" MemberQueryDefinition4 : MemberQueryDefinition
GetMemberV04 *-- "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
| 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 |
MemberQueryDefinition building block
Definition of the member query. Defines the query criteria. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% MemberQueryDefinition4 recursion level 0 with max 1
class MemberQueryDefinition4{
QueryType QueryType2Code
}
MemberQueryDefinition4 *-- "0..1" IMemberCriteriaDefinition2Choice : MemberCriteria
%% IMemberCriteriaDefinition2Choice recursion level 1 with max 1
MemberQueryDefinition4 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| QueryType | Specifies the type of matching items to be returned in the response to the query. | QueryType2Code - Optional 0..1 |
| MemberCriteria | Defines the member query criteria. | IMemberCriteriaDefinition2Choice - 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 GetMemberV04 implementation follows a specific implementaiton pattern. First of all, GetMemberV04 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, GetMemberV04Document implements IOuterDocument. Because GetMemberV04 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type GetMemberV04.
classDiagram
class IOuterRecord
GetMemberV04 --|> IOuterRecord : Implements
GetMemberV04Document --|> IOuterDocument~GetMemberV04~ : Implements
class IOuterDocument~GetMemberV04~ {
GetMemberV04 Message
}
Document wrapper for serialization
The only real purpose GetMemberV04Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.013.001.04’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using GetMemberV04.ToDocument() method. The returned GetMemberV04Document value will serialize correctly according to ISO 20022 standards.
classDiagram
GetMemberV04Document *-- GetMemberV04 : 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.013.001.04">
<GetMmb>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<MmbQryDef>
<!-- MemberQueryDefinition inner content -->
</MmbQryDef>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</GetMmb>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_jwlbjxbvEeiyVv5j1vf1VQ"
name="GetMemberV04"
definition="Scope
The GetMember message is sent by a member to the transaction administrator.
It is used to request 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.
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 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.
At any time during the operating hours of the system, the member can query the transaction administrator to get information about the static data related to the members of the system.
The member can request 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
- account number of the member
- identification of contact persons for the member
This message will be replied to by a ReturnMember message.
Additional information on the generic design of the Get/Return messages can be found in the MDR Part 1 section How to Use the Cash Management Messages."
registrationStatus="Registered"
messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
xmlTag="GetMmb"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_jwlbkRbvEeiyVv5j1vf1VQ"
name="MessageHeader"
definition="Common business identification for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_jAUZkZIhEeect698_YsnIA" />
<messageBuildingBlock
xmi:id="_jwlbkxbvEeiyVv5j1vf1VQ"
name="MemberQueryDefinition"
definition="Definition of the member query."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="MmbQryDef"
complexType="_iR9okXSbEeiH1ZOt2UD8vQ" />
<messageBuildingBlock
xmi:id="_jwlblRbvEeiyVv5j1vf1VQ"
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="013"
flavour="001"
version="04" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.