Versions Compared

Key

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

URL https://secure.ubki.ua/m2

...

Expand
titleMore details

The request must be submitted in the GET method body.

Request https://secure.ubki.ua/m2/data/{poolID}/journal?{sinceDate}&{untilDate}

Parameters

Parameter

Name

Format

poolID

Pool number

integer

sinceDate

From

string [YYYY-MM-DD], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день– day (01–31)

untilDate

Until

string [YYYY-MM-DD], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день– day (01–31)

Responses

Парметр

Parameter

Назва

Name

Формат

Format

PoolJournalDto

poolIDНомер

пулаPool number

integer

poolNameНазва

пулаPool name

string

processingDateДата

данихData date

string($date) [YYYY-MM-DD], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день

workState

Стан роботи на даний момент– day (01–31)

workState

Current work status

string

[ new, closed, done, wip, failed ]

innCountКількість перевірених суб'єктів

Number of inspected subjects

integer

triggerCountКількість перевірених тригерів

Number of inspected triggers

integer

checkedCountКількість перевірок

Number of inspections

integer

eventCountКількість знайдених змін і відповідно подій у джерелах даних

Number of changes found and, accordingly, events in data sources

integer

caseCountКількість відфільтрованих тригер-кейсів згідно з правилами підключених тригерів

Number of filtered trigger cases, according to the rules of connected triggers

integer

insertAtЧас початку обробки пула

Pool processing start time

string($date-time) [YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

updateAtЧас закінчення обробки пула

Pool processing end time

string($date-time) [YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

...

Receiving the latest pool operation results (list of new activations)

Info

Status
colourBlue
titlegET
/data/{poolId}/latest

Подачу запиту необхідно здійснювати в тілі GET методу
Expand
titleДетальніше
More details

The request must be submitted in the GET method body.
Request https://secure.ubki.ua/m2/data/{poolID}/latest?{caseId}&{page}&{size}


Parameters

Параметр

Parameter

Назва

Name

Формат

Format

poolIDНомер

пулаPool number

integer

caseId Ідентифікатор тригер-кейсу

Trigger case ID

string

(Default value : пустоempty)

page

СторінкаPage

integer

(Default value : 0),

size Кількість

тигер-кейсів (спрацювань) на сторінціNumber of trigger cases (activations) on the page

integer

(Default value : 20)


Responses

Парметр

Parameter

Назва

Name

Формат

Format

PoolResponseData

poolIdІдентифікатор

пулаPool ID

integer

poolNameНазва

пулаPool name

string

poolStateСтан

пулаPool status

string

[ created, active, inactive, finished, invalid ]

poolExecStateСтан роботи на даний момент

Current work status

string

[ new, closed, done, wip, failed ]

sinceПочатковий час вигрузки перевірок пула

Initial upload time for pool inspections

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

untilКінцевий час вигрузки перевірок пула

Final upload time for pool inspections

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

lastCaseIdІдентифікатор останньоrо кейсу даної вигрузки для юзера

Last case ID of the given upload for the user

string($uuid)

dataSourcesДжерела даних пула

Pool data sources

uniqueItems string

[ asvp, edr, rrp, credit, drorm, wagedebt, taxdebt, bankruptcy, inspection ]]

innCountКількість перевірених іпн/єдрпоу пула за час існування пула

Number of inspected TINs/USREOUs for the pool during its existence

integer

eventCountКількість виявлених змін у джерелах даних за час існування пула

Number of detected changes in data sources during the pool’s existence

integer

caseCountКількість знайдених кейсів за час існування пула

Number of cases found during the pool’s existence

integer

totalCheckCountКількість перевірок всього за час існування пула

Total number of inspections during the pool’s existence

integer

todayCheckingCountКількість запланованих перевірок на сьогодні, всього

Total number of scheduled inspections for today

integer

todayCheckedCountКількість уже перевірених пар іпн:тригер сьогодні

Number of inspected TIN:trigger pairs for today

integer

SubjectPoolData

subjectChangesДані змін по моніторингу

Data on monitoring changes

subjectCodeКод

клієнта, ІПН або ЄДРПОУClient code, TIN or USREOU

string

datasourceEventsЗміни у джерелі даних по клієнту

Changes in the data source for the client,

у in RFC6902 форматіformat

eventIdІдентифікатор події джерела даних

Data source event ID

string($uuid)

subjectCodeКод

клієнта, ІПН або ЄДРПОУClient code, TIN or USREOU

string

dataSourceДжерело

данихData source

string

[ asvp, edr, rrp, credit, drorm, wagedebt, taxdebt, bankruptcy, inspection ]]

