...
Info |
---|
Звіт містить такі компоненти: |
Http Method | POST |
---|---|
Request URL | https://secure.ubki.ua/b2_api_xml/ubki/xml |
Request JSON |
Expand | ||
---|---|---|
| ||
{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "ident": { "okpo": "РНОКПП (ІПН) фізособи", "lname": "**Прізвище", "fname": "**Ім'я", "mname": "**По батькові", "bdate": "**Дата народження" }, "mvd": { "dtype": "Тип розшукуваного документа (Код із дов.7)", "pser": "Серія розшукуваного паспорта", "pnom": "Номер розшукуваного паспорта або номер ID-картки", "plname": "**Прізвище власника розшукуваного паспорта", "pfname": "**Ім'я власника розшукуваного паспорта", "pmname": "**По батькові власника розшукуваного паспорта", "pbdate": "**Дата народження власника розшукуваного паспорта" }, "reqlng": "Мова критеріїв пошуку (Код із дов.23)" }, "version": "1.0", "reqtype": "Код шаблону (Код із дов.49): 'Перевірка посвідчення особи' - 13", "reqreason": "Мета надання запиту (Код із дов.24)" }, "descr": "Об'єкт запиту" }, "descr": "Конверт запиту" }, "sessid": "Сесійна ключ (отримуємо з API авторизації)" } } } |
</i>
</request>
</req_xml>
</req_envelope>
</ubki>
</doc>
Response XML
title | body: |
---|
<?xml version="1.0" encoding="utf-8"?>
<ubkidata>
<!-- Блок системної інформації -->
<tech>
<trace>
<step name="Найменування кроку" stm="Дата штамп старту кроку" ftm="Дата штамп фінішу кроку">
<!-- Блок trace містить метрики таймінгу кроків формування компонентів -->
</step>
</trace>
<error errtype="Код помилки(Код із дов.0)" errtext="Текст помилки(Значення із дов.0)">
</error>
<reqinfo reqid="Вихідний ІД запиту, згенерований УБКІ">
</reqinfo>
<!-- Блок інформації щодо поточного стану рахунку припейд-->
<billing>
<balance value="Сума балансу" date="Дата" time="Час" />
</billing>
</tech>
<!-- Пошук анульованих документів -->
<comp id="5" descr="Назва компоненти">
<mvd found="Знайдений? (Код із дов.27)"
foundref="Знайдений? (Значение із дов.27)"
foundtitle="Опис результату пошуку"
pser="Серія розшукуваного паспорта"
pnom="Номер розшукуваного паспорта або номер ID-картки"
plname="Прізвище власника розшукуваного паспорта"
pfname="Ім'я власника розшукуваного паспорта"
pmname="По батькові власника розшукуваного паспорта"
pbdate="Дата народження власника розшукуваного паспорта"
dtype="Тип документа (Код із дов.7)"
dtyperef="Паспорт (Значение із дов.7)"
status="Причина анулювання (Тільки для даних із DATA.GOV.UA)"
stdate="Дата анулювання (Тільки для даних із DATA.GOV.UA)">
<foundsource name="Джерело даних для перевірки (Код із дов.63)"
found="0/1 - цифрове позначення наявності недійсного паспорту (Код із дов.27)"
foundref="Текстове позначення наявності недійсного паспорту (Значення із дов.27)"
sourcedate="Дата оновлення інформації у БД чи отримання відповіді від АПІ першоджерла." />
<!--Даний блок повинен складатись з 1 .. * елементів-->
</mvd>
</comp>
<!-- Блок пошуку розшукуваних в базі МВС-->
<comp id="17" descr="Назва компоненти">
<wantedmvs found="0-не знайдений, 1-знайдено"
foundref="не знайдений/знайдений"
bdate="Дата народження"
lng="Мова внадання блоку (Код із дов.23)"
lngref="Мова надання блоку (Значення із дов.23)"
lname="Прізвище"
fname="Ім'я"
mname="По батькові"
url="Посилання на анкету МВС"
category="Категорія"
articlecrim="Стаття звинувачення"
restraint="Запобіжний захід" />
</comp>
<!-- Попередження -->
<comp id="18Response JSON
|
Request XML
( ** параметри передаються опціонально)
title | body: |
---|
<?xml version="1.0" encoding="utf-8"?>
<doc>
<ubki sessid="Сесійна ключ (отримуємо з API авторизації)">
<req_envelope descr="Конверт запиту">
<req_xml descr="Об'єкт запиту">
<!-- Параметри запиту --><request version="1.0" reqtype="Код шаблону (Код із дов.49): 'Перевірка посвідчення особи' - 13" reqreason="Мета надання запиту (Код із дов.24)">
<!-- Параметри, що описують критерії пошуку-->
<i reqlng="Мова критеріїв пошуку (Код із дов.23)">
<!-- Параметри ідентифікації суб'єкта-->
<ident okpo="РНОКПП (ІПН) фізособи"
lname="**Прізвище"
fname="**Ім'я"
mname="**По батькові"
bdate="**Дата народження" />
<!-- Для запитів пошуку анульованих документів --><mvd dtype="Тип розшукуваного документа (Код із дов.7)"
pser="Серія розшукуваного паспорта"
pnom="Номер розшукуваного паспорта або номер ID-картки"
plname="**Прізвище власника розшукуваного паспорта"
pfname="**Ім'я власника розшукуваного паспорта"
pmname="**По батькові власника розшукуваного паспорта"
pbdate="**Дата народження власника розшукуваного паспорта" >
</mvd>
|
Request XML |
Expand | ||
---|---|---|
| ||
<?xml version="1.0" encoding="utf-8"?> <doc> <ubki sessid="Сесійна ключ (отримуємо з API авторизації)"> <req_envelope descr="Конверт запиту"> <req_xml descr="Об'єкт запиту"> <!-- Параметри запиту --> <request version="1.0" reqtype="Код шаблону (Код із дов.49): 'Перевірка посвідчення особи' - 13" reqreason="Мета надання запиту (Код із дов.24)"> <!-- Параметри, що описують критерії пошуку--> <i reqlng="Мова критеріїв пошуку (Код із дов.23)"> <!-- Параметри ідентифікації суб'єкта--> <ident okpo="РНОКПП (ІПН) фізособи" lname="**Прізвище" fname="**Ім'я" mname="**По батькові" bdate="**Дата народження" /> <!-- Для запитів пошуку анульованих документів --> <mvd dtype="Тип розшукуваного документа (Код із дов.7)" pser="Серія розшукуваного паспорта" pnom="Номер розшукуваного паспорта або номер ID-картки" plname="**Прізвище власника розшукуваного паспорта" pfname="**Ім'я власника розшукуваного паспорта" pmname="**По батькові власника розшукуваного паспорта" pbdate="**Дата народження власника розшукуваного паспорта" > </mvd> </i> </request> </req_xml> </req_envelope> </ubki> </doc> |
Response XML
|
Приклад
Request JSON
|
Приклад |
---|
Request JSON |
|
Response JSON |
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Response JSON |
|
...
Response XML |
|
XSD Schema request | https://secure.ubki.ua/b2/js/xsd/request13.xsd |
---|---|
XSD Schema response | https://secure.ubki.ua/b2/js/xsd/response13.xsd |
...