ReturnReservationV06

camt.047.001.06

Scope The ReturnReservation message is sent by the transaction administrator to a member. It is used to provide information on the details of one or more reservation facilities set by the member and managed by the transaction administrator. The ReturnReservation message can be sent as a response to a related Get Reservation 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 At any time during the operating hours of the system, the member can query the transaction administrator to get information about the reservations facilities that the transaction administrator manages for the member. The transaction administrator will send reservations information to the member based on the following elements:

identification of the system
identification of the account
status of the reservation (default and/or current )
type of reservation.

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
%% ReturnReservationV06 recursion level 0 with max 0
ReturnReservationV06 *-- "1..1" MessageHeader7 : MessageHeader
ReturnReservationV06 *-- "1..1" IReservationOrError8Choice : ReportOrError
ReturnReservationV06 *-- "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 reservations. It is used to provide confirmation details of one or more reservations set by the member (or on behalf of the member) and managed by the transaction administrator. For comparison, see the ISO20022 official specification

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

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

classDiagram
    class IOuterRecord
    ReturnReservationV06 --|> IOuterRecord : Implements
    ReturnReservationV06Document --|> IOuterDocument~ReturnReservationV06~ : Implements
    class IOuterDocument~ReturnReservationV06~ {
        ReturnReservationV06 Message
     }

Document wrapper for serialization

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

classDiagram
    ReturnReservationV06Document *-- ReturnReservationV06 : 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.047.001.06">
    <RtrRsvatn>
        <MsgHdr>
            <!-- MessageHeader inner content -->
        </MsgHdr>
        <RptOrErr>
            <!-- ReportOrError inner content -->
        </RptOrErr>
        <SplmtryData>
            <!-- SupplementaryData inner content -->
        </SplmtryData>
    </RtrRsvatn>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_jwlcKRbvEeiyVv5j1vf1VQ"
  nextVersions="_ThV639b6Eeq_l4BJLVUF2Q"
  name="ReturnReservationV06"
  definition="Scope&#xD;&#xA;The ReturnReservation message is sent by the transaction administrator to a member.&#xD;&#xA;It is used to provide information on the details of one or more reservation facilities set by the member and managed by the transaction administrator.&#xD;&#xA;The ReturnReservation message can be sent as a response to a related Get Reservation 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;At any time during the operating hours of the system, the member can query the transaction administrator to get information about the reservations facilities that the transaction administrator manages for the member.&#xD;&#xA;The transaction administrator will send reservations information to the member based on the following elements:&#xD;&#xA;- identification of the system&#xD;&#xA;- identification of the account&#xD;&#xA;- status of the reservation (default and/or current )&#xD;&#xA;- type of reservation."
  registrationStatus="Registered"
  messageSet="_S0OMdGY1EeuQ__SOdbf47A"
  xmlTag="RtrRsvatn"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_jwlcKxbvEeiyVv5j1vf1VQ"
    nextVersions="_ThWht9b6Eeq_l4BJLVUF2Q"
    name="MessageHeader"
    definition="Common business identification for the message."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="MsgHdr"
    complexType="_imfkUZIhEeect698_YsnIA" />
  <messageBuildingBlock
    xmi:id="_jwlcLRbvEeiyVv5j1vf1VQ"
    nextVersions="_ThWhudb6Eeq_l4BJLVUF2Q"
    name="ReportOrError"
    definition="Reports on reservations."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="RptOrErr"
    complexType="_DMyNh24-EeiU9cctagi5ow" />
  <messageBuildingBlock
    xmi:id="_jwlcLxbvEeiyVv5j1vf1VQ"
    nextVersions="_ThWhu9b6Eeq_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="047"
    flavour="001"
    version="06" />
</messageDefinition>

ISO Building Blocks

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