Versions Compared

Old Version 3

changes.mady.by.user Оксана Нечепоренко

Saved on

compared with

New Version Current

changes.mady.by.user Оксана Нечепоренко

Saved on

Key

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

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

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

...

Expand
titleMore details

Request for receiving a list of all generated pools for the organization (if the name is empty), and searching by the pool name.

The request must be submitted in the GET method body.

Request https://secure.ubki.ua/m2/pool?{name}

Parameters

Parameter

Name

Format

name

Name of the pool to search for

integer

Response

Parameter

Name

Format

PoolBriefDto

poolID

Pool number

integer

poolName

Pool name

string
maxLength: 150
minLength: 3

createDate

Pool generation date

string($date-time)

poolState

Pool status

string

[ created, active, inactive, finished, invalid ]

workPeriod

Operation frequency

string

[ daily, weekly, monthly ]

workTime

Operation period, months

integer

workCount

Number of runs

integer

doneTotalCount

Number of activations

integer

workEndDate

Operation end date

string($date)

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

editDate

Date of revision

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)

editUser

UserId of the editing user

integer

firstStartDate

First launch date

string($date)

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

lastStartDate

Last launch date

string($date)

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

lastInnCount

Number of TINs

integer

lastDoneCount

Number of activations during the last run

integer

lastWorkState

Current work status

integer

[ new, closed, done, wip, failed ]

...

Expand
titleMore details

Pool parameters reception request.
The request must be submitted in the GET method body.

Request https://secure.ubki.ua/m2/pool/{poolID}

Parameters

Parameter

Name

Format

poolID

Pool number

integer

Response body
{
"poolID": 12,
"poolName": "Pool_test ",
"createDate": "2022-02-01 10:58:16",
"poolState": "created",
"workPeriod": "daily",
"workTime": 0,
"workCount": 0,
"doneTotalCount": 0,
"workEndDate": "2022-02-01",
"editDate": null,
"editUser": null,
"firstStartDate": "2022-02-01",
"lastStartDate": null,
"lastInnCount": 0,
"lastDoneCount": 0,
"lastWorkState": "new",
"inns": [
"33546706"
],
"triggers": [
1
]
}

...

Expand
titleMore details

Pool editing request (change: name, operation frequency, operation period, list of TINs/USREOUs, triggers) without stopping the pool.
The request must be submitted in the POST method body.

Request https://secure.ubki.ua/m2/{poolID}


Parameters

Parameter

Name

Format

poolID

Pool number

integer


Request body
New pool data (request contains the data to be changed)
{
"poolName": "Pool_test",
"workPeriod": "weekly",
"workEndDate": "2022-02-01",
"inns": [
"33546706",
"40075815"
],
"triggers": [
2
]
}


Response body

{
"poolID": 12,
"poolName": "Pool_test",
"createDate": "2022-02-01 10:58:16",
"poolState": "created",
"workPeriod": "weekly",
"workTime": 0,
"workCount": 0,
"doneTotalCount": 0,
"workEndDate": "2022-02-01",
"editDate": "2022-02-01 12:12:31",
"editUser": null,
"firstStartDate": "2022-02-01",
"lastStartDate": null,
"lastInnCount": 0,
"lastDoneCount": 0,
"lastWorkState": "new",
"inns": [
"33546706",
"40075815"
],
"triggers": [
2
]
}

...

Expand
titleMore details

Request to add the TIN/USREOU to the pool, without stopping it.

The request must be submitted in the POST method body.

Request https://secure.ubki.ua/m2/pool/{poolID}/add_inns


Parameters

Parameter

Name

Format

poolID

Pool number

integer

Request body

New pool inns ( request contains the data to be added)
{
"inns": [
"25522107","41078439","40456297"
]
}

Response body

{
"poolID": 12,
"poolName": "Pool_test",
"createDate": "2022-02-01 10:58:16",
"poolState": "created",
"workPeriod": "weekly",
"workTime": 0,
"workCount": 0,
"doneTotalCount": 0,
"workEndDate": "2022-02-01",
"editDate": "2022-02-01 12:12:31",
"editUser": null,
"firstStartDate": "2022-02-01",
"lastStartDate": null,
"lastInnCount": 0,
"lastDoneCount": 0,
"lastWorkState": "new",
"inns": [
"33546706",
"40075815",
"25522107",
"41078439",
"40456297"
],
"triggers": [
2
]
}

...

Expand
titleMore details

Request to delete the TIN/USREOU from the pool, without stopping it.

The request must be submitted in the POST method body.

Request https://secure.ubki.ua/m2/pool/{poolID}/rm_inns


Parameters

Parameter

Name

Format

poolID

Pool number

integer

Request body

Remove pool inns ( request contains the data to be deleted)
{
"inns": [
"41078439","40456297"
]
}

Response body

{
"poolID": 12,
"poolName": "Pool_test",
"createDate": "2022-02-01 10:58:16",
"poolState": "created",
"workPeriod": "weekly",
"workTime": 0,
"workCount": 0,
"doneTotalCount": 0,
"workEndDate": "2022-02-01",
"editDate": "2022-02-01 12:12:31",
"editUser": null,
"firstStartDate": "2022-02-01",
"lastStartDate": null,
"lastInnCount": 0,
"lastDoneCount": 0,
"lastWorkState": "new",
"inns": [
"33546706",
"40075815",
"25522107"
],
"triggers": [
2
]
}

...

Expand
titleMore details

Pool activation request ("poolState": "active")

The request must be submitted in the POST method body.

Request https://secure.ubki.ua/m2/pool/{poolID}/activate


Parameters

Parameter

Name

Format

poolID

Pool number

integer

Response body

{
"poolID": 12,
"poolName": "Pool_test",
"createDate": "2022-02-01 10:58:16",
"poolState": "active",
"workPeriod": "weekly",
"workTime": 0,
"workCount": 0,
"doneTotalCount": 0,
"workEndDate": "2022-02-01",
"editDate": "2022-02-01 12:30:21",
"editUser": null,
"firstStartDate": "2022-02-01",
"lastStartDate": null,
"lastInnCount": 0,
"lastDoneCount": 0,
"lastWorkState": "new",
"inns": [
"33546706",
"40075815",
"25522107"
],
"triggers": [
2
]
}

...

Expand
titleMore details

Request to create a copy of the pool with the same parameters.

The request must be submitted in the POST method body.

Request https://secure.ubki.ua/m2/pool/{poolID}/duplicate

Parameters

Parameter

Name

Format

poolID

Pool number

integer

Response body
{
"poolID": 13,
"poolName": "Pool_test",
"createDate": "2022-02-01 13:49:14",
"poolState": "created",
"workPeriod": "weekly",
"workTime": 0,
"workCount": 0,
"doneTotalCount": 0,
"workEndDate": "2022-02-01",
"editDate": null,
"editUser": null,
"firstStartDate": "2022-02-01",
"lastStartDate": null,
"lastInnCount": 0,
"lastDoneCount": 0,
"lastWorkState": "new",
"inns": [
"33546706",
"40075815",
"25522107"
],
"triggers": [
2
]
}

...