Versions Compared

Old Version 5

changes.mady.by.user Оксана Нечепоренко

Saved on

compared with

New Version Current

changes.mady.by.user Оксана Нечепоренко

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Http Method

POST

Request URL

https://secure.ubki.ua/b2_api_xml/ubki/xml

Request JSON/Пошук документів по декларанту
( ** параметри передаються опціонально)

Expand
title body:

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

"okpo": "**РНОКПП (ІПН) декларанта",

"lname": "Прізвище",

"fname": "Ім'я",

"mname": "По батькові",

"bdate": "**Дата народження"

},

"reqlng": "Мова критеріїв пошуку (Код із дов.23)"

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): 'Інформація з Єдиного державного реєстру декларацій' - 49",

"reqreason": "Мета надання запиту (Код із дов.24)"

},

"descr": "Об'єкт запиту"

},

"descr": "Конверт запиту"

},

"sessid": "Сесійна ключ (отримуємо із API авторизації)"

}

}

}

Response JSON

Expand
titlebody:

{

"ubkidata": {

"tech": {

"trace": {

"step": {

"name": "Найменування кроку",

"stm": "Дата штамп старту кроку",

"ftm": "Дата штамп фінішу кроку"

}

},

"error": {

"errtype": "Код помилки(Код із дов.0)",

"errtext": "Текст помилки(Значення із дов.0)"

},

"reqinfo": {

"reqid": "Вихідний ІД запиту, згенерований УБКІ"

},

"billing": {

"balance": {

"value": "Сума балансу",

"date": "Дата",

"time": "Час"

},

"billdetails": {

"freemon": "Ознака безоплатності за типом запиту "Моніторинг клієнта організації" (reqreason=1), код (0 - Ні, 1 - Так)",

"freemonref": "Ознака безоплатності за типом запиту "Моніторинг клієнта організації" (reqreason=1), значення (0 - Ні, 1 - Так)"

}

}

},

"comp": [

{

"id": "Номер компоненти",

"descr": "",

"declaration": {

"found": "Параметр пошуку (1-знайдено, 0-ні)",

"foundref": "Текстове повідомлення результату пошуку",

"persons": [

{

"identId": "Унікальний номер декларанта",

"names": [

{

"lname": "Прізвище",

"fname": "Ім’я",

"mname": "По батькові",

"personName": "ПІБ"

}

],

"docs": [

{

"documentId": "Номер документа",

"year": "Рік документа",

"typeId": "Тип документа",

"docType": "Вид декларації",

"docDate": "Дата подачі декларації"

}

]

}

]

}

}

]

}

}

...

Response XML

Expand
titlebody:

<?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="Час" />

<billdetails freemon="Ознака безоплатності за типом запиту "Моніторинг клієнта організації" (reqreason=1), код (0 - Ні, 1 - Так)"

freemonref="Ознака безоплатності за типом запиту "Моніторинг клієнта організації" (reqreason=1), значення (0 - Ні, 1 - Так)"/>

</billing>

</tech>

<!-- Перелік декларацій -->

<comp id="74" descr="Перелік декларацій">

<declaration found="Параметр пошуку (1-знайдено, 0-ні)"

foundref="Текстове повідомлення результату пошуку">

<persons identId="Унікальний номер декларанта">

<names lname="Прізвище"

fname="Ім’я"

mname="По батькові"

personName="ПІБ"/>

<docs documentId="номер документа"

year="Рік документа"

typeId="Тип документа"

docType="Вид декларації"

docDate="Дата подачі декларації"/>

</persons>

</declaration>

</comp>

</ubkidata>

...