productselector/getproducts

productselector_getproducts_description

Request

Endpoint: GET https://v7.fb-vertragscheck.fb-preview.de/external/productselector/getproducts

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productselector/getproducts/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 ] * required
string
Jahr des Produktstandes (Über Schnittstelle "/getyears" zu erhalten)
example:

mime-type: application/json, text/json

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

mime-type: application/json, text/json

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

Response

Schema: GET https://v7.fb-vertragscheck.fb-preview.de/external/productselector/getproducts/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
Liste der Hauptprodukte mit der zugehörigen ID
property description options
products[ 0 ]
raw
products[ 1 ]
raw
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültiges Profil ein."
    ],
    "products": [
        "",
        ""
    ]
}