currentDateДата

перевірки/виявлення змінDate of inspection/changes detection

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31)

eventDateДата коли зміни відбулися фактично

Date of actual changes

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31)

eventFoundAtДата-час перевірки/виявлення

змінDate and time of inspection/changes detection

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

baseDateДата

попередньої перевірки/виявлення змінDate of previous inspection/changes detection

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31)

upPatchДодаткові або агреговані дані

Additional or aggregate data

downPatchДодаткові або агреговані дані

Additional or aggregate data

TriggerCaseData

caseIdІдентифікатор тригер-кейсу

Trigger case ID

string($uuid)

caseDateДата змін по кейсу

Date of changes by case

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31)

caseTriggerDate

Дата/час перевірки/виявлення змінDate/time of inspection/changes detection

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

subjectCodeКод

клієнта, ІПН або ЄДРПОУClient code, TIN or USREOU

string

triggerIdТригер

, що спрацювавActivated trigger

integer

caseMessageПовідомлення тригер-кейсу

Trigger case message

string

caseDataПоточний зріз даних

Current data slice

baseDateДата

попередньої перевірки/виявлення змінDate of previous inspection/changes detection

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31)

baseDataПопередній зріз даних

Previous data slice

additionalInfoДодаткові або агреговані дані

Additional or aggregate data

dataSourceДжерело

данихData source

string

[ asvp, edr, rrp, credit, drorm, wagedebt, taxdebt, bankruptcy, inspection ]]

eventIdІдентифікатор події джерела даних

Data source event ID

string($uuid)

todayPoolProgressПрогрес розрахунку пула за сьогодні

Pool calculation progress for today

number($double)

additionalInfoDto - Інформація за агрегацією данихInformation by data aggregation

subjectCodeКод

клієнта, ІПН або ЄДРПОУClient code, TIN or USREOU

string

currentDateДата розрахунку агрегації

Aggregation calculation date

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31)

dlamtexpSumРезультат розрахунок агрегації

Aggregation calculation result

number($double)

countКількість об'єктів, що брали участь у розрахунку

Number of objects calculated

integer

currentDataCountКількість об'єктів у поточному зрізі

Number of objects in the current slice

integer

baseDataCountКількість об'єктів у попередньому зрізі

Number of objects in the previous slice

integer

casesCountКількість кейсів

Number of cases

integer

...

Obtaining the results of pool operation for the period. List of events and pool statistics

Info

Status
colourBlue
titleGet
/data/{poolId}/results

Подачу запиту необхідно здійснювати в тілі GET методу
Expand
titleДетальніше
More details

The request must be submitted in the GET method body.

Request https://secure.ubki.ua/m2/data/{poolId}/results?{sinceDate}&{untilDate}&{page}&{size}


Parameters

Параметр

Parameter

Назва

Name

Формат

Format

poolIDНомер

пулаPool number

integer

sinceDate

З датиFrom

string [YYYY-MM-DD], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день– day (01–31)

untilDate

По датуUntil

string [YYYY-MM-DD], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день– day (01–31)

page

СторінкаPage

integer

(Default value : 0),

sizeКількість

тигер-кейсів (спрацювань) на сторінціNumber of trigger cases (activations) on the page

integer

(Default value : 20)


Responses

Параметр

Parameter

Назва

Name

Формат

Format

PoolResponseData

poolIdІдентифікатор

пулаPool ID

integer

poolNameНазва

пулаPool name

