profession/validate

Führt eine Validierung der einer Gesellschaft zugeordneten Berufe durch.

Request

Endpoint: POST https://bankathon.fb-xpert.fb-preview.de/external/profession/validate

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/profession/validate/request/schema

Validation: POST https://bankathon.fb-xpert.fb-preview.de/external/profession/validate/validate


property default description options
[ token ] * required
string
Ein gültiger Token für die Authentifizierung mit der Schnittstelle.
* required
array
property default description options
company_professions[ company_id ] * required
int
Gesellschafts-ID
company_professions[ designation ] * required
string
Suchbegriff
[ gender ]
string
Geschlecht
Value Label
male männlich
female weiblich
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "company_professions": [
        {
            "company_id": 1001,
            "designation": "Fachinformatiker für Anwendungsentwicklung"
        }
    ],
    "gender": "female"
}
example:

mime-type: application/json, text/json

{
    "token": "a1s2d3f4g5h6j7k8l9",
    "company_professions": [
        {
            "company_id": 1001,
            "designation": "Fachinformatiker für Anwendungsentwicklung"
        }
    ]
}

Response

Schema: GET https://bankathon.fb-xpert.fb-preview.de/external/profession/validate/response/schema


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

object[]
Ergebnis der Validierung
property description options
results[ company_id ] * required
int
ID der Gesellschaft
results[ designation ] * required
string
genaue Berufsbezeichnung nach der Gesucht wurde
results[ is_valid_profession ]
Zeigt an, ob Berufezuordnung valide ist.
results[ is_valid ] * required
bool
Zeigt an, ob der Beruf für eine Gesellschaft hinterlegt ist
example:

mime-type: application/json, text/json

{
    "status": "OK",
    "errors": [
        "Bitte geben Sie eine gültige Telefonnummer ein."
    ],
    "results": [
        {
            "company_id": 12345,
            "designation": "Fachinformatiker Anwendungsentwicklung",
            "is_valid": true
        }
    ]
}