Übersicht

Toolnutzung

Toolnutzung: Prämienberechnung

Toolnutzung: Dokumentenerstellung

archive/list

Liefert eine Liste der gültigen gespeicherten Archive zur Referenz-Id eines Kunden.

Request

Endpoint: POST https://bankathon.fb-xpert.fb-preview.de/external/archive/list

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/archive/list/request/schema


property default description options
[ token ] * required
string
Ein gültiger Token für die Autentifizierung mit der Schnittstelle.
[ referenz_id ] * required
string
Fremd-Id des Kunden
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "referenz_id": "abc123"
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "referenz_id": "abc123"
}

Response

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/archive/list/response/schema


property description options
[ status ] * required
string
Status des Aufrufs
OK: Anfrage erfolgreich
ERROR: Anfrage verlief fehlerhaft

array
Liste der gültigen gespeicherten Archive zur übergebenen Referenz-Id des Kunden
property description options
archives[ application ]
string
Name des Tools in dem das Archiv erstellt wurde
Value Label
fbmyview fb-myview
fbcool fb-xpert
archives[ scope ]
string
Scope in dem das Archiv erstellt wurde
archives[ name ]
string
Name für das Archiv
archives[ description ]
string
Beschreibung für das Archiv
archives[ transaction_id ]
string
Vorgangs-Id
archives[ created ]
date
Datum und Uhrzeit, wann das Archiv erstellt wurde
archives[ expired ]
date
Datum und Uhrzeit, bis wann das Archiv gültig ist
archives[ company_name ]
Gesellschaftsname
archives[ detail_name ]
Tarifname

array
Enthält die zuletzt ausgewählten Tarife
property description options
product_cart[ tarif_id ]
string
Tarif-Id
product_cart[ company ]
string
Gesellschaftsname
product_cart[ product ]
string
Name des Produktes
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "archives": [
        {
            "application": "fbcool",
            "scope": "phv",
            "name": "Mein Archiv für Kunde X",
            "description": "Meine Archivbeschreibung für Kunde X",
            "transaction_id": "123456789abcdefg",
            "created": "2025-01-01 12:01:00",
            "expired": "2026-01-01 00:00:00",
            "product_cart": [
                {
                    "tarif_id": "12345-67890",
                    "company": "Pfefferminzia GmbH",
                    "product": "SBU, Stand 01.2016"
                }
            ]
        }
    ]
}