string

poolStateСтан

пулаPool status

[ created, active, inactive, finished, invalid ]

poolExecStateСтан роботи на даний момент

Current work status

string

[ new, closed, done, wip, failed ]

sinceПочатковий час вигрузки перевірок пула

Initial upload time for pool inspections

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

untilКінцевий час вигрузки перевірок пула

Final upload time for pool inspections

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

lastCaseIdІдентифікатор останньоrо кейсу даної вигрузки для юзера

Last case ID of the given upload for the user

string($uuid)

dataSourcesДжерела даних пула

Pool data sources

uniqueItems: true

TriggerDataSourcestringДжерело

данихData source

string

[ asvp, edr, rrp, credit, drorm, wagedebt, taxdebt, bankruptcy, inspection ]

innCountКількість перевірених іпн/єдрпоу пула за час існування пула

Number of inspected TINs/USREOUs for the pool during its existence

integer

eventCountКількість виявлених змін у джерелах даних за час існування пула

Number of detected changes in data sources during the pool’s existence

integer

caseCountКількість знайдених кейсів за час існування пула

Number of cases found during the pool’s existence

integer

totalCheckCountКількість перевірок всього за час існування пула

Total number of inspections during the pool’s existence

integer

todayCheckingCountКількість запланованих перевірок на сьогодні, всього

Total number of scheduled inspections for today

integer

todayCheckedCountКількість уже перевірених пар іпн:тригер сьогодні

Number of inspected TIN:trigger pairs for today

integer

SubjectPoolData

subjectChangesДані змін по моніторингу

Data on monitoring changes

subjectCodestringКод

клієнта, ІПН або ЄДРПОУClient code, TIN or USREOU

string

datasourceEventsЗміни у джерелі даних по клієнту

Changes in the data source for the client,

у in RFC6902 форматіformat

eventIdІдентифікатор події джерела даних

Data source event ID

string($uuid)

subjectCodeКод

клієнта, ІПН або ЄДРПОУClient code, TIN or USREOU

string

dataSourceДжерело

данихData source

string

[ asvp, edr, rrp, credit, drorm, wagedebt, taxdebt, bankruptcy, inspection ]]

currentDateДата

перевірки/виявлення змінDate of inspection/changes detection

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31)

eventDateДата коли зміни відбулися фактично

Date of actual changes

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31)

eventFoundAtДата-час перевірки/виявлення

змінDate and time of inspection/changes detection

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

baseDateДата

попередньої перевірки/виявлення змінDate of previous inspection/changes detection

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31)

upPatchДодаткові або агреговані дані

Additional or aggregate data

downPatchДодаткові або агреговані дані

Additional or aggregate data

TriggerCaseData

caseIdІдентифікатор тригер-кейсу

Trigger case ID

string($uuid)

caseDateДата змін по кейсу

Date of changes by case

string($date)

caseTriggerDate

Дата/час перевірки/виявлення змінDate/time of inspection/changes detection

string($date-time)

subjectCodeКод

клієнта, ІПН або ЄДРПОУClient code, TIN or USREOU

string

triggerIdТригер

, що спрацювавActivated trigger

integer

caseMessageПовідомлення тригер-кейсу

Trigger case message

string

caseDataДодаткові або агреговані дані

Additional or aggregate data

baseDateДата

попередньої перевірки/виявлення змінDate of previous inspection/changes detection

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31)

baseDataДодаткові або агреговані дані

Additional or aggregate data

additionalInfoДодаткові або агреговані дані

Additional or aggregate data

dataSourceДжерело

данихData source

string

[ asvp, edr, rrp, credit, drorm, wagedebt, taxdebt, bankruptcy, inspection ]]

eventIdІдентифікатор події джерела даних

Data source event ID

string($uuid)

todayPoolProgressПрогрес розрахунку пула за сьогодні

Pool calculation progress for today

number($double)

additionalInfoDto - Інформація за агрегацією данихInformation by data aggregation

subjectCodeКод

клієнта, ІПН або ЄДРПОУClient code, TIN or USREOU

