Name API — Vornamensvalidierung

Support DQE
Support DQE
  • Aktualisiert

Verwenden Sie diesen Endpunkt, um basierend auf der Nutzereingabe Vornamen vorzuschlagen.

Verwandte Name-Dokumentation:

GET-Anfrage

Endpunkt

https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname={FIRST_NAME}&Gender={GENDER}&NBResponse={NUM}&Licence={LICENCE_CODE}&Country={COUNTRY_CODE}&Format={FORMAT}&Verifname=Y

Ersetzen Sie die Werte in geschweiften Klammern durch Ihre eigenen Informationen:

Parameter Wert Beschreibung Pflicht/Optional
Licence {LICENCE_CODE} Ihrem Konto zugewiesener Lizenzcode. Pflicht
Firstname {FIRST_NAME} Der vom Nutzer bereits eingegebene Teil des Vornamens. Pflicht
Gender {GENDER} M, F oder I. Optional
NBResponse {NUM} Maximale Anzahl der zurückzugebenden Vorschläge. Optional. Standardwert: 10.
Country {COUNTRY_CODE} ISO-3-Buchstaben-Ländercode zur Priorisierung der Vorschläge. Optional
Format {FORMAT} Gewünschtes Ausgabeformat. Optional. Standardwert: 0.
Verifname Y Prüft, ob der Vorname existiert, ohne Autovervollständigung. Optional

Formatwerte

Format Beschreibung
0 Vorname in Großbuchstaben ohne Akzente.
1 Erster Buchstabe groß, ohne Akzente.
2 Vorname in Kleinbuchstaben ohne Akzente.

POST-Anfrage

Endpunkt

https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/

Fügen Sie die folgenden Parameter im Anfragetext mittels x-www-form-urlencoded hinzu.

Parameter Wert Beschreibung Pflicht/Optional
Licence {LICENCE_CODE} Ihrem Konto zugewiesener Lizenzcode. Pflicht
Firstname {FIRST_NAME} Der vom Nutzer bereits eingegebene Teil des Vornamens. Pflicht
Gender {GENDER} M, F oder I. Optional
NBResponse {NUM} Maximale Anzahl der zurückzugebenden Vorschläge. Optional. Standardwert: 10.
Country {COUNTRY_CODE} ISO-3-Buchstaben-Ländercode zur Priorisierung der Vorschläge. Optional
Format {FORMAT} Gewünschtes Ausgabeformat. Optional. Standardwert: 0.
Verifname Y Prüft, ob der Vorname existiert, ohne Autovervollständigung. Optional

Formatwerte

Format Beschreibung
0 Vorname in Großbuchstaben ohne Akzente.
1 Erster Buchstabe groß, ohne Akzente.
2 Vorname in Kleinbuchstaben ohne Akzente.

Antwort

Erfolgsantwort

Die JSON-Antwort ist ein Dictionary, das den Schlüssel suggest enthält. Sein Wert ist ein Array vorgeschlagener Elemente. Jedes Element ist ein Array aus zwei Zeichenketten: Der erste Wert ist das Geschlecht des Vornamens (M, F oder I), der zweite Wert ist der vorgeschlagene Vorname.

Schlüssel Beschreibung Frankreich International
suggest[X][0] F: weiblich
M: männlich
I: unbekannt		 STRING(1) STRING(1)
suggest[X][1] Zugehöriger Vorname. STRING(255) STRING(255)

Beispiel:

{
  "suggest": [
    ["F", "ALICE"],
    ["F", "ALICE-ANNE"],
    ["F", "ALICE-MARIE"]
  ]
}

Fehlerantwort

Fehlertyp Beispielanfrage Antworttyp
Fehlender, leerer oder falscher Parameter Licence https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname=Laur&Gender=F&NBResponse=10 {}
Fehlender oder leerer Parameter Firstname https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Gender=F&NBResponse=10&Licence={LICENCE_CODE} {"suggest": []}
Tippfehler im Parameter https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firtname=Laur&Gender=F&NBResponse=10&Licence={LICENCE_CODE} {"suggest": []}

Siehe auch

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich