Name API - Vornamen vorschlagen
Verwenden Sie diesen Endpunkt, um basierend auf der Nutzereingabe Vornamen vorzuschlagen.
Verwandte Name-Dokumentation - Für eine Serviceübersicht siehe Name API — Einführung →
Für Nachnamenvorschläge siehe Name API — Nachnamensvalidierung →
Für Nachnamenvorschläge siehe Name API — Nachnamensvalidierung →
/FIRSTNAMESUGGEST/
Request
Sowohl GET als auch POST werden unterstützt.
{SERVER_ADDRESS} und {LICENCE_CODE} werden von DQE bei der Kontoerstellung bereitgestellt. Wenden Sie sich an Ihren DQE-Kundenbetreuer, um diese Zugangsdaten zu erhalten.
GEThttps://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname={FIRST_NAME}&Gender={GENDER}&NBResponse={NUM}&Licence={LICENCE_CODE}&Country={COUNTRY_CODE}&Format={FORMAT}&Verifname=Y
Codebeispiele
Vornamenvorschlag
curl "https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname=Ali&Gender=F&NBResponse=10&Country=FRA&Format=0&Licence={LICENCE_CODE}"
fetch("https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?" + new URLSearchParams({
Firstname: "Ali",
Gender: "F",
NBResponse: "10",
Country: "FRA",
Format: "0",
Licence: "{LICENCE_CODE}"
}))
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.get(
"https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/",
params={
"Firstname": "Ali",
"Gender": "F",
"NBResponse": "10",
"Country": "FRA",
"Format": "0",
"Licence": "{LICENCE_CODE}",
},
)
print(response.json())
<?php
$params = http_build_query([
'Firstname' => 'Ali',
'Gender' => 'F',
'NBResponse' => '10',
'Country' => 'FRA',
'Format' => '0',
'Licence' => '{LICENCE_CODE}',
]);
$ch = curl_init("https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?{$params}");
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
axios.get('https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/', {
params: {
Firstname: 'Ali',
Gender: 'F',
NBResponse: '10',
Country: 'FRA',
Format: '0',
Licence: '{LICENCE_CODE}'
}
})
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String url = "https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/"
+ "?Firstname=Ali&Gender=F&NBResponse=10&Country=FRA&Format=0&Licence={LICENCE_CODE}";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create(url))
.GET()
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var url = "https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/" +
"?Firstname=Ali&Gender=F&NBResponse=10&Country=FRA&Format=0&Licence={LICENCE_CODE}";
var response = await client.GetAsync(url);
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
)
func main() {
url := "https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/" +
"?Firstname=Ali&Gender=F&NBResponse=10&Country=FRA&Format=0&Licence={LICENCE_CODE}"
resp, err := http.Get(url)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
POSThttps://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/
Senden Sie alle Parameter im Anfragetext mittels Content-Type: application/x-www-form-urlencoded. Die Serveradresse bleibt in der URL.
Codebeispiele
Vornamenvorschlag
curl -X POST "https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/" \
-H "Content-Type: application/x-www-form-urlencoded" \
-d "Licence={LICENCE_CODE}" \
-d "Firstname=Ali" \
-d "Gender=F" \
-d "NBResponse=10" \
-d "Country=FRA" \
-d "Format=0"
fetch("https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/", {
method: "POST",
headers: { "Content-Type": "application/x-www-form-urlencoded" },
body: new URLSearchParams({
Licence: "{LICENCE_CODE}",
Firstname: "Ali",
Gender: "F",
NBResponse: "10",
Country: "FRA",
Format: "0"
})
})
.then(r => r.json())
.then(data => console.log(data));
import requests
response = requests.post(
"https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/",
data={
"Licence": "{LICENCE_CODE}",
"Firstname": "Ali",
"Gender": "F",
"NBResponse": "10",
"Country": "FRA",
"Format": "0",
},
)
print(response.json())
<?php
$ch = curl_init("https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/");
curl_setopt($ch, CURLOPT_POST, true);
curl_setopt($ch, CURLOPT_POSTFIELDS, http_build_query([
'Licence' => '{LICENCE_CODE}',
'Firstname' => 'Ali',
'Gender' => 'F',
'NBResponse' => '10',
'Country' => 'FRA',
'Format' => '0',
]));
curl_setopt($ch, CURLOPT_RETURNTRANSFER, true);
$response = curl_exec($ch);
curl_close($ch);
$data = json_decode($response, true);
const axios = require('axios');
const qs = require('querystring');
axios.post('https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/', qs.stringify({
Licence: '{LICENCE_CODE}',
Firstname: 'Ali',
Gender: 'F',
NBResponse: '10',
Country: 'FRA',
Format: '0'
}))
.then(response => console.log(response.data));
HttpClient client = HttpClient.newHttpClient();
String form = "Licence={LICENCE_CODE}&Firstname=Ali&Gender=F&NBResponse=10&Country=FRA&Format=0";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/"))
.header("Content-Type", "application/x-www-form-urlencoded")
.POST(HttpRequest.BodyPublishers.ofString(form))
.build();
HttpResponse<String> response = client.send(request, HttpResponse.BodyHandlers.ofString());
System.out.println(response.body());
using var client = new HttpClient();
var form = new Dictionary<string, string> {
["Licence"] = "{LICENCE_CODE}",
["Firstname"] = "Ali",
["Gender"] = "F",
["NBResponse"] = "10",
["Country"] = "FRA",
["Format"] = "0"
};
var response = await client.PostAsync(
"https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/",
new FormUrlEncodedContent(form));
var body = await response.Content.ReadAsStringAsync();
Console.WriteLine(body);
package main
import (
"fmt"
"io"
"net/http"
"net/url"
)
func main() {
form := url.Values{}
form.Set("Licence", "{LICENCE_CODE}")
form.Set("Firstname", "Ali")
form.Set("Gender", "F")
form.Set("NBResponse", "10")
form.Set("Country", "FRA")
form.Set("Format", "0")
resp, err := http.PostForm("https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/", form)
if err != nil {
panic(err)
}
defer resp.Body.Close()
body, _ := io.ReadAll(resp.Body)
fmt.Println(string(body))
}
Parameter
| Parameter | Beschreibung | Pflicht / Optional |
|---|---|---|
| Licence | Ihrem Konto zugewiesener Lizenzcode. | Pflicht |
| Firstname | Der vom Nutzer bereits eingegebene Teil des Vornamens. | Pflicht |
| Gender |
M, F oder I. |
Optional |
| NBResponse | Maximale Anzahl der zurückzugebenden Vorschläge. Standardwert: 10. |
Optional |
| Country | ISO-3-Buchstaben-Ländercode zur Priorisierung der Vorschläge. | Optional |
| Format | Gewünschtes Ausgabeformat. Standardwert: 0. |
Optional |
| Verifname | Prüft, ob der Vorname existiert, ohne Autovervollständigung (Y übergeben). |
Optional |
Formatwerte
| Format | Beschreibung |
|---|---|
0 |
Vorname in Großbuchstaben ohne Akzente. |
1 |
Erster Buchstabe groß, ohne Akzente. |
2 |
Vorname in Kleinbuchstaben ohne Akzente. |
3 |
Vorname in Großbuchstaben mit Akzenten. |
4 |
Erster Buchstabe groß, mit Akzenten. |
5 |
Vorname in Kleinbuchstaben mit Akzenten. |
Antwort
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 | Mögliche Werte | Beschreibung | Typ |
|---|---|---|---|
| suggest[X][0] |
F, M, I
|
Geschlecht des vorgeschlagenen Vornamens — F: weiblich, M: männlich, I: unbekannt. |
STRING(1) |
| suggest[X][1] | — | Vorgeschlagener Vorname. | STRING(255) |
Antwortbeispiel
{
"suggest": [
["F", "ALICE"],
["F", "ALICE-ANNE"],
["F", "ALICE-MARIE"]
]
}
Fehler
| Fehlertyp | Beispielanfrage | Antworttext |
|---|---|---|
Fehlender, leerer oder falscher Parameter Licence
|
https://{SERVER_ADDRESS}/FIRSTNAMESUGGEST/?Firstname=Ali&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=Ali&Gender=F&NBResponse=10&Licence={LICENCE_CODE} |
{"suggest": []} |
API testen
Klicken Sie auf die Schaltfläche unten, um diesen Endpunkt live in Ihrem Browser zu testen.
Konsole öffnen
Siehe auch
Verknüpfung mit