camt.103.001.02
Scope The CreateReservation message is used to request for the creation of one particular reservation by the member and managed by the transaction administrator. Usage Based on the criteria defined in the CreateReservation message, the transaction administrator will execute or reject the requested creation and respond with a Receipt message as a reply to the request.
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
%% CreateReservationV02 recursion level 0 with max 0
CreateReservationV02 *-- "1..1" MessageHeader1 : MessageHeader
CreateReservationV02 *-- "1..1" ReservationIdentification3 : ReservationIdentification
CreateReservationV02 *-- "1..1" Reservation4 : ValueSet
CreateReservationV02 *-- "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
%% MessageHeader1 recursion level 0 with max 1
class MessageHeader1{
MessageIdentification IsoMax35Text
CreationDateTime IsoISODateTime
}
MessageHeader1 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. | IsoMax35Text - Required 1..1 |
| CreationDateTime | Date and time at which the message was created. | IsoISODateTime - Optional 0..1 |
ReservationIdentification building block
Identification of the default reservation. Liquidity set aside by the account owner for specific purposes. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ReservationIdentification3 recursion level 0 with max 1
class ReservationIdentification3{
ReservationIdentification IsoMax35Text
}
ReservationIdentification3 *-- "0..1" ISystemIdentification2Choice : SystemIdentification
ReservationIdentification3 *-- "1..1" IReservationType2Choice : Type
ReservationIdentification3 *-- "0..1" BranchAndFinancialInstitutionIdentification6 : AccountOwner
ReservationIdentification3 *-- "0..1" IAccountIdentification4Choice : AccountIdentification
%% ISystemIdentification2Choice recursion level 1 with max 1
%% IReservationType2Choice recursion level 1 with max 1
%% BranchAndFinancialInstitutionIdentification6 recursion level 1 with max 1
BranchAndFinancialInstitutionIdentification6 *-- "1..1" FinancialInstitutionIdentification18 : FinancialInstitutionIdentification
BranchAndFinancialInstitutionIdentification6 *-- "0..1" BranchData3 : BranchIdentification
%% IAccountIdentification4Choice recursion level 1 with max 1
ReservationIdentification3 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| ReservationIdentification | Unique identification of the reservation. | IsoMax35Text - Optional 0..1 |
| SystemIdentification | Identification of a particular cash clearing system. | ISystemIdentification2Choice - Optional 0..1 |
| Type | Nature of the reservation. | IReservationType2Choice - Required 1..1 |
| AccountOwner | Owner of the account which is being queried. | BranchAndFinancialInstitutionIdentification6 - Optional 0..1 |
| AccountIdentification | Unique and unambiguous identification for the account between the account owner and the account servicer. | IAccountIdentification4Choice - Optional 0..1 |
ValueSet building block
New reservation values. Liquidity set aside by the account owner for specific purposes. For comparison, see the ISO20022 official specification
classDiagram direction tb %% Reservation4 recursion level 0 with max 1 Reservation4 *-- "0..1" IDateAndDateTime2Choice : StartDateTime Reservation4 *-- "1..1" IAmount2Choice : Amount %% IDateAndDateTime2Choice recursion level 1 with max 1 %% IAmount2Choice recursion level 1 with max 1
Reservation4 members
| Member name | Description | Data Type / Multiplicity |
|---|---|---|
| StartDateTime | Date and time at which the reservation becomes effective. | IDateAndDateTime2Choice - Optional 0..1 |
| Amount | Amount of money of the limit, expressed in an eligible currency. | IAmount2Choice - Required 1..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 CreateReservationV02 implementation follows a specific implementaiton pattern. First of all, CreateReservationV02 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CreateReservationV02Document implements IOuterDocument. Because CreateReservationV02 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CreateReservationV02.
classDiagram
class IOuterRecord
CreateReservationV02 --|> IOuterRecord : Implements
CreateReservationV02Document --|> IOuterDocument~CreateReservationV02~ : Implements
class IOuterDocument~CreateReservationV02~ {
CreateReservationV02 Message
}
Document wrapper for serialization
The only real purpose CreateReservationV02Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.103.001.02’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using CreateReservationV02.ToDocument() method. The returned CreateReservationV02Document value will serialize correctly according to ISO 20022 standards.
classDiagram
CreateReservationV02Document *-- CreateReservationV02 : 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.103.001.02">
<CretRsvatn>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<RsvatnId>
<!-- ReservationIdentification inner content -->
</RsvatnId>
<ValSet>
<!-- ValueSet inner content -->
</ValSet>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</CretRsvatn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_ThLiq9b6Eeq_l4BJLVUF2Q"
previousVersion="_P8tokckHEem3UrxZgQhVAw"
name="CreateReservationV02"
definition="Scope
The CreateReservation message is used to request for the creation of one particular reservation by the member and managed by the transaction administrator.
Usage
Based on the criteria defined in the CreateReservation message, the transaction administrator will execute or reject the requested creation and respond with a Receipt message as a reply to the request."
registrationStatus="Registered"
messageSet="_SZTDoxcNEeiyVv5j1vf1VQ"
xmlTag="CretRsvatn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_ThMwtdb6Eeq_l4BJLVUF2Q"
previousVersion="_P8tol8kHEem3UrxZgQhVAw"
name="MessageHeader"
definition="Common business identification for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_75DzkaMgEeCJ6YNENx4h-w_-613853819" />
<messageBuildingBlock
xmi:id="_ThMwt9b6Eeq_l4BJLVUF2Q"
previousVersion="_P8tomckHEem3UrxZgQhVAw"
name="ReservationIdentification"
definition="Identification of the default reservation."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="RsvatnId"
complexType="_eK6JQdcZEeqRFcf2R4bPBw" />
<messageBuildingBlock
xmi:id="_ThMwudb6Eeq_l4BJLVUF2Q"
previousVersion="_P8tom8kHEem3UrxZgQhVAw"
name="ValueSet"
definition="New reservation values."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="ValSet"
complexType="_hsth0ZliEeeE1Ya-LgRsuQ" />
<messageBuildingBlock
xmi:id="_ThMwu9b6Eeq_l4BJLVUF2Q"
previousVersion="_P8tonckHEem3UrxZgQhVAw"
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="103"
flavour="001"
version="02" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.