Versions Compared

Old Version 4

changes.mady.by.user Zlata

Saved on

compared with

New Version 5

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": "РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)"

},

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

},

"version": "1.0",

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

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

},

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

},

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

},

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

}

}

}

Request XML

Expand
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): 'Інформація про зареєстровані транспортні засоби' - 37" reqreason="Мета надання запиту (Код із дов.24)">

<!-- Параметри, що описують критерії пошуку-->

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

<!-- Параметри ідентифікації суб'єкт-->

<ident okpo="РНОКПП (ІПН) (для фіз.осіб)/ЄДРПОУ (для юр.осіб)" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

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

</billing>

</tech>

<!-- Інформація про транспортні засоби -->

<comp id="56" descr="Інформація про транспортні засоби">

<registeredCars okpo="РНОКПП (ІПН)/ЄДРПОУ клієнта"

carfound="0/1/-1 -цифрове позначення наявності автотранспорту по суб'єкту"

carfoundref="Текстове позначення наявності автотранспорту по суб'єкту">

<car operCode="Код операції"

operName="Розшифрування операції"

depName="Орган"

brand="Назва марки транспортного засобу"

model="Назва моделі транспортного засобу"

makeYear="Рік виготовлення"

capacity="Об`єм двигуна"

dreg="Дата проведення останньої реєстрації за власником"

color="Колір транспортного засобу"

kind="Тип транспортного засобу"

body="Тип кузову транспортного засобу"

purpose="Призначення"

fuel="Тип палива транспортного засобу"

ownWeight="Власна вага транспортного засобу"

totalWeight="Загальна вага транспортного засобу"

gosRegNumber="Номер державної реєстрації автомобіля"

VINNumber="Унікальний серійний номер (Vehicle identification number)" />

</registeredCars>

</comp>

</ubkidata>

Приклад

Request JSON

Code Block
{
	"doc": {
		"ubki": {
			"req_envelope": {
				"req_xml": {
					"request": {
						"i": {
							"ident": {
								"okpo": "12345610"
							},
							"reqlng": "1"
						},
						"version": "1.0",
						"reqtype": "37",
						"reqreason": "2"
					},
					"descr": "Об'єкт запиту"
				},
				"descr": "Конверт запиту"
			},
			"sessid": "77B5BEF2B24548B597FFF20C00000088"
		}
	}
}

Request XML

Code Block
<?xml version="1.0" encoding="UTF-8"?>
<doc>
  <ubki sessid="77B5BEF2B24548B597FFF20C00000088">
    <req_envelope descr="Конверт запиту">
      <req_xml descr="Об'єкт запиту">
        <request version="1.0" reqtype="37" reqreason="2">
          <i reqlng="1">
            <ident okpo="12345610" />
          </i>
        </request>
      </req_xml>
    </req_envelope>
  </ubki>
</doc>

Response XML

Code Block
<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
  <tech>
    <trace>
      <step name="build report" stm="2022-01-10 23:08:24.081" ftm="2022-01-10 23:08:24.175" />
    </trace>
    <reqinfo reqid="req2#000002016389" />
  </tech>
  <comp id="56" descr="Інформація про транспортні засоби">
    <registeredCars okpo="12345610" carfound="1" carfoundref="За клієнтом знайдено інформацію про транспортні засоби">
      <car operCode="100" operName="ПЕРВИННА РЕЄСТРАЦIЯ Б/В ТЗ ПРИДБАНОГО В ТОРГІВЕЛЬНІЙ ОРГАНІЗАЦІЇ, ЯКИЙ ВВЕЗЕНО З-ЗА КОРДОНУ" depName="ТСЦ 1242" brand="VOLKSWAGEN" model="JETTA" makeYear="2017" capacity="1390" dreg="2021-04-14T00:00:00" color="БІЛИЙ" kind="ЛЕГКОВИЙ" body="СЕДАН" purpose="ЗАГАЛЬНИЙ" fuel="БЕНЗИН" ownWeight="1411" totalWeight="1900" gosRegNumber="АЕ2615СС" VINNumber="3VWDB7AJ9HM310108" />
      <car operCode="410" operName="ПЕРЕРЕЄСТРАЦІЯ ПРИ ЗАМІНІ НОМЕРНОГО ЗНАКУ" depName="ТСЦ 1249" brand="VOLKSWAGEN" model="JETTA" makeYear="2016" capacity="1395" dreg="2021-04-15T00:00:00" color="БІЛИЙ" kind="ЛЕГКОВИЙ" body="СЕДАН" purpose="ЗАГАЛЬНИЙ" fuel="БЕНЗИН" ownWeight="1392" totalWeight="1900" gosRegNumber="АЕ8512СС" VINNumber="3VW267AJ1GM380000" />
    </registeredCars>
  </comp>
</ubkidata>

...