Iso20022

CaseStatusReportRequestV02

camt.038.001.02

Scope The CaseStatusReportRequest 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
%% CaseStatusReportRequestV02 recursion level 0 with max 0
CaseStatusReportRequestV02 *-- "1..1" ReportHeader2 : RequestHeader
CaseStatusReportRequestV02 *-- "1..1" Case2 : 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
%% ReportHeader2 recursion level 0 with max 1
class ReportHeader2{
    Identification IsoMax35Text
    CreationDateTime IsoISODateTime
}
ReportHeader2 *-- "1..1" IParty7Choice : From
ReportHeader2 *-- "1..1" IParty7Choice : To
%% IParty7Choice recursion level 1 with max 1
%% IParty7Choice recursion level 1 with max 1

ReportHeader2 members

Member name Description Data Type / Multiplicity
Identification Point to point reference as assigned by the case assigner to unambiguously identify the case status report. IsoMax35Text - Required 1..1
From Party reporting the status of the investigation case. IParty7Choice - Required 1..1
To Party to which the status of the case is reported. IParty7Choice - Required 1..1
CreationDateTime Date and time at which the message was created. IsoISODateTime - Required 1..1

Case building block

Identifies the investigation case. Set of elements used to identify a case. For comparison, see the ISO20022 official specification

classDiagram
   direction tb
%% Case2 recursion level 0 with max 1
class Case2{
    Identification IsoMax35Text
    ReopenCaseIndication IsoYesNoIndicator
}
Case2 *-- "1..1" IParty7Choice : Creator
%% IParty7Choice recursion level 1 with max 1

Case2 members

Member name Description Data Type / Multiplicity
Identification Uniquely identifies the case. IsoMax35Text - Required 1..1
Creator Party that created the investigation case. IParty7Choice - Required 1..1
ReopenCaseIndication Indicates whether or not the case was previously closed and is now re-opened. IsoYesNoIndicator - Optional 0..1

Extensibility and generalization considerations

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

classDiagram
    class IOuterRecord
    CaseStatusReportRequestV02 --|> IOuterRecord : Implements
    CaseStatusReportRequestV02Document --|> IOuterDocument~CaseStatusReportRequestV02~ : Implements
    class IOuterDocument~CaseStatusReportRequestV02~ {
        CaseStatusReportRequestV02 Message
     }

Document wrapper for serialization

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

classDiagram
    CaseStatusReportRequestV02Document *-- CaseStatusReportRequestV02 : 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.02">
    <CaseStsRptReq>
        <ReqHdr>
            <!-- RequestHeader inner content -->
        </ReqHdr>
        <Case>
            <!-- Case inner content -->
        </Case>
    </CaseStsRptReq>
</Document>

Data from ISO specification

This is the technical data from the specification document.

<messageDefinition
  xmi:id="_O2WCWNE-Ed-BzquC8wXy7w_940181382"
  nextVersions="_sVWbg1kyEeGeoaLUQk__nA_150838018"
  previousVersion="_OXDeQNE-Ed-BzquC8wXy7w_1889207264"
  name="CaseStatusReportRequestV02"
  definition="Scope&#xD;&#xA;The CaseStatusReportRequest 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 suspend an investigation by classifying it as overdue if, this agent, after sending the request for the status of the investigation, does not receive any response after a long time. Agents may set their individual threshold wait-time."
  registrationStatus="Registered"
  messageSet="_urpIICeJEeOCeO5e7islRQ"
  xmlTag="CaseStsRptReq"
  rootElement="Document"
  xmlns:xmi="http://www.omg.org/XMI">
  <messageBuildingBlock
    xmi:id="_O2WCWdE-Ed-BzquC8wXy7w_1795408483"
    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="_Rq4LdNp-Ed-ak6NoX_4Aeg_891312394" />
  <messageBuildingBlock
    xmi:id="_O2WCWtE-Ed-BzquC8wXy7w_1795408421"
    name="Case"
    definition="Identifies the investigation case."
    registrationStatus="Provisionally Registered"
    maxOccurs="1"
    minOccurs="1"
    xmlTag="Case"
    complexType="_SpAnptp-Ed-ak6NoX_4Aeg_-1565053133" />
  <messageDefinitionIdentifier
    businessArea="camt"
    messageFunctionality="038"
    flavour="001"
    version="02" />
</messageDefinition>

ISO Building Blocks

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