string

currentDateДата розрахунку агрегації

Aggregation calculation date

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31)

dlamtexpSumРезультат розрахунок агрегації

Aggregation calculation result

number($double)

countКількість об'єктів, що брали участь у розрахунку

Number of objects calculated

integer

currentDataCountКількість об'єктів у поточному зрізі

Number of objects in the current slice

integer

baseDataCountКількість об'єктів у попередньому зрізі

Number of objects in the previous slice

integer

casesCountКількість кейсів

Number of cases

integer

...

Viewing event data by ID

Info

Status
colourBlue
titleGet
/data/event/{eventId}

Expand
titleДетальнішеMore details

Request https://secure.ubki.ua/m2/data/event/{eventId}

Подачу запиту необхідно здійснювати в тілі GET методуThe request must be submitted in the GET method body.

Parameters

Параметр

Parameter

Назва

Name

Формат

Format

eventIdІдентифікатор події джерела даних

Data source event ID

string

Responses

Параметр

Parameter

Назва

Name

Формат

Format

eventIdІдентифікатор події джерела даних

Data source event ID

string($uuid)

eventDateДата коли зміни відбулися фактично

Date of actual changes

string($date)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31)

subjectCodeКод

клієнта, ІПН або ЄДРПОУClient code, TIN or USREOU

string

dataSourceДжерело

данихData source

string

[ asvp, edr, rrp, credit, drorm, wagedebt, taxdebt, bankruptcy, inspection ]]

workPeriodПеріодичність

роботиOperation frequency

string

[daily, weekly, monthly]

createdAtДата створення пула

Pool generation date

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

currentDateДата

перевірки/виявлення змінDate of inspection/changes detection

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

currentDataАктуальні

даніActual data

string

baseDateДата

попередньої перевірки/виявлення змінDate of previous inspection/changes detection

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

baseDataПопередні

даніPrevious data

string

upPatchData

Зміни даних згідно Data changes under RFC-6902

downPatchData

Зміни даних згідно Data changes under RFC-6902

...

...

Viewing trigger case data by ID

Info

Status
colourBlue
titleget
/data/case/{caseId}

Подачу запиту необхідно здійснювати в тілі GET методу
Expand
titleДетальніше
More details

The request must be submitted in the GET method body.

Request https://secure.ubki.ua/m2/data/case/{caseId}

Parameters

Параметр

Parameter

Назва

Name

Формат

Format

caseIdІдентифікатор події тригер-кейсу

Trigger case event ID

string

Responses

Параметр

Parameter

Назва

Name

Формат

Format

caseIdІдентифікатор події тригер-кейсу

Trigger case event ID

string

eventIdІдентифікатор події джерела даних

Data source event ID

string($uuid)

createdAt
TriggerCaseData

Дата створення пула

Дата/час перевірки/виявлення змінPool generation date
Date/time of inspection/changes detection

string($date-time)

[YYYY-MM-DD HH.MM.SS], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день (01-31– day (01–31), HH - година hour (00 - 23), MM - хвилина minute (00 - 59), SS - секунда second (00-59)

processingDateДата

данихData date

string($date) [YYYY-MM-DD], YYYY - рік (1920 - 2099– year (1920–2099), MM - місяць (01 - 12– month (01–12), DD - день– day (01–31)

subjectCodeКод

клієнта, ІПН або ЄДРПОУClient code, TIN or USREOU

string

poolID
Номер

пулаPool number

integer

triggerIdномер тригера, що спрацював

Activated trigger number

integer

caseMessageПовідомлення тригер-кейсу

Trigger case message

string

caseDateДата змін по кейсу

Date of changes by case

string($date)

caseDataДодаткові або агреговані дані

Additional or aggregate data

string

additionalInfoДодаткова інформація за кейсом

Additional information by case

string

changedFieldsПоля

які змінилисяUpdated fields

string

dataSourceДжерело

данихData source

string

https://wiki-ubki.atlassian.net/wiki/spaces/Specification/pages/124912358

...