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 Current »

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

Test URL https://test.ubki.ua/m2/

Pool operation log, statistics by days and triggers

GET /data/{poolId}/journal

 More 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 – year (1920–2099), MM – month (01–12), DD – day (01–31)

untilDate

Until

string [YYYY-MM-DD], YYYY – year (1920–2099), MM – 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 – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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)

GET /data/{poolId}/latest

 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31), HH - hour (00 - 23), MM - minute (00 - 59), SS - second (00-59)

lastCaseId

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], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

eventDate

Date of actual changes

string($date)

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

eventFoundAt

Date and time of inspection/changes detection

string($date-time)

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

caseTriggerDate

Date/time of inspection/changes detection

string($date-time)

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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

GET /data/{poolId}/results

 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 – year (1920–2099), MM – month (01–12), DD – day (01–31)

untilDate

Until

string [YYYY-MM-DD], YYYY – year (1920–2099), MM – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31), HH - hour (00 - 23), MM - minute (00 - 59), SS - second (00-59)

lastCaseId

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], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

eventDate

Date of actual changes

string($date)

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31)

eventFoundAt

Date and time of inspection/changes detection

string($date-time)

[YYYY-MM-DD], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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

GET/data/event/{eventId}

 More details

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

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], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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], YYYY – year (1920–2099), MM – month (01–12), DD – 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

GET /data/case/{caseId}

 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], YYYY – year (1920–2099), MM – month (01–12), DD – day (01–31), HH - hour (00 - 23), MM - minute (00 - 59), SS - second (00-59)

processingDate

Data date

string($date) [YYYY-MM-DD], YYYY – year (1920–2099), MM – 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

  • No labels