Verwenden Sie diesen Endpunkt, um basierend auf der Nutzereingabe Nachnamen vorzuschlagen.
Verwandte Name-Dokumentation:
GET-Anfrage
Endpunkt
https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lastname={NAME}&NBResponse={NUM}&Licence={LICENCE_CODE}Ersetzen Sie die Werte in geschweiften Klammern durch Ihre eigenen Informationen:
| Parameter | Wert | Beschreibung | Pflicht/Optional |
|---|---|---|---|
| Licence | {LICENCE_CODE} |
Ihrem Konto zugewiesener Lizenzcode. | Pflicht |
| Lastname | {NAME} |
Der vom Nutzer bereits eingegebene Teil des Nachnamens. | Pflicht |
| NBResponse | {NUM} |
Maximale Anzahl der zurückzugebenden Vorschläge. | Optional. Standardwert: 10. |
| Format | {FORMAT} |
Gewünschtes Ausgabeformat. | Optional. Standardwert: 0. |
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}/LASTNAMESUGGEST/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 |
| Lastname | {NAME} |
Der vom Nutzer bereits eingegebene Teil des Nachnamens. | Pflicht |
| NBResponse | {NUM} |
Maximale Anzahl der zurückzugebenden Vorschläge. | Optional. Standardwert: 10. |
| Format | {FORMAT} |
Gewünschtes Ausgabeformat. | Optional. Standardwert: 0. |
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 immer I, der zweite Wert ist der vorgeschlagene Nachname.
| Schlüssel | Beschreibung | Frankreich | International |
|---|---|---|---|
| suggest[X][0] |
I: unbekannt |
STRING(1) | STRING(1) |
| suggest[X][1] | Zugehöriger Nachname. | STRING(255) | STRING(255) |
Beispiel:
{
"suggest": [
["I", "DUPONT"],
["I", "DUPOUY"],
["I", "DUPORT"]
]
}Fehlerantwort
| Fehlertyp | Beispielanfrage | Antworttyp |
|---|---|---|
Fehlender, leerer oder falscher Parameter Licence
|
https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lastname=DUP&NBResponse=10 |
{} |
Fehlender oder leerer Parameter Lastname
|
https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?NBResponse=10&Licence={LICENCE_CODE} |
{"suggest": []} |
| Tippfehler im Parameter | https://{SERVER_ADDRESS}/LASTNAMESUGGEST/?Lasname=DUP&NBResponse=10&Licence={LICENCE_CODE} |
{"suggest": []} |
Siehe auch
Verknüpfung mit