Skip to end of metadata
Go to start of metadata

You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 6 Next »

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

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

Http Method

POST

Request URL

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

Request JSON

  body:

{

"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 авторизації)"

}

}

}

Request XML

  body:

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

 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>

<!--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"
		}
	}
}

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

<?xml version="1.0" encoding="UTF-8" standalone="yes"?>
<ubkidata>
  <tech>
    <trace>
      <step name="build report" stm="2022-01-10 11:05:42.735" ftm="2022-01-10 11:05:42.814" />
    </trace>
    <reqinfo reqid="req2#000002012521" />
  </tech>
  <comp id="60" descr="FeatureSet">
    <featureSet okpo="2111118724" date="2019-02-01">
      <features name="ch308" value="0.0" />
      <features name="ch318" value="5915.82" />
      <features name="od1089" value="61.2" />
      <features name="od1081" value="52.33" />
    </featureSet>
  </comp>
</ubkidata>

XSD Schema request

https://secure.ubki.ua/b2/js/xsd/request41.xsd

XSD Schema response

https://secure.ubki.ua/b2/js/xsd/response41.xsd

Test URL

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

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"

  • No labels