CityDate API — Einen Geburtsort per Postleitzahl finden

Support DQE
Support DQE
  • Aktualisiert

Der Endpunkt BirthLocality ruft französische Orte ab, die zu einem bestimmten Datum einem Suchbegriff entsprechen.

Verwandte CityDate-Dokumentation:

GET-Anfrage

Endpunkt

https://{SERVER_ADDRESS}/BirthLocality/?BirthDate={DATE}&Search={LOOKUP}&Licence={LICENCE_CODE}&NbMax={NB_MAX}

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

Parameter Wert Beschreibung Pflicht/Optional
SERVER_ADDRESS {SERVER_ADDRESS} Adresse des DQE-Servers, der die Daten verarbeitet. Pflicht
Licence {LICENCE_CODE} Ihrem Konto zugewiesener Lizenzcode. Pflicht
BirthDate {DATE} Datum im Format YYYY-MM-DD. Pflicht
Search {LOOKUP} Suchfeld unter Verwendung von Ortsbezeichnung oder INSEE-Code. Pflicht
NbMax {NB_MAX} Maximale Anzahl der von der API zurückgegebenen Ergebnisse. Optional. Standardwert: 20.

POST-Anfrage

Endpunkt

https://{SERVER_ADDRESS}/BirthLocality/

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
BirthDate {DATE} Datum im Format YYYY-MM-DD. Pflicht
Search {LOOKUP} Suchfeld unter Verwendung von Ortsbezeichnung oder INSEE-Code. Pflicht
NbMax {NB_MAX} Maximale Anzahl der von der API zurückgegebenen Ergebnisse. Optional. Standardwert: 20.

Antwort

Erfolgsantwort

Schlüssel Beschreibung Typ
Found Gesamtanzahl der gefundenen Ergebnisse. INTEGER
Results Liste der zurückgegebenen Orte. ARRAY
Results.City Ortsname. STRING(50)
Results.CountyCode Landkreis- oder Departement-Code. STRING(2)
Results.CountyLabel Landkreis- oder Departement-Bezeichnung. STRING(50)
Results.CountryCode Länder- oder DROM-Code. STRING(2)
Results.CountryLabel Länder- oder DROM-Bezeichnung. STRING(50)
Results.CodeInsee INSEE-Code des Ortes. STRING(5)
Results.ValidityStartDate Beginndatum der Gültigkeit des INSEE-Codes. DATE (YYYY-MM-DD)
Results.ValidityEndDate Enddatum der Gültigkeit des INSEE-Codes. Leer, wenn der Code noch gültig ist. DATE (YYYY-MM-DD) / NULL

Beispiel:

{
  "Found": 3,
  "Results": [
    {
      "City": "AAST",
      "CountyCode": "64",
      "CountyLabel": "PYRENEES-ATLANTIQUES",
      "CodeInsee": "64001",
      "ValidityStartDate": "1943-01-01",
      "ValidityEndDate": ""
    },
    {
      "City": "ABAINVILLE",
      "CountyCode": "55",
      "CountyLabel": "MEUSE",
      "CodeInsee": "55001",
      "ValidityStartDate": "1943-01-01",
      "ValidityEndDate": ""
    }
  ]
}

Siehe auch

Verknüpfung mit

War dieser Beitrag hilfreich?

0 von 0 fanden dies hilfreich