Rozšiřování dat Data8
Data8 pomáhá stavět důvěru v data. Ušetříme vám peníze čištěním a rozšiřováním stávajících dat a také zajištěním toho, aby se v okamžiku vstupu dostaly pouze ty nejvýkonnější údaje, takže se můžete soustředit na cílení a komunikaci se správnými zákazníky.
Tento konektor je dostupný v následujících produktech a oblastech:
| Service | Class | Regions |
|---|---|---|
| Copilot Studio | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Logic Apps | Standard | Všechny oblasti Logic Apps s výjimkou následujících: – Oblasti Azure Government – Oblasti Azure China - Ministerstvo obrany USA (DoD) |
| Power Apps | Premium | Všechny oblasti Power Apps s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Power Automate | Premium | Všechny oblasti Power Automate s výjimkou následujících: – státní správa USA (GCC) – státní správa USA (GCC High) - China Cloud provozovaný společností 21Vianet - Ministerstvo obrany USA (DoD) |
| Kontakt | |
|---|---|
| Název | Technická helpdesk |
| URL | https://www.data-8.co.uk |
| helpdesk@data-8.co.uk |
| Metadata konektoru | |
|---|---|
| Vydavatel | Data8 Limited |
| Internetová stránka | https://www.data-8.co.uk |
| Zásady ochrany osobních údajů | https://www.data-8.co.uk/privacy-policy/ |
| Kategorie | Umělá inteligence; Internetová stránka |
Rozšiřování dat Data8 nabízí řadu akcí, které umožňují kontrolu kvality dat – zajištění, aby všechna data zadaná v systému byla skutečná, platná, aktuální a fungovala podle potřeby. Ve světě AI & Copilot jsou data jádrem a Data8 pomáhá maximalizovat využití vašeho nejhodnotnějšího majetku.
Požadavky
- Účet Data8 s kredity pro každou akci
- Klíč rozhraní API vygenerovaný z účtu Data8
Jak získat přihlašovací údaje
Jakmile máte účet Data8, můžete získat klíč rozhraní API z řídicího panelu Data8.
Začínáme s konektorem
Všechny akce Data8 pocházejí přímo z rozhraní API Data8 – podívejte se na příslušnou stránku dokumentace pro každý koncový bod a na to, jak funguje . https://www.data-8.co.uk/resources/api-reference/
Běžné chyby a nápravné prostředky
Tým podpory Data8 je vždy k dispozici, aby vám pomohl v případě jakýchkoli problémů – helpdesk@data-8.co.uk
Vytvoření připojení
Konektor podporuje následující typy ověřování:
| výchozí | Parametry pro vytvoření připojení | Všechny oblasti | Sdíletelný |
Výchozí
Použitelné: Všechny oblasti
Parametry pro vytvoření připojení
Toto připojení je možné sdílet. Pokud se power app sdílí s jiným uživatelem, sdílí se i připojení. Další informace najdete v přehledu konektorů pro aplikace plátna – Power Apps | Microsoft Docs
| Název | Typ | Description | Povinné |
|---|---|---|---|
| Klíč rozhraní API | securestring | Klíč rozhraní API pro toto rozhraní API | Pravdivé |
Limity omezování
| Name | Volání | Období obnovení |
|---|---|---|
| Volání rozhraní API na připojení | 100 | 60 sekund |
Akce
| Kontrola CTPS |
Zkontroluje, jestli je telefonní číslo zaregistrované na CTPS nebo ne. |
| Kontrola použitelného názvu |
Zkontrolujte, ověřte a ověřte, jestli je zadaný název pravděpodobně skutečný a použitelný nebo jestli je nepoužitelný, nepoužitelný, náhodný nebo prázdný. |
| Kontrola tps |
Zkontroluje, jestli je telefonní číslo zaregistrované na čipu TPS nebo ne. |
| Ověření e-mailové adresy |
Zkontrolujte, ověřte a ověřte, jestli je e-mailová adresa platná, skutečná a jestli by se e-mail odeslal. Funguje jako služba pro ověření e-mailu v reálném čase. |
| Ověření informací o bankovním účtu |
Zkontrolujte, jestli je platný kód řazení a číslo bankovního účtu. |
| Ověření telefonního čísla (zastaralé) |
Zkontroluje, jestli je zadaná e-mailová adresa platná pro příjem e-mailů – tato adresa je pro PhoneValidation zastaralá. |
| Ověřit telefonní číslo |
Zkontroluje, jestli je telefonní číslo platné pro příjem telefonního hovoru. Zkontroluje aktuální stav telefonní linky v reálném čase a vrátí odpověď. |
|
Predictive |
DrillDown s rozhraním DATA8 PredictiveAddress API – Přechod k podrobnostem o výsledcích hledání |
|
Predictive |
Načtení pomocí rozhraní DATA8 PredictiveAddress API – Načtení celé adresy |
|
Predictive |
Vyhledávání pomocí rozhraní DATA8 PredictiveAddress API – Vyhledejte částečnou adresu v mnoha zdrojích dat. |
| Vyčištění e-mailu |
Vyčistěte e-mailovou adresu, ověřte ji, abyste zjistili, jestli se jedná o skutečný, pravý e-mail, ale také další podrobnosti, jako je jméno nebo název společnosti, aby se dále obohatila. |
| Zemřel(a) |
Spojené království - Identifikovat zemřelé jednotlivce rychle a snadno, pomocí důvěryhodných zdrojů aktualizovaných pravidelně. |
| Získat úplnou adresu |
Vyhledá adresy na základě vstupních dat, jako je číslo budovy a psč. |
| Čistá adresa |
Formátuje, ověřuje a opravuje danou adresu na celou formátovanou adresu. |
Kontrola CTPS
Zkontroluje, jestli je telefonní číslo zaregistrované na CTPS nebo ne.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Telefonní číslo
|
number | True | string |
Telefonní číslo, které chcete zkontrolovat CTPS |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Příznak určující, jestli požadavek na Data8 proběhl úspěšně bez ohledu na výsledek |
|
Zpráva o chybě
|
Status.ErrorMessage | string |
Vrácená chybová zpráva, pokud existuje |
|
Zbývající kredity
|
Status.CreditsRemaining | float |
Zbývající kredity Data8 pro volanou službu |
|
Je možné volat
|
Callable | boolean |
Vrátí logickou hodnotu, která vás informuje, jestli je volatelná. Pokud je hodnota false, číslo je aktuálně na CTPS. |
|
Telefonní číslo
|
TelephoneNumber | string |
Pokud je toto číslo vyplněné, je telefonní číslo možné a má hodnotu null, pokud ne. |
Kontrola použitelného názvu
Zkontrolujte, ověřte a ověřte, jestli je zadaný název pravděpodobně skutečný a použitelný nebo jestli je nepoužitelný, nepoužitelný, náhodný nebo prázdný.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Title
|
Title | string |
Název názvu |
|
|
Křestní jméno
|
Forename | string |
Křestní jméno celého jména |
|
|
Druhé jméno
|
MiddleName | string |
Prostřední název celého jména |
|
|
Příjmení
|
Surname | string |
Příjmení celého jména |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Příznak určující, jestli požadavek na Data8 proběhl úspěšně bez ohledu na výsledek |
|
Zpráva o chybě
|
Status.ErrorMessage | string |
Vrácená chybová zpráva, pokud existuje |
|
Zbývající kredity
|
Status.CreditsRemaining | float |
Zbývající kredity Data8 pro volanou službu |
|
Result
|
Result | string |
Prázdná hodnota označuje název jako použitelný název. Pokud se vrátí hodnota, bude to jedna z následujících hodnot: "IncompleteName", "RandomName" nebo "SalaciousName" |
Kontrola tps
Zkontroluje, jestli je telefonní číslo zaregistrované na čipu TPS nebo ne.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Telefonní číslo
|
number | True | string |
Telefonní číslo, které chcete zkontrolovat pomocí čipu TPS |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Příznak určující, jestli požadavek na Data8 proběhl úspěšně bez ohledu na výsledek |
|
Zpráva o chybě
|
Status.ErrorMessage | string |
Vrácená chybová zpráva, pokud existuje |
|
Zbývající kredity
|
Status.CreditsRemaining | float |
Zbývající kredity Data8 pro volanou službu |
|
Je možné volat
|
Callable | boolean |
Vrátí logickou hodnotu, která vás informuje, jestli je volatelná. Pokud je hodnota false, číslo je aktuálně na čipu TPS. |
|
Telefonní číslo
|
TelephoneNumber | string |
Vrátí telefonní číslo, pokud je možné volat, null, pokud ne. |
Ověření e-mailové adresy
Zkontrolujte, ověřte a ověřte, jestli je e-mailová adresa platná, skutečná a jestli by se e-mail odeslal. Funguje jako služba pro ověření e-mailu v reálném čase.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
E-mailová adresa
|
True | string |
E-mailová adresa, kterou chcete ověřit |
|
|
Úroveň ověření
|
level | True | string |
Úroveň, na kterou chcete ověřit. Pokud si nejste jistí, výchozí hodnota je Server |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Příznak určující, jestli požadavek na Data8 proběhl úspěšně bez ohledu na výsledek |
|
Zpráva o chybě
|
Status.ErrorMessage | string |
Vrácená chybová zpráva, pokud existuje |
|
Zbývající kredity
|
Status.CreditsRemaining | float |
Zbývající kredity Data8 pro volanou službu |
|
Result
|
Result | string |
Obsahuje stavový kód označující, jestli je možné ověřit e-mailovou adresu. Další informace o možném stavovém kódu najdete v tématu https://www.data-8.co.uk/resources/support/service-documentation/email-validation/reference/isvalid |
Ověření informací o bankovním účtu
Zkontrolujte, jestli je platný kód řazení a číslo bankovního účtu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Seřadit kód
|
sortCode | True | string |
Kód řazení, který chcete ověřit |
|
Číslo bankovního účtu
|
bankAccountNumber | string |
Číslo bankovního účtu, které chcete ověřit |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Příznak určující, jestli požadavek na Data8 proběhl úspěšně bez ohledu na výsledek |
|
Zpráva o chybě
|
Status.ErrorMessage | string |
Vrácená chybová zpráva, pokud existuje |
|
Zbývající kredity
|
Status.CreditsRemaining | float |
Zbývající kredity Data8 pro volanou službu |
|
Platné
|
Valid | string |
Označuje, jestli je možné ověřit příchozí kód řazení a číslo bankovního účtu. |
|
Seřadit kód
|
SortCode | string |
Kód řazení, který byl ověřen. |
|
Číslo účtu
|
AccountNumber | string |
Číslo účtu, které bylo ověřeno. |
|
Kód BIC
|
BICCode | string |
Kód BIC bankovní větve označené kódem řazení. |
|
IBAN
|
IBAN | string |
Kód IBAN bankovního účtu označeného kódem řazení a číslem účtu. |
|
Název větve
|
BranchName | string |
Název pobočky banky označený kódem řazení. |
|
Krátký název banky
|
ShortBankName | string |
Krátký název banky označené kódem řazení. |
|
Úplný název banky
|
FullBankName | string |
Úplný název banky označené kódem řazení. |
|
Řádky
|
Address.Address.Lines | array of string |
Řádky |
|
Přijímá platby BACS
|
AcceptsBACSPayments | boolean |
Označuje, jestli bankovní pobočka může přijímat platby provedené prostřednictvím systému BACS. |
|
Přijímá inkasní transakce.
|
AcceptsDirectDebitTransactions | boolean |
Určuje, jestli bankovní pobočka může přijímat inkasní platby. |
|
Přijímá transakce s přímým kreditem.
|
AcceptsDirectCreditTransactions | boolean |
Označuje, jestli bankovní pobočka může přijímat přímé kreditní platby. |
|
Přijímá nezaplacené transakce deklarací šeků.
|
AcceptsUnpaidChequeClaimTransactions | boolean |
Označuje, jestli bankovní pobočka může přijímat nároky na nezaplacené šeky. |
|
Přijímá kreditní transakce stavební společnosti.
|
AcceptsBuildingSocietyCreditTransactions | boolean |
Označuje, zda bankovní pobočka může přijímat kredity od stavebních společností. |
|
Přijímá platební transakce dividendového úroku.
|
AcceptsDividendInterestPaymentTransactions | boolean |
Určuje, jestli bankovní pobočka může přijímat výplaty dividendového úroku. |
|
Přijímá transakce inkasních instrukcí.
|
AcceptsDirectDebitInstructionTransactions | boolean |
Určuje, jestli bankovní pobočka může přijímat pokyny k inkasu. |
|
Přijímá platby CHAPS.
|
AcceptsCHAPSPayments | boolean |
Určuje, jestli bankovní pobočka může přijímat platby provedené prostřednictvím systému CHAPS. |
|
Přijímá šeky.
|
AcceptsCheques | boolean |
Označuje, jestli bankovní pobočka může přijímat platby provedené šekem. |
|
Přijímá rychlejší platby
|
AcceptsFasterPayments | boolean |
Označuje, jestli bankovní pobočka může přijímat rychlejší platby. |
Ověření telefonního čísla (zastaralé)
Zkontroluje, jestli je zadaná e-mailová adresa platná pro příjem e-mailů – tato adresa je pro PhoneValidation zastaralá.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Telefonní číslo
|
telephoneNumber | True | string |
Číslo, které chcete ověřit |
|
Výchozí kód země
|
defaultCountry | True | string |
Formátováno jako čísla, tj. 44 pro Spojené království |
|
Použít ověření řádku
|
UseLineValidation | boolean |
Pokud je nastavena hodnota true, bude služba používat Data8 LandlineValidation na libovolném čísle, které uznává jako číslo pevné linky Spojené království a InternationalTelephoneValidation na všech ostatních číslech. Všechna ověřovací volání budou inkasována buď kredit InternationalTelephoneValidation, nebo kredit LandlineValidation odpovídajícím způsobem, takže před použitím této možnosti se ujistěte, že máte k dispozici kredity LandlineValidation. Ve výchozím nastavení je tato možnost false. |
|
|
Použít mobilní ověřování
|
UseMobileValidation | boolean |
Pokud je nastavena hodnota true, služba použije Data8 MobileValidation na libovolném čísle, které uznává jako mobilní číslo a InternationalTelephoneValidation na všech ostatních číslech. Všechna ověřovací volání budou inkasována buď kreditem InternationalTelephoneValidation, nebo kreditem MobileValidation odpovídajícím způsobem, takže před použitím této možnosti se ujistěte, že máte k dispozici kredity MobileValidation. Ve výchozím nastavení je tato možnost false. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Příznak určující, jestli požadavek na Data8 proběhl úspěšně bez ohledu na výsledek |
|
Zpráva o chybě
|
Status.ErrorMessage | string |
Vrácená chybová zpráva, pokud existuje |
|
Zbývající kredity
|
Status.CreditsRemaining | float |
Zbývající kredity Data8 pro volanou službu |
|
Telefonní číslo
|
Result.TelephoneNumber | string |
Zadané telefonní číslo naformátované |
|
Výsledek ověření
|
Result.ValidationResult | string |
Jednoduchý výsledek ověření telefonního čísla |
|
Úroveň ověření
|
Result.ValidationLevel | string |
Úroveň ověření byla nalezena pro telefonní číslo. |
|
Typ čísla
|
Result.NumberType | string |
Určuje typ zadaného čísla, tj. pevné linky nebo mobilní zařízení. |
|
Umístění
|
Result.Location | string |
Aktuální umístění telefonního čísla, pokud je k dispozici |
|
Provider
|
Result.Provider | string |
Poskytovatel sítě telefonního čísla |
|
Kód země
|
Result.CountryCode | string |
Kód ISO2 země telefonního čísla |
|
Název země
|
Result.CountryName | string |
Název země telefonního čísla |
Ověřit telefonní číslo
Zkontroluje, jestli je telefonní číslo platné pro příjem telefonního hovoru. Zkontroluje aktuální stav telefonní linky v reálném čase a vrátí odpověď.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Telefonní číslo
|
telephoneNumber | True | string |
Číslo, které chcete ověřit |
|
Výchozí kód země
|
defaultCountry | True | integer |
Kód země ISO 3166-1-Alpha-2 ISO2 pro kontrolu. Pokud tuto hodnotu nezadáte, použijte aktuální uživatele kód ISO 3166-1-Alpha-2. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Příznak určující, jestli požadavek na Data8 proběhl úspěšně bez ohledu na výsledek |
|
Zpráva o chybě
|
Status.ErrorMessage | string |
Vrácená chybová zpráva, pokud existuje |
|
Zbývající kredity
|
Status.CreditsRemaining | float |
Zbývající kredity Data8 pro volanou službu |
|
Telefonní číslo
|
Result.TelephoneNumber | string |
Zadané telefonní číslo naformátované |
|
Výsledek ověření
|
Result.ValidationResult | string |
Jednoduchý výsledek ověření telefonního čísla |
|
Úroveň ověření
|
Result.ValidationLevel | string |
Úroveň ověření byla nalezena pro telefonní číslo. |
|
Typ čísla
|
Result.NumberType | string |
Určuje typ zadaného čísla, tj. pevné linky nebo mobilní zařízení. |
|
Umístění
|
Result.Location | string |
Aktuální umístění telefonního čísla, pokud je k dispozici |
|
Provider
|
Result.Provider | string |
Poskytovatel sítě telefonního čísla |
|
Kód země
|
Result.CountryCode | string |
Kód ISO2 země telefonního čísla |
|
Název země
|
Result.CountryName | string |
Název země telefonního čísla |
PredictiveAddress (Drilldown)
DrillDown s rozhraním DATA8 PredictiveAddress API – Přechod k podrobnostem o výsledcích hledání
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Country
|
country | True | string |
Kód země iso 2 znaků pro vyhledávání, tj. "GB" |
|
identifikační číslo
|
id | True | string |
Vlastnost value z odpovědi předchozích požadavků z metod Search nebo DrillDown by se sem měla zadat. |
|
IncludeMR
|
IncludeMR | boolean |
Do výsledků zahrne adresy z databáze Multiple Residency (vyžaduje další licencování). |
|
|
IncludeNYB
|
IncludeNYB | boolean |
Obsahuje adresy z dosud sestavené databáze ve výsledcích (vyžaduje další licencování). |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Příznak určující, jestli požadavek na Data8 proběhl úspěšně bez ohledu na výsledek |
|
Zpráva o chybě
|
Status.ErrorMessage | string |
Vrácená chybová zpráva, pokud existuje |
|
Zbývající kredity
|
Status.CreditsRemaining | float |
Zbývající kredity Data8 pro volanou službu |
|
Results
|
Results | array of object |
Results |
|
Označení
|
Results.label | string |
Hodnota, která se má uživateli zobrazit. |
|
Hodnota
|
Results.value | string |
Jedinečný identifikátor shody, který lze zadat do koncových bodů DrillDown nebo Retrieve. |
|
Container
|
Results.container | boolean |
Označuje, jestli je tato shoda kontejnerem pro jiné adresy (např. město, ulice atd.). Pokud je tato hodnota pravdivá, měla by se do koncového bodu DrillDownu zadaná hodnota získat podrobnosti o adresách v záznamu kontejneru. Pokud je hodnota false, měla by být zadána do koncového bodu Načíst, aby se získaly úplné podrobnosti o adrese. |
|
Položky
|
Results.items | integer |
Seznam možných shod. |
|
Počet
|
Count | integer |
Počet nalezených shod na základě zadaných informací. |
|
Session ID
|
SessionID | string |
Do odpovědi je také zahrnuté ID relace. To by se mělo zahrnout do všech následných volání koncového bodu vyhledávání. |
PredictiveAddress (retrieve)
Načtení pomocí rozhraní DATA8 PredictiveAddress API – Načtení celé adresy
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Country
|
country | True | string |
Kód země ISO-2, do které adresa patří. |
|
identifikační číslo
|
id | True | string |
Vlastnost value z odpovědi předchozích požadavků z metod Search nebo DrillDown, když vlastnost kontejneru byla false, by se sem měla zadat. |
|
MaxLineLength
|
MaxLineLength | integer |
MaxLineLength |
|
|
MaxLines
|
MaxLines | integer |
MaxLines |
|
|
FixTownCounty
|
FixTownCounty | boolean |
FixTownCounty |
|
|
Oprava kóduPostcode
|
FixPostcode | boolean |
Oprava kóduPostcode |
|
|
Oprava budovy
|
FixBuilding | boolean |
FixBuilding |
|
|
Nežádoucípunctuation
|
UnwantedPunctuation | string |
Nežádoucípunctuation |
|
|
Formatter
|
Formatter | string |
Formatter |
|
|
IncludeUDPRN
|
IncludeUDPRN | boolean |
IncludeUDPRN |
|
|
IncludeUPRN
|
IncludeUPRN | boolean |
IncludeUPRN |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Příznak určující, jestli požadavek na Data8 proběhl úspěšně bez ohledu na výsledek |
|
Zpráva o chybě
|
Status.ErrorMessage | string |
Vrácená chybová zpráva, pokud existuje |
|
Zbývající kredity
|
Status.CreditsRemaining | float |
Zbývající kredity Data8 pro volanou službu |
|
Řádky
|
Result.Address.Lines | array of string |
Řádky |
|
Organizace
|
Result.RawAddress.Organisation | string |
Název společnosti na adrese |
|
Oddělení
|
Result.RawAddress.Department | string |
Oddělení organizace na adrese |
|
Klíč adresy
|
Result.RawAddress.AddressKey | integer |
Kombinuje s OrganizationKey a PostcodeType a poskytuje jedinečný klíč pro tuto adresu. |
|
OrganizationKey
|
Result.RawAddress.OrganisationKey | integer |
Kombinuje s AddressKey a PostcodeType a poskytuje jedinečný klíč pro tuto adresu. Bude 0 pro adresy v domácnosti. |
|
PostcodeType
|
Result.RawAddress.PostcodeType | string |
Označuje, jestli je adresa na "malém uživateli" ("S") nebo "large user" ("L"). Velké poštovní směrovací číslo uživatele je ten, který je přidělen jednotlivým organizacím jako těžký poštovní uživatel, např. DVLA. |
|
BuildingNumber
|
Result.RawAddress.BuildingNumber | integer |
Číslo domu pro adresu. Všimněte si, že se jedná pouze o celé číslo. Čísla budov, například 12A, se zobrazí v poli BuildingName |
|
SubBuildingName
|
Result.RawAddress.SubBuildingName | string |
Název dílčí budovy pro adresu. Obvykle se jedná o číslo bytu nebo bytu. |
|
BuildingName
|
Result.RawAddress.BuildingName | string |
Název budovy. Může obsahovat číselné informace, kde číslo není jednoduché celé číslo. |
|
DependentThoroughfareName
|
Result.RawAddress.DependentThoroughfareName | string |
Název závislého náplavce, tj. menší ulice z větší ulice |
|
DependentThoroughfareDesc
|
Result.RawAddress.DependentThoroughfareDesc | string |
Popisovač ("ulice", "silnice" atd.) závislého náplavce |
|
Název důkladných jízd
|
Result.RawAddress.ThoroughfareName | string |
Název hlavní ulice |
|
Důkladná farmaceutyDesc
|
Result.RawAddress.ThoroughfareDesc | string |
Popisovač hlavní ulice |
|
DoubleDependentLocality
|
Result.RawAddress.DoubleDependentLocality | string |
Název dvojité závislé lokality – lokalita třetí úrovně |
|
DependentLocality
|
Result.RawAddress.DependentLocality | string |
Název závislé lokality – druhá lokalita |
|
Lokalita
|
Result.RawAddress.Locality | string |
Název poštovního města nejvyšší úrovně |
|
PSČ
|
Result.RawAddress.Postcode | string |
Psč ve formátu s pevným 7 znaky |
|
DPS
|
Result.RawAddress.Dps | string |
Přípona 2mísícového bodu doručení, která jedinečně identifikuje adresu v rámci psčového kódu. |
|
PoBox
|
Result.RawAddress.PoBox | string |
Podrobnosti pole nákupní objednávky, pokud je adresa po Boxu adresa |
|
PostalCounty
|
Result.RawAddress.PostalCounty | string |
Název okresu, který by se měl zobrazit v adrese |
|
TraditionalCounty
|
Result.RawAddress.TraditionalCounty | string |
Název okresu, který byl tradičně spojený s adresou, ale nyní není požadován |
|
AdministrativeCounty
|
Result.RawAddress.AdministrativeCounty | string |
Okres, ve které je adresa určená pro administrativní účely, ale není povinná |
|
CountryISO2
|
Result.RawAddress.CountryISO2 | string |
2znakový kód země ISO související s adresou. Tato hodnota není naplněna službou AddressCapture. |
|
UniqueReference
|
Result.RawAddress.UniqueReference | string |
Alternativní jedinečné referenční číslo adresy. Toto je nastaveno na číslo UDPRN adresy zadáním možnosti IncludeUDPRN metodě. |
|
Směřování na východ
|
Result.RawAddress.Location.Easting | integer |
Vzdálenost psčového kódu východ od původu mřížky operačního systému do jihozápadně od Scilly |
|
Sever
|
Result.RawAddress.Location.Northing | integer |
Vzdálenost psčového kódu na sever od původu mřížky operačního systému |
|
GridReference
|
Result.RawAddress.Location.GridReference | string |
Umístění psčového kódu jako 6místného odkazu na mřížku operačního systému |
|
Zeměpisná délka
|
Result.RawAddress.Location.Longitude | float |
Zeměpisná délka psčového kódu vyjádřená v desetinných stupních v datech WGS84 |
|
Zeměpisná šířka
|
Result.RawAddress.Location.Latitude | float |
Zeměpisná šířka psčového kódu vyjádřená v desetinných stupních v datech WGS84 |
|
CountyCode
|
Result.RawAddress.Location.CountyCode | string |
Kód okresu, který by se měl objevit v adrese |
|
Okres
|
Result.RawAddress.Location.County | string |
Název okresu, který by se měl zobrazit v adrese |
|
DistrictCode
|
Result.RawAddress.Location.DistrictCode | string |
Oblastní kód, který by měl být uveden v adrese |
|
Okres
|
Result.RawAddress.Location.District | string |
Oblast, která by se měla objevit v adrese |
|
WardCode
|
Result.RawAddress.Location.WardCode | string |
Referenční kód pro oddělení psč je v |
|
Oddělení
|
Result.RawAddress.Location.Ward | string |
Název volebního sboru je psč v |
|
Country
|
Result.RawAddress.Location.Country | string |
2znakový kód země ISO související s adresou. |
|
Další data
|
Result.RawAddress.AdditionalData | string |
Vrácené další údaje |
PredictiveAddress (vyhledávání)
Vyhledávání pomocí rozhraní DATA8 PredictiveAddress API – Vyhledejte částečnou adresu v mnoha zdrojích dat.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Country
|
country | True | string |
Kód země ISO-2, do které adresa patří. |
|
Search
|
search | True | string |
Částečná adresa zadaná uživatelem. |
|
Telefonní číslo
|
telephoneNumber | string |
Volitelný parametr, telefonní číslo přidružené k adrese lze zadat. |
|
|
Session
|
session | string |
ID relace přijaté v předchozí odpovědi. Tím se zvyšuje efektivita a rychlost vyhledávání. To by se mělo zahrnout do všech následných volání koncového bodu vyhledávání. |
|
|
IncludeMR
|
IncludeMR | boolean |
Do výsledků zahrne adresy z databáze Multiple Residency (vyžaduje další licencování). |
|
|
IncludeNYB
|
IncludeNYB | boolean |
Obsahuje adresy z dosud sestavené databáze ve výsledcích (vyžaduje další licencování). |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Příznak určující, jestli požadavek na Data8 proběhl úspěšně bez ohledu na výsledek |
|
Zpráva o chybě
|
Status.ErrorMessage | string |
Vrácená chybová zpráva, pokud existuje |
|
Zbývající kredity
|
Status.CreditsRemaining | float |
Zbývající kredity Data8 pro volanou službu |
|
Results
|
Results | array of object |
Results |
|
Označení
|
Results.label | string |
Hodnota, která se má uživateli zobrazit. |
|
value
|
Results.value | string |
value |
|
Container
|
Results.container | boolean |
Označuje, jestli je tato shoda kontejnerem pro jiné adresy (např. město, ulice atd.). Pokud je tato hodnota pravdivá, měla by se do koncového bodu DrillDownu zadaná hodnota získat podrobnosti o adresách v záznamu kontejneru. Pokud je hodnota false, měla by být zadána do koncového bodu Načíst, aby se získaly úplné podrobnosti o adrese. |
|
Položky
|
Results.items | integer |
Seznam možných shod. |
|
Počet
|
Count | integer |
Počet |
|
Session ID
|
SessionID | string |
Do odpovědi je také zahrnuté ID relace. To by se mělo zahrnout do všech následných volání koncového bodu vyhledávání. |
Vyčištění e-mailu
Vyčistěte e-mailovou adresu, ověřte ji, abyste zjistili, jestli se jedná o skutečný, pravý e-mail, ale také další podrobnosti, jako je jméno nebo název společnosti, aby se dále obohatila.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
E-mailová adresa
|
True | string |
E-mailová adresa, kterou chcete ověřit |
|
|
Úroveň
|
Level | True | string |
Úroveň, na kterou chcete ověřit. To by vždy mělo být v textu požadavku, nikdy v adrese URL a nikdy v parametrech dotazu. Pokud si nejste jistí, výchozí hodnota je Server. |
|
Title
|
Title | string |
Název nebo oslovení zadaného jména, které slouží k určení, jestli je e-mailová adresa platná a správná |
|
|
Křestní jméno
|
Forename | string |
Jméno zadaného jména, které slouží k určení, jestli je e-mailová adresa platná a správná |
|
|
Druhé jméno
|
MiddleName | string |
Prostřední název zadaného jména, který slouží k určení, jestli je e-mailová adresa platná a správná |
|
|
Surname
|
Surname | string |
Příjmení zadaného jména, které slouží k určení, jestli je e-mailová adresa platná a správná |
|
|
Společnost
|
Company | string |
Název společnosti, která vám pomůže s identifikací, jestli je e-mail správný |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Příznak určující, jestli požadavek na Data8 proběhl úspěšně bez ohledu na výsledek |
|
Zpráva o chybě
|
Status.ErrorMessage | string |
Vrácená chybová zpráva, pokud existuje |
|
KredityRemaining
|
Status.CreditsRemaining | integer |
Zbývající kredity Data8 pro volanou službu |
|
Result
|
Result | string |
Obsahuje stavový kód označující, jestli je možné ověřit e-mailovou adresu. |
|
OriginalValid
|
OriginalValid | boolean |
OriginalValid |
|
Typ e-mailu
|
EmailType | string |
Typ e-mailu poskytnutého a způsobu klasifikace |
|
Navrhovaná e-mailová adresa
|
SuggestedEmailAddress | string |
Navrhovaná e-mailová adresa pro vylepšení tohoto e-mailu, pokud je k dispozici, měla by se zobrazit, aby uživatel měl možnost ho používat. |
|
Comment
|
Comment | string |
Pomocný komentář k tomu, proč bylo provedeno doporučení k poskytnutí dalšího kontextu |
|
Oslovení
|
Salutation | string |
Oslovení, které lze použít v tomto e-mailu , tj. kdo má e-mail adresovat. |
|
StrukturaUsed
|
StructureUsed | string |
StrukturaUsed |
|
ParsedName
|
ParsedName | string |
ParsedName |
Zemřel(a)
Spojené království - Identifikovat zemřelé jednotlivce rychle a snadno, pomocí důvěryhodných zdrojů aktualizovaných pravidelně.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Title
|
Title | string |
Název jména, který se má prohledávat |
|
|
Křestní jméno
|
Forename | string |
Jméno jména, které se má hledat |
|
|
Druhé jméno
|
MiddleName | string |
Prostřední název názvu, který se má prohledávat |
|
|
Surname
|
Surname | True | string |
Příjmení jména, které se má hledat |
|
Řádky
|
Lines | True | array of string |
Řádky |
|
Marketing
|
marketing | True | boolean |
Logická hodnota, která určuje, jestli se vyhledávání provádí z marketingových důvodů nebo ne. |
|
Shoda úrovně
|
MatchLevel | string |
Minimální úroveň shody mezi názvem zadaným ve vstupním záznamu a názvem v našich referenčních datových souborech. S je příjmení, I je Iniciála a F je Forename |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Success |
|
Chybová zpráva
|
Status.ErrorMessage | string |
Chybová zpráva (pokud je k dispozici) |
|
KredityRemaining
|
Status.CreditsRemaining | float |
Zbývající kredity |
|
Zemřel(a)
|
Result | boolean |
Označuje, zda je nalezena osoba, která zemřela. |
Získat úplnou adresu
Vyhledá adresy na základě vstupních dat, jako je číslo budovy a psč.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Licence
|
licence | True | string |
Vzhledem k tomu, že databáze PaF Royal Mail může být licencována několika způsoby, tento parametr označuje, pod jakou licencí přistupujete k datům. Musí se shodovat s variantou, pro kterou máte licenci nebo kredity – pokud si nejste jistí, kterou možnost zvolit, obraťte se na svého manažera účtu. |
|
PSČ
|
postcode | True | string |
Úplné psč pro získání adres. Formátování psč není důležité, takže "ch24ne", "CH2 4NE", "ch02 4Ne" jsou všechny akceptované. |
|
Budova
|
building | string |
Volitelná hodnota pro filtrování vrácených adres podle názvu budovy, čísla, podmístně (např. plochého čísla) nebo názvu společnosti. Pokud jsou zadány hodnoty null nebo "", budou ve výsledku zahrnuty všechny adresy v poštovním směrovacím kódu. |
|
|
FixTownCounty
|
FixTownCounty | boolean |
pokud chcete zajistit, aby město a okres byly vráceny na posledních dvou řádcích adres, nebo false, pokud by se měly objevit na prvním dostupném řádku. |
|
|
MaxLines
|
MaxLines | integer |
Počet řádků pro naformátování adresy Do výsledku psč se zahrne další řádek. |
|
|
MaxLineLength
|
MaxLineLength | integer |
Maximální počet znaků, které se můžou objevit na každém řádku adresy. |
|
|
NormalizeCase
|
NormalizeCase | boolean |
Převede veškerý text v adrese s výjimkou názvu města na velká písmena. |
|
|
NormalizeTownCase
|
NormalizeTownCase | boolean |
Převede název města na velká písmena. |
|
|
ExcludeCounty
|
ExcludeCounty | boolean |
Vyloučí okres( pokud existuje) z formátované adresy. |
|
|
UseAnyAvailableCounty
|
UseAnyAvailableCounty | boolean |
Používá všechny dostupné okresy k naplnění formátované adresy, nejen poštovního okresu. |
|
|
Nežádoucípunctuation
|
UnwantedPunctuation | boolean |
Řetězec obsahující všechny interpunkční znaky, které se mají odebrat z formátované adresy |
|
|
FixBuilding
|
FixBuilding | boolean |
Zajišťuje, že název/číslo budovy se vždy umístí na první řádek. |
|
|
IncludeUDPRN
|
IncludeUDPRN | boolean |
Nastavte na hodnotu true, aby bylo pole UniqueReference pro každou vrácenou adresu naplněné parametrem UDPRN. |
|
|
IncludeLocation
|
IncludeLocation | boolean |
Nastavte na hodnotu true, aby pole Umístění každé vrácené adresy bylo vyplněno podrobnostmi o geografickém kódování adresy. |
|
|
ReturnResultCount
|
ReturnResultCount | boolean |
Určuje, jestli má být pole ResultCount ve výsledku vyplněno celkovým počtem vrácených adres. |
|
|
IncludeNYB
|
IncludeNYB | boolean |
Nastavte hodnotu true tak, aby zahrnovala adresy z dosud sestavené databáze ve výsledcích (vyžaduje další licencování). |
|
|
IncludeMR
|
IncludeMR | boolean |
Nastavte hodnotu true tak, aby do výsledků zahrnovala adresy z databáze Multiple Residency (vyžaduje další licencování). |
|
|
Formatter
|
Formatter | string |
Vyberte některý z dostupných formátovacích prvků a určete způsob převodu nezpracované adresy na adresu čitelnou pro člověka. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Success |
|
Chybová zpráva
|
Status.ErrorMessage | string |
Chybová zpráva (pokud je k dispozici) |
|
KredityRemaining
|
Status.CreditsRemaining | float |
Zbývající kredity |
|
Obsahuje počet adres v poli Výsledky. Toto pole se vyplní pouze v případě, že je možnost ReturnResultCount nastavená na hodnotu true.
|
ResultCount | integer | |
|
Results
|
Results | array of object |
Results |
|
Řádky
|
Results.Address.Lines | array of string |
Formátované řádky adres |
|
Organizace
|
Results.RawAddress.Organisation | string |
Organizace |
|
Oddělení
|
Results.RawAddress.Department | string |
Oddělení |
|
AddressKey
|
Results.RawAddress.AddressKey | integer |
Klíč adresy |
|
OrganizationKey
|
Results.RawAddress.OrganisationKey | integer |
Klíč organizace |
|
PostcodeType
|
Results.RawAddress.PostcodeType | string |
Typ psčového kódu |
|
BuildingNumber
|
Results.RawAddress.BuildingNumber | integer |
Číslo budovy |
|
SubBuildingName
|
Results.RawAddress.SubBuildingName | string |
Název dílčí budovy |
|
BuildingName
|
Results.RawAddress.BuildingName | string |
Název budovy |
|
DependentThoroughfareName
|
Results.RawAddress.DependentThoroughfareName | string |
Závislý název důkladných názvových polí |
|
DependentThoroughfareDesc
|
Results.RawAddress.DependentThoroughfareDesc | string |
Závislý důkladný desc |
|
Název důkladných jízd
|
Results.RawAddress.ThoroughfareName | string |
Název důkladných jízd |
|
Důkladná farmaceutyDesc
|
Results.RawAddress.ThoroughfareDesc | string |
Důkladná zásadka Desc |
|
DoubleDependentLocality
|
Results.RawAddress.DoubleDependentLocality | string |
Dvojitá závislá lokalita |
|
DependentLocality
|
Results.RawAddress.DependentLocality | string |
Závislá lokalita |
|
Lokalita
|
Results.RawAddress.Locality | string |
Lokalita |
|
PSČ
|
Results.RawAddress.Postcode | string |
PSČ |
|
Dps
|
Results.RawAddress.Dps | string |
DPS |
|
PoBox
|
Results.RawAddress.PoBox | string |
PO Box |
|
PostalCounty
|
Results.RawAddress.PostalCounty | string |
Postal County |
|
TraditionalCounty
|
Results.RawAddress.TraditionalCounty | string |
Tradiční okres |
|
AdministrativeCounty
|
Results.RawAddress.AdministrativeCounty | string |
Správní okres |
|
CountryISO2
|
Results.RawAddress.CountryISO2 | string |
Země ISO2 |
|
UniqueReference
|
Results.RawAddress.UniqueReference | string |
Jedinečný odkaz |
|
Směřování na východ
|
Results.RawAddress.Location.Easting | integer |
Směřování na východ |
|
Sever
|
Results.RawAddress.Location.Northing | integer |
Sever |
|
GridReference
|
Results.RawAddress.Location.GridReference | string |
GridReference |
|
Zeměpisná délka
|
Results.RawAddress.Location.Longitude | float |
Zeměpisná délka |
|
Zeměpisná šířka
|
Results.RawAddress.Location.Latitude | float |
Zeměpisná šířka |
|
CountyCode
|
Results.RawAddress.Location.CountyCode | string |
CountyCode |
|
Okres
|
Results.RawAddress.Location.County | string |
Okres |
|
DistrictCode
|
Results.RawAddress.Location.DistrictCode | string |
DistrictCode |
|
Okres
|
Results.RawAddress.Location.District | string |
Okres |
|
WardCode
|
Results.RawAddress.Location.WardCode | string |
WardCode |
|
Oddělení
|
Results.RawAddress.Location.Ward | string |
Oddělení |
|
Country
|
Results.RawAddress.Location.Country | string |
Country |
Čistá adresa
Formátuje, ověřuje a opravuje danou adresu na celou formátovanou adresu.
Parametry
| Name | Klíč | Vyžadováno | Typ | Description |
|---|---|---|---|---|
|
Řádky
|
Lines | True | array of string |
Řádky |
|
Výchozí kód země
|
DefaultCountryCode | string |
Kód ISO 2 znaků pro zemi, ve které se předpokládá, že adresa je v případě, že není uvedeno jinak. Výchozí hodnota je GB. |
|
|
Automatická detekce země
|
DetectCountry | boolean |
Nastavte na hodnotu true a pokuste se automaticky zjistit zemi ze zadaných informací o adrese, případně přepsání výchozí země. |
|
|
Country
|
Country | string |
Pokud je funkce DetectCountry nastavená na hodnotu true, je to považováno za další uživatelský vstup spolu s adresou, která má vliv na funkci detekce země. Formát se nevynucuje, takže je možné ho poskytnout jako "USA", "USA" nebo "Spojené státy". |
|
|
Zahrnout zemi
|
IncludeCountry | boolean |
Zahrne pole CountryName v hlavní části výsledku. |
Návraty
| Name | Cesta | Typ | Description |
|---|---|---|---|
|
Success
|
Status.Success | boolean |
Příznak určující, jestli požadavek na Data8 proběhl úspěšně bez ohledu na výsledek |
|
Zpráva o chybě
|
Status.ErrorMessage | string |
Vrácená chybová zpráva, pokud existuje |
|
Zbývající kredity
|
Status.CreditsRemaining | float |
Zbývající kredity Data8 pro volanou službu |
|
Řádky
|
Result.Address.Lines | array of string |
Řádky |
|
Shoda úrovně
|
MatchLevel | string |
Obsahuje matchLevel označující, jak dobře se adresa shoduje s PAF. Možné hodnoty jsou OK_Unchanged, OK_Corrected, NOK_Building, NOK_Street, NOK_Town, NOK_NoMatch |
|
Název země
|
CountryName | string |
Obsahuje název země, ve které je adresa. |