API отримання реєстру передачі даних
- Оксана Нечепоренко
Даний сервіс призначений для отримання реєстру передачі даних.
Http Method | POST |
|---|---|
Request URL | https://secure.ubki.ua/b2/handsent/sentreestr |
Request | <?xml version="1.0" encoding="utf-8"?>
<doc>
<prot todo="Тип запиту"
idout="ІД запиту УБКІ"
idalien="ІД запиту партнера"
indate="Дата, за яку будуть вигружені протоколи прийому даних (за замовчуванням вчорашня дата)"
grp="Тип угруповання" sessid="Сесійний ключ" />
</doc> |
Request params | |
todo* | Тип запиту - BIL - Біллінг (отримання значень лічильників в розрізі "Всього", "Нові", "Скориговані", "Помилки", "Глобальні дублікати", "Локальні дублікати", "Дистанційні") REP - Реєстр (отримання реєстру повідомлень і помилок) |
|---|---|
grp* | Тип угруповання (тільки для режиму todo = "BIL"), в запиті вказується тільки один тип - PACK - До пакета (угрупування проводиться по ІД пакету, всі значення лічильників підсумовуються) COMP - До компоненти (групування проводиться по ІД компоненти, всі значення лічильників підсумовуються) ITEM - До елемента (групування проводиться по ІД елемента, всі значення лічильників підсумовуються) |
idout | ІД запиту УБКІ (Після кожної передачі даних, сервіс УБКІ генерує унікальний ІД пакета передачі idout. По цьому ідентифікатору можливо отримати результативний реєстр) |
idalien | ІД запиту партнера (В запиті про передачу даних в атрибут reqidout тега request є можливість передати будь-який ідентифікатор. При вказівці цього атрибута в даному сервісі можливо отримати по ньому результативний реєстр) |
indate | Дата, за яку будуть вигружені протоколи прийому даних (по дефолту - за замовчуванням вчорашня дата) |
sessid* | Сесійний ключ (необхідно отримати через сервіс авторизації) |
Response при режимі todo=”BIL” indate="2023-12-01" grp="PACK"
| <?xml version='1.0' encoding='UTF-8'?>
<doc>
<prot indate="20231201" idout="IN#M4C1723443317" idalien="c9a961b0-0b82-45b9-af6d-686e863d9db1" state="r" oper="u" todo="BIL" al="1" nw="0" ed="1" er="0" db="0" lb="0" dl="0" cl="0" clTr="0" erCr="0" erNt="0" nd="0" ndTr="0" nt="0" nwTr="0" sessid=""/>
<prot indate="20231201" idout="IN#94C1I12244626" idalien="c9a961b0-0b82-45b9-af6d-686e863d9db1" state="r" oper="u" todo="BIL" al="1" nw="0" ed="1" er="0" db="0" lb="0" dl="0" cl="0" clTr="0" erCr="0" erNt="0" nd="0" ndTr="0" nt="0" nwTr="0" sessid=""/>
</doc> |
Request params | |
state | Статус пакета передачі (r - оброблений, n - переданий, i - створений, b - забракований, e - помилка запису в базу) |
oper | Тип операції передачі (вказується при передачі в атрибуті reqtype тега request ( `i` - передача, `u` - коригування, `d` - видалення)) |
compid | ІД переданої компоненти (на даний момент такі 1 - Ідентифікація фіз.особи, 2 - Кредитна історія, 10 - Контакти) |
item | Підкомпонента (IDENT, URIDENT, LINKED, WORK, DOC, ADDR, FOTO, CRDEAL, SUSD, CONT) |
al | Всього передано версій |
nw | Нові версії |
ed | Модифікованих версій |
er | Помилок в версіях |
db | Версії-дублікати по базі бюро |
lb | Версії-дублікати в переданому пакеті |
dl | Видалено з бази бюро |
clTr | Закриті угоди, передані транзакційно |
ndTr | Нові угоди, передані транзакційно |
nwTr | Нові зрізи угод, передані транзакційно |
Response при режимі todo=”REP” | <?xml version="1.0" encoding="utf-8"?>
<doc>
<prot todo="REP" idout="IN#0000018427" idalien="X000000000001" indate="2023-02-01" sessid="A1F593950A8F4562AE5A5DB1914D658A" state="r" oper="i"
compid="1" item="IDENT" ertype="NW" crytical="" inn="1234567890" remark="OK. Язык: 1. ФИО: Іванова Любов Ярославівна. Дата версии: 23.05.2014" />
</doc> |
Request params | |
state | Статус пакета передачі (r - оброблений, n - переданий, i - створений, b - забракований, e - помилка запису в базу) |
oper | Тип операції передачі (вказується при передачі в атрибуті reqtype тега request ( `i` - передача, `u` - коригування, `d` - видалення)) |
compid | ІД переданої компоненти (на даний момент такі 1 - Ідентифікація фіз.особи, 2 - Кредитна історія, 10 - Контакти) |
item | Підкомпонента (IDENT, URIDENT, LINKED, WORK, DOC, ADDR, FOTO, CRDEAL, SUSD, CONT) |
ertype | Тип реєстру |
crytical | Критичність помилки (SYSTEM- системна, призводить до зупинки передачі всіх пакетів, CRITICAL - критична, призводить до бракування пакету, NOTICE - дані приймаються, але з повідомленням для партнера, IGNORED - проігноровані дані, призводить до бракування однієї компоненти в пакеті.) |
inn | РНОКПП (ІПН) суб'єкта |
remark | Текст примітки |
Див. у цьому розділі також
Фізична особа
Юридична особа
Параметри запиту передачі даних
Помилки і нотифікації при передачі даних
Журнал версій API
Вступ
Авторизація
Отримання інформації із бюро
Послуга "Моніторинг суб'єктів"
Тестове середовище
Довідники
Журнал змін