Cloud-API-Geschäftsabläufe- und Konfigurationshandbuch
Verwendung der Cloud-API
REST-API-Grundlagen in Cloud-API
Die InsuranceSuite Cloud-API
Ressourcen
Endpunkte
Stammressourcen
Untergeordnete Ressourcen
Operationen
Pfade
Anforderungen und Antworten
Testen von Anforderungen und Antworten
Lernprogramm: Einrichten Ihrer Postman-Umgebung
Übersicht über die System-APIs in Cloud-APIs
Die System-APIs der Basiskonfiguration
Cloud-API-Versionen
Anzeigen von API-Definitionen
Swagger-Benutzeroberfläche
Anzeigen eine rAPI-Definition mit der Swagger-Benutzeroberfläche
Organisation von API-Informationen in der Swagger-Benutzeroberfläche
Die API-Definitionsendpunkte und Postman
Anzeigen einer API-Definition mit Postman
Organisation von Informationen in der Ausgabe von API-Definitionsendpunkten
Beta-APIs
Veröffentlichte APIs und Endpunkte
Beta-APIs und Beta-Endpunkte
Beta-APIs für diese Version
Zusätzliche Metadaten-Endpunktfunktionen
Funktionen für alternative API-Tools
Die /typelists-Endpunkte
Lernprogramm: Abfrage nach Typenlisten-Metadaten
Routing von zugehörigen API-Aufrufen in Cluster-Umgebungen
GETs und Antwort-Nutzdatenstrukturen
Übersicht über GETs
Standardisierung von Nutzdatenstrukturen
Anzeigen von Antwortschemas
Antwortschema in der Swagger-Benutzeroberfläche anzeigen
Senden von GETs
GET mit Postman senden
Lernprogramm: Eine einfache Postman-Anforderung senden
Nutzdatenstruktur für eine grundlegende Antwort
Struktur einer Grundantwort
Eigenschaft "count"
Abschnitt "data"
Abschnitt "attributes"
Feld "checksum"
Unterabschnitt "links" (für ein Element)
Abschnitt "links" auf Sammlungsebene
Nutzdatenstruktur für eine Antwort mit eingeschlossenen Ressourcen
Lernprogramm: Eine Postman-Anfrage mit eingeschlossenen Ressourcen senden
Struktur einer Antwort mit eingeschlossenen Ressourcen
Abschnitt "related" (für eine Ressource)
Abschnitt "included" (für eine Antwort)
Einschließen einer Sammlung oder einer bestimmten Ressource
Ermitteln, welche Ressourcen einbezogen werden können
Verfeinern von Antwort-Nutzdaten
Übersicht über Abfrageparameter
Anzeigen der Dokumentation von Abfrageparametern in der Swagger-Benutzeroberfläche
Fehlermeldungen zu Abfrageparametern
Festlegen der zurückzugebenden Ressourcen und Felder
Filtern von GETs
Lernprogramm: GET mit den Parametern filter senden
Festlegen, welche Felder über GET abgerufen werden sollen
Lernprogramm: GET mit dem Parameter fields senden
Sortieren des Ergebnissatzes
Lernprogramm: GET mit dem Parameter für die Sortierabfrage senden
Steuerung der Paginierung
Begrenzen der Anzahl von Ressourcen pro Nutzdaten
Auswählen einer einzelnen Ressource in einer Sammlung
Paging über Ressourcen
Abrufen der Gesamtzahl der Ressourcen
Lernprogramm: GET mit den Parametern pageSize und totalCount senden
Verwenden von Abfrageparametern für eingeschlossene Ressourcen
Angeben von Abfrageparametern, die für eine eingeschlossene Ressource gelten
Zusammenfassung der Abfrageparameter für eingeschlossene Ressourcen
Lernprogramm: GET mit Abfrageparametern für eingeschlossene Ressourcen senden
POSTs und Anforderungs-Nutzdatenstrukturen
Übersicht über POSTs
Standardisierung von Nutzdatenstrukturen
Anzeigen von Anforderungsschemas
Anforderungsschema in der Swagger-Benutzeroberfläche anzeigen
Entwerfen von Anforderungs-Nutzdaten
Ermitteln der erforderlichen, optionalen und schreibgeschützten Felder
Struktur der Nutzdaten anfordern
Festlegen von skalaren Werten in Anforderungs-Nutzdaten
Festlegen von Objekten in Anforderungs-Nutzdaten
Senden von POSTs
POST mit Postman senden
Lernprogramm: Neue Notiz erstellen, die nur Pflichtfelder angibt
Lernprogramm: Neue Notiz erstellen, die optionale Felder angibt
Antworten auf ein POST
Postman-Verhalten mit Umleitungen
POSTs für Geschäftsaktionen
Verbessern der POST-Leistung
PATCHs
Übersicht über PATCHs
Die PATCH-Nutzdatenstruktur
Entwerfen von Anforderungs-Nutzdaten
PATCHs und Arrays
Senden von PATCHs
PATCH mit Postman senden
Lernprogramm: PATCH von Aktivitäten
Antworten auf ein PATCH
PATCHs und verlorene Aktualisierungen
Postman-Verhalten mit Umleitungen
DELETEs
Übersicht über DELETEs
Lernprogramm: Löschen von Notizen
DELETEs und verlorene Aktualisierungen
Reduzierung der Anzahl der Aufrufe
Funktionen, die mehrere Anforderungen gleichzeitig ausführen
Vergleich von Funktionen, die mehrere Anforderungen ausführen
Bestimmen der zu verwendenden Funktion
Anforderungseinschluss
Syntax für einfache hierarchische Beziehungen
Syntax für benannte Verhältnisse
Zusätzliches Verhalten beim Einschließen von Anforderungen
Stapelverarbeitungsanforderungen
Optionale Unteranforderungsattribute
Syntax für Stapelanforderungen
Einfache Stapelanforderungen
Stapelverarbeitungsanforderungen mit Abfrageparametern
Stapelanforderungen mit Anforderungs-Nutzdaten
Stapelanforderungen mit unterschiedlichen Operationen
Angeben von Unteranforderungskopfzeilen
Festlegen des onFail-Verhaltens
Konfigurieren der maximalen Anzahl von Unteranforderungen
Zusammengesetzte Anforderungen
Erstellen zusammengesetzter Anforderungsaufrufe
Abschnitt requests
Verwenden von Variablen zum gemeinsamen Nutzen von Informationen über Unteranforderungen hinweg
Antworten auf die Unteranforderungen
Abschnitt selections
Fehlerbehandlung
Protokollierung
Beschränkungen für zusammengesetzte Anforderungen
Beispiele für zusammengesetzte Anforderungen
Konfigurieren der maximalen Anzahl von Unteranforderungen
Vollständige Syntax für zusammengesetzte Anforderungen
Verlorene Aktualisierungen und Prüfsummen
Verlorene Aktualisierungen
Prüfsummen
Prüfsummen für PATCHs und POSTs für Geschäftsaktionen
Lernprogramm: PATCH einer Aktivität mit Prüfsummen
Lernprogramm: Eine Aktivität mithilfe von Prüfsummen zuweisen
Prüfsummen für DELETEs
Prüfsumme in einem Anforderungskopf mit Postman senden
Lernprogramm: Löschen einer Notiz mithilfe von Prüfsummen
Cloud-API-Header
HTTP-Header
Übersicht über Cloud-API-Header
Anforderung mit einem Cloud-API-Header über Postman senden
Verhindern doppelter Datenbanktransaktionen
Aufwärmen eines Endpunkts
Bearbeiten eines Aufrufs mit unbekannten Elementen
Validieren von Antwort-Nutzdaten anhand zusätzlicher Einschränkungen
Globalisierung
Festlegen von Sprache und Gebietsschema bei API-Anforderungen
Adressen und Gebietsschemata
Konfiguration des Adressgebiets
Geschäftsabläufe: Schadenerstmeldung und Schlichtung
Ausführen von Schadenerstmeldungen
Übersicht über den Schadenerstmeldungsprozess
Schadenfallentwürfe und offene Schadenfälle
Verifizierte und unverifizierte Policen
Übersicht über den Schadenerstmeldungsprozess in der Cloud-API
Der Cloud-API-Schadenerstmeldungsprozess
Anwendungsfälle für Schadenerstmeldungen nach Policenstatus
Beschränkungen für zusammengesetzte Anforderungen bei Schadenfällen
Stornieren von Schadenfällen
Schadenfallmodi
Die Test-Dienstprogramm-API
Anzeigen von Informationen zur Test-Dienstprogramm-API
ClaimCenter-Umgebung in Studio festlegen
Anzeigen der Test-Dienstprogramm-API in der Swagger-Benutzeroberfläche
Testpolicendaten erstellen
Lernprogramm: Erstellen einer Police mithilfe der Test-Dienstprogramm-API
Erstellen von Testdaten für zugehörige Objekte
POST für einen Schadenfall mit minimalem Entwurf verwenden
Lernprogramm: POSTEN eines minimalen Schadenfallentwurfs für ein Privatfahrzeug
PATCH für einen Schadenfallentwurf verwenden
Lernprogramm: PATCHEN eines Schadenfallentwurfs für Privatfahrzeuge
POST für einen typischen Schadenfallentwurf verwenden
Lernprogramm: POSTEN eines typischen Schadenfallentwurfs für Privatfahrzeuge
Erstellen von Schadenfällen mit unverifizierten Policen
Mindestkriterien für eine unverifizierte Police und einen Schadenfall
Kontakte für eine unverifizierte Police
Orte in einer unverifizierten Police
Wagnisse in einer unverifizierten Police
Deckungen für unverifizierte Policen
PATCH für eine unverifizierte Police verwenden
Abrufen von Informationen über eine unverifizierte Police
Einreichen eines Schadenfallentwurfs
Mindestkriterien für das Übermitteln eines Schadenfalls mit einer nicht verifizierten Police
Lernprogramm: Einreichen eines Schadenfallentwurfs
Stornieren eines Schadenfallentwurfs
Nachtrag zu Muster-Nutzdaten
Beispiel für die Nutzdaten einer Police
Beispiel für die Nutzdaten eines Schadenfallentwurfs
Beispiel für zusammengesetzte Schadenfall-Nutzdaten
Arbeiten mit Schadenfällen
Abfragen von mit Ihnen verknüpften Schadenfällen
Abfragen eines Schadenfalls nach Schadenfall-ID
Suchen nach aktiven und archivierten Schadenfällen
Anfordern von Nutzdaten für eine Schadenfallsuche
Antwort-Nutzdaten für eine Schadenfallsuche
Unterschiede zwischen Suchversionen
Abrufen von Policeninformationen
Zusammenfassung der Policenendpunkte
Zuweisen von Schadensfällen
Validieren von Schadensfällen
ClaimCenter-Validierungsstufen
Validieren eines Schadenfalls über die System-APIs
Abrufen von Schadenfällen aus dem Archiv
Arbeiten mit ClaimContacts
Übersicht über ClaimContacts in ClaimCenter
Übersicht über ClaimContacts in Cloud-API
Ändern von ClaimContact-Rollen
Festlegen reservierter Rollen
Festlegen nicht reservierter Rollen
Identifizieren des ClaimContact
Erstellen eines neuen ClaimContact und Angeben von dessen Rolle
Angeben einer Rolle für einen ClaimContact, der sich bereits im Schadenfall befindet
Angeben einer Rolle für einen Kontakt, der sich im Schadenfall befindet
ClaimContact-Rollenbeschränkungen
Arbeiten mit Vorfällen
Übersicht über Vorfälle in ClaimCenter
Übersicht über Vorfälle in der Cloud-API
Erstellen von Vorfällen
Wohnstättenvorfälle
Vorfälle mit Schaden an unbeweglichen Sachen
Verletzungsvorfälle
Vorfälle bezüglich Lebensführungskosten
Kfz-Vorfälle
Zusammenfassung der Vorfalltypen
Arbeiten mit Teilschäden
Übersicht über Teilschäden in ClaimCenter
Erstellen von Teilschäden
Mindestkriterien für die Erstellung
Erstellen von Teilschaden-Nutzdaten
Schritt 1: Identifizieren des Deckungstyps
Schritt 2: Identifizieren des Deckungsuntertyps
Schritt 3: Anspruchsteller erstellen oder identifizieren
Schritt 4: Vorfall erstellen oder identifizieren
Schritt 5: Identifizieren der Deckung
Abfragen und Ändern von Teilschäden
Zuweisen von Teilschäden
Zusätzliche Teilschaden-Endpunkte
Löschen von Teilschadenentwürfen
Prüfen von Teilschäden
Schließen von Teilschäden
Arbeiten mit Serviceanforderungen
Übersicht über Serviceanforderungen in ClaimCenter
Arten von Serviceanforderungen
Der Lebenszyklus einer Serviceanforderung
Rechnungen für Serviceanforderungen
Übersicht über Serviceanforderungen in der Cloud-API
APIs für Serviceanforderungen und Anbieterportale
Datenmodell für Serviceanforderungen
Serviceanforderungsnummern
Unterstützung für jede Art von Serviceanforderung
Beschränkungen für zusammengesetzte Anforderungen bei Serviceanforderungen
Abfragen von Serviceanforderungen
Erstellen von Serviceanforderungen
Mindestkriterien für die Erstellung
Ändern vorhandener Serviceanforderungen
PATCHen von Serviceanforderungen
Zuweisen von Serviceanforderungen an Benutzer
Befördern einer Serviceanforderung in ihrem Lebenszyklus
Übermitteln, Akzeptieren und Ablehnen von Serviceanforderungen
Abschließen und Stornieren von Serviceanforderungen
Angebote für Serviceanforderungen
Rechnungen für Serviceanforderungen
Abfragen von Rechnungen
Erstellen von Rechnungen für Serviceanforderungen
Genehmigen von Rechnungen für Serviceanforderungen
Rechnungen als bezahlt kennzeichnen
Widerrufen von Rechnungen für Serviceanforderungen
Geschäftsabläufe: Finanzen
Arbeiten mit Reserven
Übersicht über Reserven in ClaimCenter
Abfragen von Reserven
Erstellen von Reserven
Beispiel für das Erstellung von Reservepositionen
Beispiel für das Hinzufügen zu Reservepositionen
Bestätigen von Reservetransaktionen
Erstellen von Schecks
Übersicht über Schecks in ClaimCenter
Zahlungen
Schecks
Schecksätze
Abfragen von Schecksätzen und Schecks
Buchen von Schecks
Scheckerstellung in ClaimCenter
Erstellen von Schecks über die Cloud-API
Beispiel für die Erstellung eines minimalen Schecksatzes
Regelmäßige Zahlungen
Wiederholungen in ClaimCenter
Wiederholungen in der Cloud-API
Senden von Schecks alle X Monate am N-ten Tag
Senden von Schecks alle X Monate am N-ten Wochentag
Senden von Schecks alle X Wochen an einem bestimmten Wochentag
Abwicklung von Selbstbehalten
Abwicklung von Selbstbehalten in ClaimCenter
Abwicklung von Selbstbehalten in der Cloud-API
Selbstbehalte mit Unterzahlung und Überzahlung
Patching von Schecks
Löschen von Schecks
Verwalten des Lebenszyklus von Schecks
Der Lebenszyklus eines Schecks vor der Übertragung
Vorziehen eines Schecks auf die Einreichung über die Cloud-API
Der Lebenszyklus eines Schecks nach der Übertragung
Vorziehen eines Schecks über die Einreichung hinaus über die Cloud-API
Bestätigen von Zahlungstransaktionen
Rückerstattungen und Rückerstattungsreserven
Abfragen von Rückerstattungen und Rückerstattungsreserven
Erstellen von Rückerstattungen und Rückerstattungsreserven
Erstellen einer Rückerstattungsreserve
Erstellen eines Rückerstattungsreservesatzes
Bestätigen einer Rückerstattungsreserve
Erstellen einer Rückerstattung
Arbeiten mit der Mehrwährungsfunktion
Übersicht über die Mehrwährungsfunktion
Mehrwährung in ClaimCenter
Mehrwährung in der Cloud-API
Abrufen von Mehrwährungsinformationen
Mehrwährungsreserven
Mehrwährungsschecks
Buchen von Mehrwährungsinformationen
POSTen einer Reserve mit mehreren Währungen
POSTen einer Reserve mit einem benutzerdefinierten Wechselkurs
POSTen eines Schecksatzes mit mehreren Währungen
POSTen eines Schecksatzes mit einem benutzerdefinierten Wechselkurs
Zusätzliche Felder für Wechselkursschemata
Geschäftsabläufe: Framework-APIs
Arbeiten mit Aktivitäten
Abfragen von Aktivitäten
Erstellen von Aktivitäten
Zuweisen von Aktivitäten
Zuweisungsoptionen
Zuweisungsbeispiele
Abrufen empfohlener Beauftragter
Schließen von Aktivitäten
Zusätzliche Funktionen von Aktivitäten
Arbeiten mit Dokumenten
Übersicht über Dokumente
Abfragen von Dokumentinformationen
Abfragen von Dokumentmetadaten
Abfragen von Dokumentinhalten
Buchen von Dokumenten
Buchen von Dokumenten mit Postman
Patchen von Dokumenten
Löschen von Dokumenten
Arbeiten mit Notizen
Abfragen von Notizen
Erstellen von Schadenfallnotizen
Zusätzliche Funktionen für Notizen
Arbeiten mit Benutzern
Abfragen von Benutzerinformationen
Abfragen von Benutzern
Abfragen von Benutzerrollen
Erstellen und Aktualisieren von Benutzern
Erstellen von Benutzern
Aktualisieren von Benutzern
Konfigurieren der Cloud-API
Erweitern von System-API-Ressourcen
Schemaorganisation
Erweitern von Schemadefinitionen
Erweiterungssyntax für Schemadefinitionen
Erweitern von Mappern
Erweiterungssyntax für Mapper
Erweitern von Updatern
Erweiterungssyntax für Updater
Lernprogramm: Ressourcen-Erweiterung erstellen
Bereitstellen von Feedback
Verschleierung von personenbezogenen Daten
Aufheben von personenbezogenen Daten
Maskieren von personenbezogenen Daten