Erstellen von Konto-, Job- und Policennotizen

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

POST account/v1/accounts/{accountId}/notes
POST job/v1/jobs/{jobId}/notes
POST policy/v1/policies/{policyId}/notes
POST common/v1/activities/{activityId}/notes

Beachten Sie, dass PolicyCenter auch Notizen unterstützt, die an andere Objekte wie PolicyPeriods angehängt sind. Bei der aktuellen Version unterstützt die Cloud-API jedoch noch nicht die Möglichkeit, Notizen für übergeordnete Objekte außerhalb von Konten, Jobs, Policen und Aktivitäten zu erstellen.

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


Feld	Datentyp	Beschreibung	Standardwert
`confidential`	Boolescher Wert	Gibt an, ob die Notiz vertraulich ist	false
`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 Notiz für Konto pc:10.

POST /account/v1/accounts/pc:10/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 die Erstellung einer detaillierten Notiz für Konto pc:10.

POST /account/v1/accounts/pc:10/notes

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

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." 
    }
  }
}