Iso20022

CaseStatusReportRequest

camt.038.001.01

Scope The Case Status Report Request message is sent by a case creator or case assigner to a case assignee. This message is used to request the status of a case. Usage The Case Status Report Request message must be answered with a Case Status Report message. It can be used to request the status of a:

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
%% CaseStatusReportRequest recursion level 0 with max 0
CaseStatusReportRequest *-- "1..1" ReportHeader : RequestHeader
CaseStatusReportRequest *-- "1..1" Case : Case

Now, we will zero-in one-by-one on each of these building blocks.

RequestHeader building block

Identifies the party requesting the status, the requested party, the identification and the date of the status. Specifies generic information about an investigation report. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% ReportHeader recursion level 0 with max 1
class ReportHeader{
    Identification IsoMax35Text
    From IsoAnyBICIdentifier
    To IsoAnyBICIdentifier
    CreationDateTime IsoISODateTime
}

ReportHeader members

Member name Description Data Type / Multiplicity
Identification Identification of the report. IsoMax35Text - Required 1..1
From Party reporting the status of the case. IsoAnyBICIdentifier - Required 1..1
To Party to which the status of the case is reported. IsoAnyBICIdentifier - Required 1..1
CreationDateTime Creation date and time of the report generation. IsoISODateTime - Required 1..1

Case building block

Identifies the case. Information identifying a case. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Case recursion level 0 with max 1
class Case{
    Identification IsoMax35Text
    Creator IsoAnyBICIdentifier
    ReopenCaseIndication IsoYesNoIndicator
}

Case members

Member name Description Data Type / Multiplicity
Identification Unique id assigned by the case creator. IsoMax35Text - Required 1..1
Creator Party that created the case. IsoAnyBICIdentifier - Required 1..1
ReopenCaseIndication Set to yes if the case was closed and needs to be re-opened. IsoYesNoIndicator - Optional 0..1

Extensibility and generalization considerations

To facilitate generalized design patterns in the system, the CaseStatusReportRequest implementation follows a specific implementaiton pattern. First of all, CaseStatusReportRequest impleemnts IOuterRecord indicating it is the outermost logical part of the message definition. Like all message wrappers, CaseStatusReportRequestDocument implements IOuterDocument. Because CaseStatusReportRequest implements IOuterDocument, it is a suitable template parameter for IOuterDocument, and causes the internal ‘Message’ to be of type CaseStatusReportRequest.

classDiagram
    class IOuterRecord
    CaseStatusReportRequest --|> IOuterRecord : Implements
    CaseStatusReportRequestDocument --|> IOuterDocument~CaseStatusReportRequest~ : Implements
    class IOuterDocument~CaseStatusReportRequest~ {
        CaseStatusReportRequest Message
     }

Document wrapper for serialization

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

classDiagram
    CaseStatusReportRequestDocument *-- CaseStatusReportRequest : 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.038.001.01">
    <camt.038.001.01>
        <ReqHdr>
            <!-- RequestHeader inner content -->
        </ReqHdr>
        <Case>
            <!-- Case inner content -->
        </Case>
    </camt.038.001.01>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_OXDeQNE-Ed-BzquC8wXy7w_1889207264"
  nextVersions="_O2WCWNE-Ed-BzquC8wXy7w_940181382"
  name="CaseStatusReportRequest"
  definition="Scope&#xD;&#xA;The Case Status Report Request message is sent by a case creator or case assigner to a case assignee.&#xD;&#xA;This message is used to request the status of a case.&#xD;&#xA;Usage&#xD;&#xA;The Case Status Report Request message must be answered with a Case Status Report message. It can be used to request the status of a:&#xD;&#xA;- request to cancel payment case&#xD;&#xA;- request to modify payment case&#xD;&#xA;- unable to apply case&#xD;&#xA;- claim non receipt case&#xD;&#xA;The Case Status Report Request message covers one and only one case at a time. If a case creator or case assigner needs the status of several cases, then multiple Case Status Report Request messages must be sent.&#xD;&#xA;The Case Status Report Request message may be forwarded to subsequent case assignee(s) in the case processing chain.&#xD;&#xA;The processing of a case generates Notification Of Case Assignment and/or Resolution Of Investigation messages to the case creator/case assigner. They alone should provide collaborating parties sufficient information about the progress of the investigation. The Case Status Report Request must therefore only be used when no information has been received from the case assignee within the expected time frame.&#xD;&#xA;An agent may suspense an investigation by classifying it as overdue if he, after sending the request for status, does not receive any response after a long time. Agents may set their individual threshold wait-time."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlName="camt.038.001.01"
  xmlTag="camt.038.001.01"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_OXDeQdE-Ed-BzquC8wXy7w_-669475545"
    name="RequestHeader"
    definition="Identifies the party requesting the status, the requested party, the identification and the date of the status."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="ReqHdr"
    complexType="_RI5fwNp-Ed-ak6NoX_4Aeg_24374172" />
  <messageBuildingBlock
    xmi:id="_OXDeQtE-Ed-BzquC8wXy7w_1781217793"
    name="Case"
    definition="Identifies the case."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Case"
    complexType="_SpAnotp-Ed-ak6NoX_4Aeg_136183535" />
  <messageDefinitionIdentifier
    businessArea="camt"
    messageFunctionality="038"
    flavour="001"
    version="01" />
</messageDefinition>

ISO Building Blocks

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