Erstellen von Schadenfallnotizen

Notizen müssen aus einem vorhandenen Schadenfall oder einer vorhandenen Aktivität mithilfe eines der folgenden Endpunkte erstellt werden:

POST claim/v1/claims/{claimId}/notes
POST common/v1/activities/{activityId}/notes

Das einzige für eine Notiz erforderliche Feld ist der Textkörper, in dem der Text der Notiz gespeichert wird. Optional können Sie folgende Felder angeben:


Feld	Datentyp	Beschreibung	Standardwert
`confidential`	Boolescher Wert	Gibt an, ob die Notiz vertraulich ist	false
`relatedTo`	Inline-Objekt	Bei Notizen, die mit Schadenfällen verknüpft sind, ist dies entweder der übergeordnete Schadenfall oder, so vorhanden, das untergeordnete Objekt (ClaimContact, Teilschaden oder Serviceanfrage), mit dem die Notiz verbunden ist.	Der übergeordnete Schadenfall
`securityType`	Typenschlüssel (`NoteSecurityType`)	Sicherheitstyp der Notiz	NULL
`subject`	Zeichenfolge	Betreff der Notiz	NULL
`topic`	Typenschlüssel (`NoteTopicType`)	Thementyp der Notiz	`general`

Minimale Notizen

Im Folgenden finden Sie ein Beispiel für das Erstellen einer minimalen Notiz für den Schadenfall cc:102.

POST /claim/v1/claims/cc:102/notes

{
  "data": {
    "attributes": {
        "body": "The insured's last name, Cahill, is pronounced 'KAH-hill', not 'KAY-hill'." 
    }
  }
}

Notizen mit zusätzlichen Details

Im Folgenden finden Sie ein Beispiel für das Erstellen einer detaillierten Notiz für den Schadenfall cc:102.

POST /claim/v1/claims/cc:102/notes

{
  "data": {
    "attributes": {
        "body": "The insured's last name, Cahill, is pronounced 'KAH-hill', not 'KAY-hill'." ,
        "confidential": false,
        "securityType": {
          "code": "public"
        },
        "subject": "Pronunciation note",
        "topic": {
          "code": "general"
        }
    }
  }
}

Notizen, die mit untergeordneten Objekten verknüpft sind

Standardmäßig ist jede Notiz nur an den übergeordneten Schadenfall angehängt. Sie können eine Notiz mit dem Feld relatedTo an eines der untergeordneten Objekte des Schadenfalls anhängen. Dieses Feld hat die folgende Syntax:

"relatedTo": {
  "id": "<childObjectId>",
  "type": "<childObjectType>"

Im folgenden Beispiel wird eine Notiz zu Schadenfall cc:102 für den Teilschaden mit der ID cc:48 erstellt:

POST /claim/v1/claims/cc:102/notes

{
  "data": {
    "attributes": {
        "body": "The claimant's last name, Cahill, is pronounced 'KAH-hill', not 'KAY-hill'.",
        "relatedTo": {
          "id": "cc:48",
          "type": "Exposure"
        }
    }
  }
}

Notizen für eine Aktivität

Im Folgenden finden Sie ein Beispiel für das Erstellen einer Notiz für die Aktivität xc:22.

POST /common/v1/activities/xc:22/notes

{
  "data": {
    "attributes": {
        "body": "This activity was completed during a telephone call with the insured on 11/17." 
    }
  }
}