Abfragen von Vorbehalten

Abfragen von Vorbehalten

Verwenden Sie die folgenden Endpunkte, um Informationen über bestehende Vorbehalte abzurufen.

Endpunkt Beschreibung
GET /jobs​/{jobId}​/contingencies Abrufen aller Vorbehalte für den gegebenen Job.
GET /jobs​/{jobId}​/contingencies​/{contingencyId} Abrufen des mit dem gegebenen Job verknüpften gegebenen Vorbehalts.
GET /policies​/{policyId}​/contingencies Abrufen aller Vorbehalte für die gegebene Police.
GET /policies​/{policyId}​/contingencies​/{contingencyId} Abrufen des mit der gegebenen Police verknüpften gegebenen Vorbehalts.

Vorbehalte verwenden dasselbe Schema, unabhängig davon, ob sie mit Jobs oder Policen verknüpft sind.

Das Folgende ist beispielsweise der Attributteil der Nutzdaten für Vorbehalt pc:70, der mit Police pc:62 verknüpft ist:

GET /policy/v1/policies/pc:62/contingencies/pc:70

{
  ...
        "attributes": {
            "action": {
                "code": "ChangeRetroactively",
                "name": "Change policy retroactively"
            },
            "actionStartDate": "2021-11-04T00:00:00.000Z",
            "actionStarted": false,
            "createDate": "2021-11-04T23:26:33.069Z",
            "createUser": {
                "displayName": "Alice Applegate",
                "id": "pc:S8PjyiRN14A1u20zgJ76k",
                "type": "User",
                "uri": "/admin/v1/users/pc:S8PjyiRN14A1u20zgJ76k"
            },
            "description": "Driving record required for 
                            good driver discount",
            "dueDate": "2021-11-11T00:00:00.000Z",
            "id": "pc:111",
            "status": {
                "code": "Pending",
                "name": "Pending"
            },
            "title": "Driving record required"
        },
  ...

Abfragen zugehöriger Informationen

Verwenden Sie die folgenden Endpunkte, um Informationen über Aktivitäten, Dokumente und Notizen abzurufen, die mit vorhandenen Vorbehalten verbunden sind.

Mit Jobs verknüpfte Vorbehalte

Endpunkt Beschreibung
GET /jobs​/{jobId}​/contingencies​/{contingencyId}​/activities Abrufen der gegebenen Aktivität, die mit dem gegebenen Vorbehalt für den gegebenen Job verknüpft ist.
GET /jobs​/{jobId}​/contingencies​/{contingencyId}​/documents Abrufen des gegebenen Dokuments, das mit dem gegebenen Vorbehalt für den gegebenen Job verknüpft ist.
GET /jobs​/{jobId}​/contingencies​/{contingencyId}​/notes Abrufen der gegebenen Notiz, die mit dem gegebenen Vorbehalt für den gegebenen Job verknüpft ist.

Mit Policen verbundene Vorbehalte

Endpunkt Beschreibung
GET /policies​/{policyId}​/contingencies​/{contingencyId}​/activities Abrufen der gegebenen Aktivität, die mit dem gegebenen Vorbehalt für die gegebene Police verknüpft ist.
GET /policies​/{policyId}​/contingencies​/{contingencyId}​/documents Abrufen des gegebenen Dokuments, das mit dem gegebenen Vorbehalt für die gegebene Police verknüpft ist.
GET /policies​/{policyId}​/contingencies​/{contingencyId}​/notes Abrufen der gegebenen Notiz, die mit dem gegebenen Vorbehalt für die gegebene Police verknüpft ist.

Aktivitäten, Dokumente und Notizen verwenden dasselbe Schema, unabhängig davon, ob sie primär mit Konto, Jobs, Policen oder Vorbehalten verknüpft sind.

Weitere Informationen zum Arbeiten mit Aktivitäten, Dokumenten oder Notizen finden Sie unter: