camt.046.001.05
Scope The GetReservation message is sent by a member to the transaction administrator. It is used to request information on the details of one or more reservation facilities set by the member and managed by the transaction administrator. Usage The member can request reservations information based on the following elements:
- identification of the system;
- identification of the account;
- status of the reservation (default and/or current);
- type of reservation. This message will be replied to by a ReturnReservation message.
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
%% GetReservationV05 recursion level 0 with max 0
GetReservationV05 *-- "1..1" MessageHeader9 : MessageHeader
GetReservationV05 *-- "0..1" ReservationQuery3 : ReservationQueryDefinition
GetReservationV05 *-- "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 |
ReservationQueryDefinition building block
Definition of the reservation query. Defines the reservation query criteria. For comparison, see the ISO20022 official specification
classDiagram
direction tb
%% ReservationQuery3 recursion level 0 with max 1
class ReservationQuery3{
QueryType QueryType2Code
}
ReservationQuery3 *-- "0..1" IReservationCriteria3Choice : ReservationCriteria
%% IReservationCriteria3Choice recursion level 1 with max 1
ReservationQuery3 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 |
| ReservationCriteria | Defines the reservation query criteria. | IReservationCriteria3Choice - 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 GetReservationV05 implementation follows a specific implementaiton pattern. First of all, GetReservationV05 impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, GetReservationV05Document implements IOuterDocument. Because GetReservationV05 implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type GetReservationV05.
classDiagram
class IOuterRecord
GetReservationV05 --|> IOuterRecord : Implements
GetReservationV05Document --|> IOuterDocument~GetReservationV05~ : Implements
class IOuterDocument~GetReservationV05~ {
GetReservationV05 Message
}
Document wrapper for serialization
The only real purpose GetReservationV05Document serves is to cause the document to be serialized into the ‘urn:iso:std:iso:20022:tech:xsd:camt.046.001.05’ namespace. Therefore, it will probably be the usual practice to build the message and construct this wrapper at the last minute using GetReservationV05.ToDocument() method. The returned GetReservationV05Document value will serialize correctly according to ISO 20022 standards.
classDiagram
GetReservationV05Document *-- GetReservationV05 : 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.046.001.05">
<GetRsvatn>
<MsgHdr>
<!-- MessageHeader inner content -->
</MsgHdr>
<RsvatnQryDef>
<!-- ReservationQueryDefinition inner content -->
</RsvatnQryDef>
<SplmtryData>
<!-- SupplementaryData inner content -->
</SplmtryData>
</GetRsvatn>
</Document>
Data from ISO specification
This is the technical data from the specification document.
<messageDefinition
xmi:id="_jwlblxbvEeiyVv5j1vf1VQ"
nextVersions="_ThOmBdb6Eeq_l4BJLVUF2Q"
name="GetReservationV05"
definition="Scope
The GetReservation message is sent by a member to the transaction administrator.
It is used to request information on the details of one or more reservation facilities set by the member and managed by the transaction administrator.
Usage
The member can request reservations information based on the following elements:
- identification of the system;
- identification of the account;
- status of the reservation (default and/or current);
- type of reservation.
This message will be replied to by a ReturnReservation message."
registrationStatus="Registered"
messageSet="_urpIICeJEeOCeO5e7islRQ"
xmlTag="GetRsvatn"
rootElement="Document"
xmlns:xmi="http://www.omg.org/XMI">
<messageBuildingBlock
xmi:id="_jwlbmRbvEeiyVv5j1vf1VQ"
nextVersions="_ThOmC9b6Eeq_l4BJLVUF2Q"
name="MessageHeader"
definition="Common business identification for the message."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="1"
xmlTag="MsgHdr"
complexType="_jAUZkZIhEeect698_YsnIA" />
<messageBuildingBlock
xmi:id="_jwlbmxbvEeiyVv5j1vf1VQ"
nextVersions="_ThOmDdb6Eeq_l4BJLVUF2Q"
name="ReservationQueryDefinition"
definition="Definition of the reservation query."
registrationStatus="Provisionally Registered"
maxOccurs="1"
minOccurs="0"
xmlTag="RsvatnQryDef"
complexType="_Dqby124-EeiU9cctagi5ow" />
<messageBuildingBlock
xmi:id="_jwlbnRbvEeiyVv5j1vf1VQ"
nextVersions="_ThOmD9b6Eeq_l4BJLVUF2Q"
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="046"
flavour="001"
version="05" />
</messageDefinition>
ISO Building Blocks
The following items are used as building blocks to construct this message.