Übersicht

SingleSignOn

Produktauswahlprozess

Abruf von Kriterien

Abruf der Gesamtbewertung

Beste Produkt am Markt

Indikation Produktqualität

Profilermittlung

productsmodular/getratingrangepkfg

Liefert das höchste und niedrigste Rating der Gesellschaft und optional ein bestimmtes Jahr.

Request

Endpoint: GET https://v7.fb-vertragscheck.fb-preview.de/external/productsmodular/getratingrangepkfg

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productsmodular/getratingrangepkfg/request/schema


property default description options
[ token ] * required
string
Token zur Authentifizierung mit der Schnittstelle
[ producttype ] * required
string
Kurzform der Produktart (Über Schnittstelle "/getproducttypes" zu erhalten)
[ company_id ] * required
integer
ID einer Gesellschaft (Über Schnittstelle "/getcompanies" zu erhalten)
[ year ]
string
Jahr des Produktstandes; "current_products" für aktuelle Tarifgeneration, konkrete Jahreszahl oder auslassen für alle Tarife
[ profile ] * required
string
Bewertungsprofil
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_BU",
    "company_id": 1111,
    "year": "2012",
    "profile": "11"
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "producttype": "TYPE_BU",
    "company_id": 1111,
    "profile": "11"
}

Response

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productsmodular/getratingrangepkfg/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
Bewertungsintervall
property description options
ratingrange[ worst_product ]
object
PKFG und Bewertung des Min Wertes
ratingrange[ best_product ]
object
PKFG und Bewertung des Max Wertes
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie einen gültigen Produktbereich ein."
    ],
    "ratingrange": [
        {
            "worst_product": {
                "pkfg": 12345678,
                "percentage": 38
            },
            "best_product": {
                "pkfg": 90123456,
                "percentage": 92
            }
        }
    ]
}