41 - Feature Set


Послуга з отримання числових показників щодо юридичної або фізичної особи.


Звіт містить такі компоненти:

Http Method

POST

Request JSON

{

"doc": {

"ubki": {

"req_envelope": {

"req_xml": {

"request": {

"i": {

"ident": {

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

},

"additionaldata": {

"date": "Дата для розрахунку показників. Не заповнюється, якщо розраховується на поточний момент",

"featlist": "Перелік показників для розрахунку. Не заповнюється, якщо розраховуються усі доступні показники"

},

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

},

"version": "1.0",

"reqtype": "Код шаблону (Код із дов.49): 'Звіт Feature Set' - 41",

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

},

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

},

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

},

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

}

}

}

Response JSON

{

"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": {

"featureSet": {

"features": {

"name": "Назва предиктора",

"value": "Значення предиктора"

},

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

"date": "Дата для розрахунку показників. Не заповнюється, якщо розраховується на поточний момент"

},

"id": "60",

"descr": "Назва компоненти"

}

}

}

Request XML

<?xml version="1.0" encoding="utf-8"?>

<doc>

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

<req_envelope descr="Конверт запиту">

<req_xml descr="Об'єкт запиту">

<!-- Параметри запиту-->

<request version="1.0" reqtype="Код шаблону (Код із дов.49): 'Звіт Feature Set' - 41" reqreason="Мета надання запиту (Код із дов.24)">

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

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

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

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

<additionaldata date="Дата для розрахунку показників. Не заповнюється, якщо розраховується на поточний момент"

featlist="Перелік показників для розрахунку. Не заповнюється, якщо розраховуються усі доступні показники" />

</i>

</request>

</req_xml>

</req_envelope>

</ubki>

</doc>

Response XML

<?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>

<!--Feature Set -->

<comp id="60" descr="Назва компоненти">

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

date="Дата для розрахунку показників. Не заповнюється, якщо розраховується на поточний момент">

<features name="Назва предиктора"

value="Значення предиктора" />

<!--Даний блок повинен складатись з 1 .. * елементів -->

</featureSet>

</comp>

</ubkidata>

Приклад

Приклад

Request JSON

{ "doc": { "ubki": { "req_envelope": { "req_xml": { "request": { "i": { "ident": { "okpo": "2111118724" }, "additionaldata": { "featlist": "od1,ch1,ch537,od193,od834,od67,od301", "date": "2019-02-01" }, "reqlng": "3" }, "version": "1.0", "reqtype": "41", "reqreason": "2" }, "descr": "Об’єкт запиту" }, "descr": "Конверт запиту" }, "sessid": "4EC8D647B0DB4D9A862CDC25A010101F" } } }

Response JSON

{ "ubkidata": { "tech": { "trace": { "step": { "name": "build report", "stm": "2022-01-10 11:05:42.735", "ftm": "2022-01-10 11:05:42.814" } }, "reqinfo": { "reqid": "req2#000002012521" } }, "comp": { "featureSet": { "features": [ { "name": "ch308", "value": "0.0" }, { "name": "ch318", "value": "5915.82" }, { "name": "od1089", "value": "61.2" }, { "name": "od1081", "value": "52.33" } ], "okpo": "2111118724", "date": "2019-02-01" }, "id": "60", "descr": "FeatureSet" } } }

Request XML

<?xml version="1.0" encoding="UTF-8"?> <doc> <ubki sessid="4EC8D647B0DB4D9A862CDC25A010101F"> <req_envelope descr="Конверт запиту"> <req_xml descr="Об’єкт запиту"> <request version="1.0" reqtype="41" reqreason="2"> <i reqlng="3"> <ident okpo="2111118724"> </ident> <additionaldata featlist="od1,ch1,ch537,od193,od834,od67,od301" date="2019-02-01" /> </i> </request> </req_xml> </req_envelope> </ubki> </doc>

Response XML

Test URL

Test data

  • okpo="2111118724" featlist="od1,ch1,ch537,od193,od834,od67,od301" date=""

okpo="2111118724" featlist="od1,ch1,ch537,od193,od834,od67,od301" date="2019-02-01"

  • okpo="12345632" featlist="od1,ch1,ch537,od193,od834,od67,od301" date=""

okpo="12345632" featlist="od1,ch1,ch537,od193,od834,od67,od301" date="2019-01-01"