productselector/getcompanies

Liefert Ihnen eine Liste der Versicherungsunternehmen, die bewertete Tarife eines Produkttyps besitzen sowie die interne ID von Franke und Bornberg.

Request

Endpoint: POST https://v7.fb-vertragscheck.fb-preview.de/external/productselector/getcompanies

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productselector/getcompanies/request/schema


property default description options
[ token ] * required
string
Token zur Authentifizierung mit der Schnittstelle
[ producttype ] * required
string
Kurzform des Produkttyps (über Schnittstelle "/getproducttypes" zu erhalten)
[ latest_companies ]
integer
Optionale Einschränkung der Versicherer

0: keine aktuellen Gesellschaften
1: nur aktuelle Gesellschaften
Value Label
0 keine aktuellen Gesellschaften
1 nur aktuelle Gesellschaften
[ add_company_relations ]
bool
false
Ermöglicht das Ergänzen von Beziehungen zwischen den Versicherern (z.B. Fusionen)
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_BU",
    "latest_companies": "1",
    "add_company_relations": true
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_BU"
}

Response

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productselector/getcompanies/response/schema


property description options
[ status ] * required
string
Status des Aufrufs
OK: Anfrage erfolgreich
ERROR: Anfrage verlief fehlerhaft
[ errors ]
array
Aufgetretene Fehler (Wird nur bei "status: ERROR" gefüllt!

array
Gesellschaften zur Filterung in anderen Schnittstellen
property description options
companies[ value ]
int
ID der Gesellschaft
companies[ label ]
string
Name der Gesellschaft

array
Beziehungen zwischen den Versicherern (Nur wenn add_company_relation: true)
property description options
relations[ source_company_id ]
integer
Gesellschaft ID
relations[ target_company_id ]
integer
Ziel Gesellschaft ID
relations[ target_company_name ]
string
Name der Zielgesellschaft
relations[ relation_type ]
string
Art der Beziehung
Value Label
fusion Fusionierung
relations[ valid_from ]
string
Zeitpunkt ab Gültigkeit der Beziehung
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie einen gültigen Produkttypen ein."
    ],
    "companies": [
        {
            "value": "123",
            "label": "Pfefferminzia",
            "relations": [
                {
                    "source_company_id": 123,
                    "target_company_id": 456,
                    "target_company_name": "Pfefferminzia",
                    "relation_type": "fusion",
                    "valid_from": "2015-08-08 00:00:00"
                }
            ]
        }
    ]
}