Našeptávač adres

Význam a použití

Poskytuje tzv. „našeptávání“ (autocomplete) adres uživatelům či aplikacím. Když uživatel začne do formuláře psát (např. název ulice, město, PSČ atd.), metoda vrací seznam možných relevantních adres či jejich částí. Používá se především k:

Urychlení zadávání adres při vytváření zásilky.

Zajištění správnosti (validity) a formátu adresy před jejím odesláním do systému PPL.

Minimalizace chyb při ručním psaní adres.

Request

Query Params

Street

string

optional

Ulice

ZipCode

string

optional

PSČ

City

string

optional

Město

CalledFrom

enum<string>

optional

Našeptávání z Ulice/PSČ/Město

Allowed values:

StreetZipCodeCity

Header Params

Accept-Language

string

optional

Language specification, default language: cs-CZ

X-Correlation-ID

string

optional

Correlation Id of request

X-LogLevel

enum<string>

optional

The forced log level

Allowed values:

TraceDebugInformationWarningErrorCritical

Request samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

Responses

🟢200OK

application/json

Success

Headers

X-Correlation-ID

string

optional

Correlation Id of request otherwise id of response

Body

array of:

city

string | null

optional

Město

place

string | null

optional

Místo

street

string | null

optional

Ulice

houseNumber

string | null

optional

Číslo domu

referenceNumber

string | null

optional

referenceNumberChar

string | null

optional

evidenceNumber

boolean

optional

Označ true pokud je číslo domu podtypem evidenčního čísla

zipCode

string | null

optional

PSČ

admCode

string | null

optional

valid

boolean

read-onlyoptional

Validní adresa

fullStreet

string | null

read-onlyoptional

Adresa ulice

Example

[
  {
    "city": "string",
    "place": "string",
    "street": "string",
    "houseNumber": "string",
    "referenceNumber": "string",
    "referenceNumberChar": "string",
    "evidenceNumber": true,
    "zipCode": "string",
    "admCode": "string",
    "valid": true,
    "fullStreet": "string"
  }
]

🔵304304

🟠400Bad Request

🟠405405

🔴500Server Error

🔴503Service Unavailable

Našeptávač adres

Význam a použití#

Request

Request samples

Responses

Význam a použití