Tutorial
Framework creation
Let’s create a framework:
Request
POST /api/2.5/frameworks HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"frameworkType": "internationalFinancialInstitutions",
"procuringEntity": {
"contactPoint": {
"name": "Державне управління справами",
"telephone": "+0440000000",
"email": "aa@aa.com"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Назва організації"
},
"kind": "general",
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"locality": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1"
},
"name": "Державне управління справами"
},
"additionalClassifications": [
{
"scheme": "ДК003",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"classification": {
"scheme": "ДК021",
"description": "Mustard seeds",
"id": "03111600-8"
},
"title": "Узагальнена назва закупівлі",
"description": "Назва предмета закупівлі",
"qualificationPeriod": {
"endDate": "2024-11-13T01:00:00+03:00"
}
},
"config": {
"restrictedDerivatives": false,
"clarificationUntilDuration": 3,
"qualificationComplainDuration": 0,
"hasItems": false
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a
{
"data": {
"status": "draft",
"title": "Узагальнена назва закупівлі",
"description": "Назва предмета закупівлі",
"qualificationPeriod": {
"endDate": "2024-11-13T01:00:00+03:00"
},
"classification": {
"description": "Mustard seeds",
"scheme": "ДК021",
"id": "03111600-8"
},
"additionalClassifications": [
{
"scheme": "ДК003",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"frameworkType": "internationalFinancialInstitutions",
"procuringEntity": {
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Назва організації"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220"
},
"contactPoint": {
"name": "Державне управління справами",
"telephone": "+0440000000",
"email": "aa@aa.com"
},
"kind": "general"
},
"prettyID": "UA-F-2023-10-10-000001",
"owner": "broker",
"date": "2023-10-10T01:00:00+03:00",
"dateCreated": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-10T01:00:00+03:00",
"id": "89208a5c9d04455eaa4c41e2b5f0d70a"
},
"access": {
"token": "c029ed2daf2c446a9adf956529cf0bc3",
"transfer": "1ffab0e1154d4a23bf7c3e876c26dbea"
},
"config": {
"restrictedDerivatives": false,
"clarificationUntilDuration": 3,
"qualificationComplainDuration": 0,
"hasItems": false
}
}
We have 201 Created response code, Location header and body with extra properties.
Framework was created in draft status. In this status any field, except technical, can be changed using PATCH method.
Request
PATCH /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"procuringEntity": {
"contactPoint": {
"telephone": "+0440000001"
}
},
"title": "updated in draft status"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"prettyID": "UA-F-2023-10-10-000001",
"title": "updated in draft status",
"description": "Назва предмета закупівлі",
"status": "draft",
"classification": {
"description": "Mustard seeds",
"scheme": "ДК021",
"id": "03111600-8"
},
"additionalClassifications": [
{
"scheme": "ДК003",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"owner": "broker",
"date": "2023-10-10T01:00:00+03:00",
"dateCreated": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-10T01:00:00+03:00",
"qualificationPeriod": {
"endDate": "2024-11-13T01:00:00+03:00"
},
"frameworkType": "internationalFinancialInstitutions",
"procuringEntity": {
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Назва організації"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220"
},
"contactPoint": {
"name": "Державне управління справами",
"telephone": "+0440000001",
"email": "aa@aa.com"
},
"kind": "general"
},
"id": "89208a5c9d04455eaa4c41e2b5f0d70a"
},
"config": {
"restrictedDerivatives": false,
"clarificationUntilDuration": 3,
"qualificationComplainDuration": 0,
"hasItems": false
}
}
Uploading documentation
Procuring entity can upload files into the created framework. Uploading should follow the Documents Uploading rules.
Request
POST /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/documents?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "framework.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/3d4ffdd9cb3e4b17a82a3c4ff17b9d36?Signature=JelzpZx4DZqA9ARXiecWl7r8bF0KLM5gkLdx3Gn6M880ALIr8YST1jVePz2USu1u70VELnWBdi2HOp0%2Ftlj0Cg%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/msword"
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/documents/b15c3be7f3bd44fe80ce96043e893b9c
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "framework.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/3d4ffdd9cb3e4b17a82a3c4ff17b9d36?Signature=tIDXH8wnBO3JBgUN3GoSoE4sW4BjxGNxkWSyxNiflNyarXJhL52k9CgC3cpQRNCO0JoJ2nrhXfCkIhHQJVVSCg%3D%3D&KeyID=a8968c46",
"language": "uk",
"id": "b15c3be7f3bd44fe80ce96043e893b9c",
"datePublished": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-10T01:00:00+03:00"
}
}
201 Created response code and Location header confirm document creation. We can additionally query the documents collection API endpoint to confirm the action:
Request
GET /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/documents?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"hash": "md5:00000000000000000000000000000000",
"title": "framework.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/3d4ffdd9cb3e4b17a82a3c4ff17b9d36?Signature=tIDXH8wnBO3JBgUN3GoSoE4sW4BjxGNxkWSyxNiflNyarXJhL52k9CgC3cpQRNCO0JoJ2nrhXfCkIhHQJVVSCg%3D%3D&KeyID=a8968c46",
"language": "uk",
"id": "b15c3be7f3bd44fe80ce96043e893b9c",
"datePublished": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-10T01:00:00+03:00"
}
]
}
And again we can confirm that there are two documents uploaded.
Request
POST /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/documents?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "framework_additional_docs.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a3b4750dd6e84c9ba06bcca72560bf2d?Signature=U3GdeiB45xfvNAL87CZ8tsA13pCralT8cEgHeTnXh%2FK1UXNwAePEVaruJlUSLXLa5yaNym3XvWgdRQwNwHkWDQ%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/msword"
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/documents/26e407ed90cf4b1f944de225426a7576
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a3b4750dd6e84c9ba06bcca72560bf2d?Signature=vCJf2VCGiuPf5SeqwD1awYCS9ZTLVHvhV3fzbpHLLC3w3Pr0UVL8oVBxYX8H7abDCBGS%2FLg7mix%2BK8hsWPTgAA%3D%3D&KeyID=a8968c46",
"language": "uk",
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-10T01:00:00+03:00"
}
}
In case we made an error, we can reupload the document over the older version:
Request
PUT /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/documents/26e407ed90cf4b1f944de225426a7576?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "framework_additional_docs.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/2365a5fbfc964de2a60ddfb175a6cc42?Signature=mUmGJC9xL%2Bv4D05v3EfGyP%2B5Kd1JZBrhs4h8IA6Hmd6C03lh7kcEHMLsD2l0VEsg7auhvBlZNXV57gb4zLhIBA%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/msword"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/2365a5fbfc964de2a60ddfb175a6cc42?Signature=EQ2YakEGQeWMwX3tiOKOcxsLShIUEa%2B7bB6wmpMCqaC99IWYdRUihRRIElynMe9Ko105jWenrapYnCDSRhGfDw%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
}
}
And we can see that it is overriding the original version:
Request
GET /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/documents/26e407ed90cf4b1f944de225426a7576?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/2365a5fbfc964de2a60ddfb175a6cc42?Signature=EQ2YakEGQeWMwX3tiOKOcxsLShIUEa%2B7bB6wmpMCqaC99IWYdRUihRRIElynMe9Ko105jWenrapYnCDSRhGfDw%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk",
"previousVersions": [
{
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a3b4750dd6e84c9ba06bcca72560bf2d?Signature=vCJf2VCGiuPf5SeqwD1awYCS9ZTLVHvhV3fzbpHLLC3w3Pr0UVL8oVBxYX8H7abDCBGS%2FLg7mix%2BK8hsWPTgAA%3D%3D&KeyID=a8968c46",
"language": "uk",
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-10T01:00:00+03:00"
}
]
}
}
Framework activation
The second step is moving the framework to active status.
qualificationPeriod.endDate should be in between 365 and 1461 days from activation moment.
There should be at least 1 document in addition to sign document.
Request
PATCH /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"status": "active"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"prettyID": "UA-F-2023-10-10-000001",
"title": "updated in draft status",
"description": "Назва предмета закупівлі",
"status": "active",
"classification": {
"description": "Mustard seeds",
"scheme": "ДК021",
"id": "03111600-8"
},
"additionalClassifications": [
{
"scheme": "ДК003",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"documents": [
{
"id": "b15c3be7f3bd44fe80ce96043e893b9c",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/3d4ffdd9cb3e4b17a82a3c4ff17b9d36?Signature=tIDXH8wnBO3JBgUN3GoSoE4sW4BjxGNxkWSyxNiflNyarXJhL52k9CgC3cpQRNCO0JoJ2nrhXfCkIhHQJVVSCg%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
},
{
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a3b4750dd6e84c9ba06bcca72560bf2d?Signature=vCJf2VCGiuPf5SeqwD1awYCS9ZTLVHvhV3fzbpHLLC3w3Pr0UVL8oVBxYX8H7abDCBGS%2FLg7mix%2BK8hsWPTgAA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
},
{
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/2365a5fbfc964de2a60ddfb175a6cc42?Signature=EQ2YakEGQeWMwX3tiOKOcxsLShIUEa%2B7bB6wmpMCqaC99IWYdRUihRRIElynMe9Ko105jWenrapYnCDSRhGfDw%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
}
],
"owner": "broker",
"date": "2023-10-10T01:00:00+03:00",
"dateCreated": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-10T01:00:00+03:00",
"qualificationPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2024-11-13T01:00:00+03:00"
},
"frameworkType": "internationalFinancialInstitutions",
"procuringEntity": {
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Назва організації"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220"
},
"contactPoint": {
"name": "Державне управління справами",
"telephone": "+0440000001",
"email": "aa@aa.com"
},
"kind": "general"
},
"enquiryPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2023-10-25T00:00:00+03:00",
"clarificationsUntil": "2023-10-28T00:00:00+03:00"
},
"period": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2024-10-14T00:00:00+03:00"
},
"next_check": "2023-10-26T00:00:00+03:00",
"id": "89208a5c9d04455eaa4c41e2b5f0d70a"
},
"config": {
"restrictedDerivatives": false,
"clarificationUntilDuration": 3,
"qualificationComplainDuration": 0,
"hasItems": false
}
}
After framework activation frameworks periods was calculated:
enquiryPeriod - first 10 full working days after activation.
period - period when suppliers can add submissions.
qualificationPeriod - last 30 full calendar days of framework when suppliers cannot add submissions but still can be qualified based on previous submissions.
Request
GET /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"prettyID": "UA-F-2023-10-10-000001",
"title": "updated in draft status",
"description": "Назва предмета закупівлі",
"status": "active",
"classification": {
"description": "Mustard seeds",
"scheme": "ДК021",
"id": "03111600-8"
},
"additionalClassifications": [
{
"scheme": "ДК003",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"documents": [
{
"id": "b15c3be7f3bd44fe80ce96043e893b9c",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/3d4ffdd9cb3e4b17a82a3c4ff17b9d36?Signature=tIDXH8wnBO3JBgUN3GoSoE4sW4BjxGNxkWSyxNiflNyarXJhL52k9CgC3cpQRNCO0JoJ2nrhXfCkIhHQJVVSCg%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
},
{
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a3b4750dd6e84c9ba06bcca72560bf2d?Signature=vCJf2VCGiuPf5SeqwD1awYCS9ZTLVHvhV3fzbpHLLC3w3Pr0UVL8oVBxYX8H7abDCBGS%2FLg7mix%2BK8hsWPTgAA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
},
{
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/2365a5fbfc964de2a60ddfb175a6cc42?Signature=EQ2YakEGQeWMwX3tiOKOcxsLShIUEa%2B7bB6wmpMCqaC99IWYdRUihRRIElynMe9Ko105jWenrapYnCDSRhGfDw%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
}
],
"owner": "broker",
"date": "2023-10-10T01:00:00+03:00",
"dateCreated": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"qualificationPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2024-11-13T01:00:00+03:00"
},
"frameworkType": "internationalFinancialInstitutions",
"procuringEntity": {
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Назва організації"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220"
},
"contactPoint": {
"name": "Державне управління справами",
"telephone": "+0440000001",
"email": "aa@aa.com"
},
"kind": "general"
},
"enquiryPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2023-10-25T00:00:00+03:00",
"clarificationsUntil": "2023-10-28T00:00:00+03:00"
},
"period": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2024-10-14T00:00:00+03:00"
},
"next_check": "2023-10-26T00:00:00+03:00",
"agreementID": "4860703af9044dc19e30f45f4e537fb9",
"id": "89208a5c9d04455eaa4c41e2b5f0d70a"
},
"config": {
"restrictedDerivatives": false,
"clarificationUntilDuration": 3,
"qualificationComplainDuration": 0,
"hasItems": false
}
}
Let’s check what framework registry contains:
Request
GET /api/2.5/frameworks HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"dateModified": "2023-10-26T01:00:00+03:00",
"id": "89208a5c9d04455eaa4c41e2b5f0d70a"
}
],
"next_page": {
"offset": "1698271200.0.1.19ee2d59e615174462b704fd14bde3ea",
"path": "/api/2.5/frameworks?offset=1698271200.0.1.19ee2d59e615174462b704fd14bde3ea",
"uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/frameworks?offset=1698271200.0.1.19ee2d59e615174462b704fd14bde3ea"
}
}
We do see the internal id of a framework and its dateModified datestamp.
Modifying framework
In active status only some fields can be changed: telephone, name, email for procuringEntity.contactPoint, description and documents.
Request
PATCH /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"procuringEntity": {
"contactPoint": {
"telephone": "+0440000002",
"name": "зміна",
"email": "ab@aa.com"
}
},
"description": "Назва предмета закупівлі1"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"prettyID": "UA-F-2023-10-10-000001",
"title": "updated in draft status",
"description": "Назва предмета закупівлі1",
"status": "active",
"classification": {
"description": "Mustard seeds",
"scheme": "ДК021",
"id": "03111600-8"
},
"additionalClassifications": [
{
"scheme": "ДК003",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"documents": [
{
"id": "b15c3be7f3bd44fe80ce96043e893b9c",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/3d4ffdd9cb3e4b17a82a3c4ff17b9d36?Signature=tIDXH8wnBO3JBgUN3GoSoE4sW4BjxGNxkWSyxNiflNyarXJhL52k9CgC3cpQRNCO0JoJ2nrhXfCkIhHQJVVSCg%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
},
{
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a3b4750dd6e84c9ba06bcca72560bf2d?Signature=vCJf2VCGiuPf5SeqwD1awYCS9ZTLVHvhV3fzbpHLLC3w3Pr0UVL8oVBxYX8H7abDCBGS%2FLg7mix%2BK8hsWPTgAA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
},
{
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/2365a5fbfc964de2a60ddfb175a6cc42?Signature=EQ2YakEGQeWMwX3tiOKOcxsLShIUEa%2B7bB6wmpMCqaC99IWYdRUihRRIElynMe9Ko105jWenrapYnCDSRhGfDw%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
}
],
"agreementID": "4860703af9044dc19e30f45f4e537fb9",
"owner": "broker",
"date": "2023-10-10T01:00:00+03:00",
"dateCreated": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"period": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2024-10-14T00:00:00+03:00"
},
"qualificationPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2024-11-13T01:00:00+03:00"
},
"enquiryPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2023-10-25T00:00:00+03:00",
"clarificationsUntil": "2023-10-28T00:00:00+03:00"
},
"next_check": "2023-10-26T00:00:00+03:00",
"frameworkType": "internationalFinancialInstitutions",
"procuringEntity": {
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Назва організації"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220"
},
"contactPoint": {
"name": "зміна",
"telephone": "+0440000002",
"email": "ab@aa.com"
},
"kind": "general"
},
"id": "89208a5c9d04455eaa4c41e2b5f0d70a"
},
"config": {
"restrictedDerivatives": false,
"clarificationUntilDuration": 3,
"qualificationComplainDuration": 0,
"hasItems": false
}
}
Additionally, the dateModified property was updated to reflect the last modification datestamp.
Checking the listing again reflects the new modification date:
Request
GET /api/2.5/frameworks HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"dateModified": "2023-10-26T01:00:00+03:00",
"id": "89208a5c9d04455eaa4c41e2b5f0d70a"
}
],
"next_page": {
"offset": "1698271200.0.1.19ee2d59e615174462b704fd14bde3ea",
"path": "/api/2.5/frameworks?offset=1698271200.0.1.19ee2d59e615174462b704fd14bde3ea",
"uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/frameworks?offset=1698271200.0.1.19ee2d59e615174462b704fd14bde3ea"
}
}
Modifying qualificationPeriod in active framework
Also in active status can be changed endDate for qualificationPeriod but it can be done only using another endpoint.
There are validations for changing qualificationPeriod.endDate:
qualificationPeriod.endDate couldn’t be less than 30 full calendar days from now
qualificationPeriod.endDate couldn’t be more than 1461 full calendar days from now
It is allowed to modify qualificationPeriod only by framework owner using changes.
Fields for modifying period:
qualificationPeriod.endDate (in change.modifications)
rationale
rationaleType
documents (optional)
Let’s try to change qualificationPeriod.endDate with soon date:
Request
POST /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/changes?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"modifications": {
"qualificationPeriod": {
"endDate": "2023-11-10T01:00:00+03:00"
}
},
"rationaleType": "other",
"rationale": "Треба закінчити швидше відбір"
}
}
Response
HTTP/1.0 422 Unprocessable Entity
Content-Type: application/json
{
"status": "error",
"errors": [
{
"location": "body",
"name": "modifications.qualificationPeriod",
"description": "qualificationPeriod.endDate couldn't be less than 30 full calendar days from now"
}
]
}
Let’s try to prolong qualificationPeriod.endDate with late date:
Request
POST /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/changes?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"modifications": {
"qualificationPeriod": {
"endDate": "2027-12-04T01:00:00+03:00"
}
},
"rationaleType": "other",
"rationale": "Треба подовжити відбір"
}
}
Response
HTTP/1.0 422 Unprocessable Entity
Content-Type: application/json
{
"status": "error",
"errors": [
{
"location": "body",
"name": "modifications.qualificationPeriod",
"description": "qualificationPeriod.endDate couldn't be more than 1461 full calendar days from now"
}
]
}
Success changing of qualificationPeriod:
Request
POST /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/changes?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"modifications": {
"qualificationPeriod": {
"endDate": "2023-12-15T01:00:00+03:00"
}
},
"rationaleType": "noDemandFramework",
"rationale": "Відсутня подальша потреба в закупівлі з використанням рамкової угоди"
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/changes/1eab5245be984b00babf8f1521622c7c
{
"data": {
"rationale": "Відсутня подальша потреба в закупівлі з використанням рамкової угоди",
"rationaleType": "noDemandFramework",
"modifications": {
"qualificationPeriod": {
"endDate": "2023-12-15T01:00:00+03:00"
}
},
"id": "1eab5245be984b00babf8f1521622c7c",
"previous": {
"qualificationPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2024-11-13T01:00:00+03:00"
}
},
"date": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
}
There is special parameter opt_context for getting change data for signing:
Request
GET /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/changes/1eab5245be984b00babf8f1521622c7c?acc_token=c029ed2daf2c446a9adf956529cf0bc3&opt_context=true HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"rationale": "Відсутня подальша потреба в закупівлі з використанням рамкової угоди",
"rationaleType": "noDemandFramework",
"modifications": {
"qualificationPeriod": {
"endDate": "2023-12-15T01:00:00+03:00"
}
},
"id": "1eab5245be984b00babf8f1521622c7c",
"previous": {
"qualificationPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2024-11-13T01:00:00+03:00"
}
},
"date": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
},
"context": {
"framework": {
"prettyID": "UA-F-2023-10-10-000001",
"title": "updated in draft status",
"description": "Назва предмета закупівлі1",
"status": "active",
"classification": {
"description": "Mustard seeds",
"scheme": "ДК021",
"id": "03111600-8"
},
"additionalClassifications": [
{
"scheme": "ДК003",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"documents": [
{
"id": "b15c3be7f3bd44fe80ce96043e893b9c",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/3d4ffdd9cb3e4b17a82a3c4ff17b9d36?Signature=tIDXH8wnBO3JBgUN3GoSoE4sW4BjxGNxkWSyxNiflNyarXJhL52k9CgC3cpQRNCO0JoJ2nrhXfCkIhHQJVVSCg%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
},
{
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a3b4750dd6e84c9ba06bcca72560bf2d?Signature=vCJf2VCGiuPf5SeqwD1awYCS9ZTLVHvhV3fzbpHLLC3w3Pr0UVL8oVBxYX8H7abDCBGS%2FLg7mix%2BK8hsWPTgAA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
},
{
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/2365a5fbfc964de2a60ddfb175a6cc42?Signature=EQ2YakEGQeWMwX3tiOKOcxsLShIUEa%2B7bB6wmpMCqaC99IWYdRUihRRIElynMe9Ko105jWenrapYnCDSRhGfDw%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
}
],
"agreementID": "4860703af9044dc19e30f45f4e537fb9",
"owner": "broker",
"date": "2023-10-10T01:00:00+03:00",
"dateCreated": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"period": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2023-11-15T00:00:00+02:00"
},
"qualificationPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2023-12-15T01:00:00+03:00"
},
"enquiryPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2023-10-25T00:00:00+03:00",
"clarificationsUntil": "2023-10-28T00:00:00+03:00"
},
"next_check": "2023-10-26T00:00:00+03:00",
"frameworkType": "internationalFinancialInstitutions",
"procuringEntity": {
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Назва організації"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220"
},
"contactPoint": {
"name": "зміна",
"telephone": "+0440000002",
"email": "ab@aa.com"
},
"kind": "general"
},
"changes": [
{
"rationale": "Відсутня подальша потреба в закупівлі з використанням рамкової угоди",
"rationaleType": "noDemandFramework",
"modifications": {
"qualificationPeriod": {
"endDate": "2023-12-15T01:00:00+03:00"
}
},
"id": "1eab5245be984b00babf8f1521622c7c",
"previous": {
"qualificationPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2024-11-13T01:00:00+03:00"
}
},
"date": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
],
"id": "89208a5c9d04455eaa4c41e2b5f0d70a"
}
}
}
For more detail about signing the data with context: Additional sign data.
Then the signature should be added to change:
Request
POST /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/changes/1eab5245be984b00babf8f1521622c7c/documents?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "sign.p7s",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/894958610c6840238ceec5f7cb544a0c?Signature=vDdyFX4ziW7HMh449tX1ZnzukF%2BZeMtmSgxmJysOPGGIjoFFj720m9Y58okRB3m8PijO7qxUApWV1Pm8d%2FroCw%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/pkcs7-signature"
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/changes/1eab5245be984b00babf8f1521622c7c/documents/c9d5e1b072ce45ba90c94bf1af524d35
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "sign.p7s",
"format": "application/pkcs7-signature",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/894958610c6840238ceec5f7cb544a0c?Signature=HMPCR%2BXKqM3nPrpTkJ%2FyKDLZOgR%2BDx8EPTKvfykFgHWrtPf1hbGQQZGQBktK6D%2Bz5WK4iulCxJXyHgcHaPu0Bw%3D%3D&KeyID=a8968c46",
"language": "uk",
"id": "c9d5e1b072ce45ba90c94bf1af524d35",
"datePublished": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
}
If qualificationPeriod.endDate was changed all periods will be recalculated.
Let’s look at framework:
Request
GET /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"prettyID": "UA-F-2023-10-10-000001",
"title": "updated in draft status",
"description": "Назва предмета закупівлі1",
"status": "active",
"classification": {
"description": "Mustard seeds",
"scheme": "ДК021",
"id": "03111600-8"
},
"additionalClassifications": [
{
"scheme": "ДК003",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"documents": [
{
"id": "b15c3be7f3bd44fe80ce96043e893b9c",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/3d4ffdd9cb3e4b17a82a3c4ff17b9d36?Signature=tIDXH8wnBO3JBgUN3GoSoE4sW4BjxGNxkWSyxNiflNyarXJhL52k9CgC3cpQRNCO0JoJ2nrhXfCkIhHQJVVSCg%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
},
{
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a3b4750dd6e84c9ba06bcca72560bf2d?Signature=vCJf2VCGiuPf5SeqwD1awYCS9ZTLVHvhV3fzbpHLLC3w3Pr0UVL8oVBxYX8H7abDCBGS%2FLg7mix%2BK8hsWPTgAA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
},
{
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/2365a5fbfc964de2a60ddfb175a6cc42?Signature=EQ2YakEGQeWMwX3tiOKOcxsLShIUEa%2B7bB6wmpMCqaC99IWYdRUihRRIElynMe9Ko105jWenrapYnCDSRhGfDw%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
}
],
"agreementID": "4860703af9044dc19e30f45f4e537fb9",
"owner": "broker",
"date": "2023-10-10T01:00:00+03:00",
"dateCreated": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"period": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2023-11-15T00:00:00+02:00"
},
"qualificationPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2023-12-15T01:00:00+03:00"
},
"enquiryPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2023-10-25T00:00:00+03:00",
"clarificationsUntil": "2023-10-28T00:00:00+03:00"
},
"next_check": "2023-10-26T00:00:00+03:00",
"frameworkType": "internationalFinancialInstitutions",
"procuringEntity": {
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Назва організації"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220"
},
"contactPoint": {
"name": "зміна",
"telephone": "+0440000002",
"email": "ab@aa.com"
},
"kind": "general"
},
"changes": [
{
"rationale": "Відсутня подальша потреба в закупівлі з використанням рамкової угоди",
"rationaleType": "noDemandFramework",
"modifications": {
"qualificationPeriod": {
"endDate": "2023-12-15T01:00:00+03:00"
}
},
"id": "1eab5245be984b00babf8f1521622c7c",
"previous": {
"qualificationPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2024-11-13T01:00:00+03:00"
}
},
"date": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"documents": [
{
"hash": "md5:00000000000000000000000000000000",
"title": "sign.p7s",
"format": "application/pkcs7-signature",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/894958610c6840238ceec5f7cb544a0c?Signature=HMPCR%2BXKqM3nPrpTkJ%2FyKDLZOgR%2BDx8EPTKvfykFgHWrtPf1hbGQQZGQBktK6D%2Bz5WK4iulCxJXyHgcHaPu0Bw%3D%3D&KeyID=a8968c46",
"language": "uk",
"id": "c9d5e1b072ce45ba90c94bf1af524d35",
"datePublished": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
]
}
],
"id": "89208a5c9d04455eaa4c41e2b5f0d70a"
},
"config": {
"restrictedDerivatives": false,
"clarificationUntilDuration": 3,
"qualificationComplainDuration": 0,
"hasItems": false
}
}
There is a new object changes in framework with previous qualificationPeriod.endDate and new one. All period changes will be saved in this object.
Registering submission
After activating framework, users can register their submissions in period from framework.period.startDate to framework.period.endDate:
Request
POST /api/2.5/submissions HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"tenderers": [
{
"address": {
"countryName": "Україна",
"locality": "м. Вінниця",
"postalCode": "21100",
"region": "Вінницька область",
"streetAddress": "вул. Островського, 33"
},
"contactPoint": {
"email": "soleksuk@gmail.com",
"name": "Сергій Олексюк",
"telephone": "+380432216930"
},
"identifier": {
"scheme": "UA-EDR",
"legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
"id": "00137256",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Школяр»",
"scale": "micro"
}
],
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a"
},
"config": {
"restricted": false
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b
{
"data": {
"tenderers": [
{
"name": "ДКП «Школяр»",
"scale": "micro",
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/",
"legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"locality": "м. Вінниця",
"region": "Вінницька область",
"postalCode": "21100"
},
"contactPoint": {
"name": "Сергій Олексюк",
"telephone": "+380432216930",
"email": "soleksuk@gmail.com"
}
}
],
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a",
"status": "draft",
"submissionType": "internationalFinancialInstitutions",
"owner": "broker",
"date": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"id": "995d8a97b6c24a0cbe9ed82fe2cd8e8b"
},
"access": {
"token": "2cac1d46cb17481595607b2d32aef48f",
"transfer": "c36f4d407b944435a27a9eeaf46cd62e"
},
"config": {
"restricted": false
}
}
We have 201 Created response code, Location header and body with extra properties.
Uploading Submission documentation
Documents can be uploaded/changed only for submission in draft status.
Documents operations is same like in framework:
Request
POST /api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents?acc_token=2cac1d46cb17481595607b2d32aef48f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "submission_docs.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/07db5aa1fd3447f095c5729879cbba50?Signature=QTKoaklC0sxerp1WsNDLCHHYMzmXzI1z%2BdTJrBjFd1wf9mpsmrMzbW755MNMqV5%2FIcgBxM9rsE7U27PuQwkSDA%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/msword"
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents/8ee0bc18cff7439586d611936ba513a5
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "submission_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/07db5aa1fd3447f095c5729879cbba50?Signature=NH9XIEgn09VgF1sfuu%2F20ArTAa1mluQh4JRbQwpiui6Zq6KxFlKHN1FWCghmFuRDNHiNvaNLVmZ2UnVgIroZBA%3D%3D&KeyID=a8968c46",
"language": "uk",
"confidentiality": "public",
"id": "8ee0bc18cff7439586d611936ba513a5",
"datePublished": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
}
Request
GET /api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"hash": "md5:00000000000000000000000000000000",
"title": "submission_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/07db5aa1fd3447f095c5729879cbba50?Signature=NH9XIEgn09VgF1sfuu%2F20ArTAa1mluQh4JRbQwpiui6Zq6KxFlKHN1FWCghmFuRDNHiNvaNLVmZ2UnVgIroZBA%3D%3D&KeyID=a8968c46",
"language": "uk",
"confidentiality": "public",
"id": "8ee0bc18cff7439586d611936ba513a5",
"datePublished": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
]
}
Confidential documents for submissions
Documents can be public or confident.
Confidentiality may be applied/changed only for submission in draft status. It is required to add confidentialityRationale with confidentiality: buyerOnly.
Let’s add documents with confidentiality as buyerOnly and look what we’ve got:
Request
POST /api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents?acc_token=2cac1d46cb17481595607b2d32aef48f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "specs.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/7ff46ca9c18f4d0e8e9b8b6aaf9ad428?Signature=1Z81HgVCf0dTclzR4pS2d9QkblX2WnIeAZY1ncKeC1887DGqGjzo98Z4Y7Q02rC8chJPHJ%2FEGvVwk4aLN%2FdiAQ%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/msword",
"documentType": "technicalSpecifications",
"confidentiality": "buyerOnly"
}
}
Response
HTTP/1.0 422 Unprocessable Entity
Content-Type: application/json
{
"status": "error",
"errors": [
{
"location": "body",
"name": "confidentialityRationale",
"description": [
"confidentialityRationale is required"
]
}
]
}
Let’s add confidentialityRationale:
Request
POST /api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents?acc_token=2cac1d46cb17481595607b2d32aef48f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "specs.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/7f19dbc3120f4fb7b70d566828100d5c?Signature=qhgNS27d3zSXpKIENNezycN9dljIMkXaKNVb9yR9UhIHuBpM8DilYYUCylmmY%2BqyWHTP%2Bnfc5VVBC6tvr5W2AQ%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/msword",
"documentType": "technicalSpecifications",
"confidentiality": "buyerOnly",
"confidentialityRationale": "Дуже конфіденційний файл, треба приховати"
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents/0892dd79961a4b7e876f5542ed89ad17
{
"data": {
"documentType": "technicalSpecifications",
"hash": "md5:00000000000000000000000000000000",
"title": "specs.doc",
"format": "application/msword",
"url": "http://lb-api-sandbox.prozorro.gov.ua/api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents/0892dd79961a4b7e876f5542ed89ad17?download=7f19dbc3120f4fb7b70d566828100d5c",
"language": "uk",
"confidentialityRationale": "Дуже конфіденційний файл, треба приховати",
"confidentiality": "buyerOnly",
"id": "0892dd79961a4b7e876f5542ed89ad17",
"datePublished": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
}
The bidder and framework owner see these kind of documents and can download:
Request
GET /api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents/0892dd79961a4b7e876f5542ed89ad17?acc_token=2cac1d46cb17481595607b2d32aef48f HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"documentType": "technicalSpecifications",
"hash": "md5:00000000000000000000000000000000",
"title": "specs.doc",
"format": "application/msword",
"url": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents/0892dd79961a4b7e876f5542ed89ad17?download=7f19dbc3120f4fb7b70d566828100d5c",
"language": "uk",
"confidentialityRationale": "Дуже конфіденційний файл, треба приховати",
"confidentiality": "buyerOnly",
"id": "0892dd79961a4b7e876f5542ed89ad17",
"datePublished": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
}
All others can’t read the document:
Request
GET /api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents/0892dd79961a4b7e876f5542ed89ad17 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"documentType": "technicalSpecifications",
"hash": "md5:00000000000000000000000000000000",
"title": "specs.doc",
"format": "application/msword",
"language": "uk",
"confidentialityRationale": "Дуже конфіденційний файл, треба приховати",
"confidentiality": "buyerOnly",
"id": "0892dd79961a4b7e876f5542ed89ad17",
"datePublished": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
}
Nobody but the owner of submission and framework can download the confidential document:
Request
GET /api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents/0892dd79961a4b7e876f5542ed89ad17?download=1 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 403 Forbidden
Content-Type: application/json
{
"status": "error",
"errors": [
{
"location": "body",
"name": "data",
"description": "Document download forbidden."
}
]
}
Deleting submission
Submission can be deleted only in draft status:
Request
PATCH /api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b?acc_token=2cac1d46cb17481595607b2d32aef48f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"status": "deleted"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"tenderers": [
{
"name": "НАЗВА",
"scale": "micro",
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/",
"legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"locality": "м. Вінниця",
"region": "Вінницька область",
"postalCode": "21100"
},
"contactPoint": {
"name": "Сергій Олексюк",
"telephone": "+380432216930",
"email": "soleksuk@gmail.com"
}
}
],
"documents": [
{
"id": "8ee0bc18cff7439586d611936ba513a5",
"datePublished": "2023-10-26T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "submission_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/07db5aa1fd3447f095c5729879cbba50?Signature=NH9XIEgn09VgF1sfuu%2F20ArTAa1mluQh4JRbQwpiui6Zq6KxFlKHN1FWCghmFuRDNHiNvaNLVmZ2UnVgIroZBA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-26T01:00:00+03:00",
"language": "uk",
"confidentiality": "public"
},
{
"documentType": "technicalSpecifications",
"id": "0892dd79961a4b7e876f5542ed89ad17",
"datePublished": "2023-10-26T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "specs.doc",
"format": "application/msword",
"url": "http://lb-api-sandbox.prozorro.gov.ua/api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents/0892dd79961a4b7e876f5542ed89ad17?download=7f19dbc3120f4fb7b70d566828100d5c",
"dateModified": "2023-10-26T01:00:00+03:00",
"language": "uk",
"confidentiality": "buyerOnly",
"confidentialityRationale": "Дуже конфіденційний файл, треба приховати"
}
],
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a",
"status": "deleted",
"dateModified": "2023-10-26T01:00:00+03:00",
"date": "2023-10-26T01:00:00+03:00",
"owner": "broker",
"submissionType": "internationalFinancialInstitutions",
"id": "995d8a97b6c24a0cbe9ed82fe2cd8e8b"
},
"config": {
"restricted": false
}
}
Updating Submission
Submission can be changed only in draft status:
Request
PATCH /api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b?acc_token=2cac1d46cb17481595607b2d32aef48f HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"tenderers": [
{
"address": {
"countryName": "Україна",
"locality": "м. Вінниця",
"postalCode": "21100",
"region": "Вінницька область",
"streetAddress": "вул. Островського, 33"
},
"contactPoint": {
"email": "soleksuk@gmail.com",
"name": "Сергій Олексюк",
"telephone": "+380432216930"
},
"identifier": {
"scheme": "UA-EDR",
"legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
"id": "00137256",
"uri": "http://www.sc.gov.ua/"
},
"name": "НАЗВА",
"scale": "micro"
}
]
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"tenderers": [
{
"name": "НАЗВА",
"scale": "micro",
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/",
"legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"locality": "м. Вінниця",
"region": "Вінницька область",
"postalCode": "21100"
},
"contactPoint": {
"name": "Сергій Олексюк",
"telephone": "+380432216930",
"email": "soleksuk@gmail.com"
}
}
],
"documents": [
{
"id": "8ee0bc18cff7439586d611936ba513a5",
"datePublished": "2023-10-26T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "submission_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/07db5aa1fd3447f095c5729879cbba50?Signature=NH9XIEgn09VgF1sfuu%2F20ArTAa1mluQh4JRbQwpiui6Zq6KxFlKHN1FWCghmFuRDNHiNvaNLVmZ2UnVgIroZBA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-26T01:00:00+03:00",
"language": "uk",
"confidentiality": "public"
},
{
"documentType": "technicalSpecifications",
"id": "0892dd79961a4b7e876f5542ed89ad17",
"datePublished": "2023-10-26T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "specs.doc",
"format": "application/msword",
"url": "http://lb-api-sandbox.prozorro.gov.ua/api/2.5/submissions/995d8a97b6c24a0cbe9ed82fe2cd8e8b/documents/0892dd79961a4b7e876f5542ed89ad17?download=7f19dbc3120f4fb7b70d566828100d5c",
"dateModified": "2023-10-26T01:00:00+03:00",
"language": "uk",
"confidentiality": "buyerOnly",
"confidentialityRationale": "Дуже конфіденційний файл, треба приховати"
}
],
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a",
"status": "draft",
"dateModified": "2023-10-26T01:00:00+03:00",
"date": "2023-10-26T01:00:00+03:00",
"owner": "broker",
"submissionType": "internationalFinancialInstitutions",
"id": "995d8a97b6c24a0cbe9ed82fe2cd8e8b"
},
"config": {
"restricted": false
}
}
Submission activation
Submission can be activated before period.endDate
Request
PATCH /api/2.5/submissions/3da2f72300dc4a9f882583f13279d626?acc_token=7a97fc4aafce4fa893212f465a02b4b0 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"status": "active"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"tenderers": [
{
"name": "ДКП «Школяр»",
"scale": "micro",
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/",
"legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"locality": "м. Вінниця",
"region": "Вінницька область",
"postalCode": "21100"
},
"contactPoint": {
"name": "Сергій Олексюк",
"telephone": "+380432216930",
"email": "soleksuk@gmail.com"
}
}
],
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a",
"status": "active",
"dateModified": "2023-10-26T01:00:00+03:00",
"date": "2023-10-26T01:00:00+03:00",
"owner": "broker",
"submissionType": "internationalFinancialInstitutions",
"qualificationID": "61da52d3fbea49129c50b9171ce98c39",
"datePublished": "2023-10-26T01:00:00+03:00",
"id": "3da2f72300dc4a9f882583f13279d626"
},
"config": {
"restricted": false
}
}
After activating the submission, a qualification object is automatically created and submission qualificationID field is filled.
Let’s check what submission registry contains:
Request
GET /api/2.5/submissions HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"dateModified": "2023-10-26T01:00:00+03:00",
"id": "3da2f72300dc4a9f882583f13279d626"
}
],
"next_page": {
"offset": "1698271200.0.1.66fdc81d593130f879756ea4852ebad5",
"path": "/api/2.5/submissions?offset=1698271200.0.1.66fdc81d593130f879756ea4852ebad5",
"uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/submissions?offset=1698271200.0.1.66fdc81d593130f879756ea4852ebad5"
}
}
Let’s check created qualification object:
Request
GET /api/2.5/qualifications/61da52d3fbea49129c50b9171ce98c39 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a",
"submissionID": "3da2f72300dc4a9f882583f13279d626",
"qualificationType": "internationalFinancialInstitutions",
"status": "pending",
"date": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"id": "61da52d3fbea49129c50b9171ce98c39"
},
"config": {
"restricted": false,
"qualificationComplainDuration": 0
}
}
All operations with qualification object can do only framework_owner.
Uploading qualification documentation
Documents can be uploaded/changed only for qualification in pending status.
Documents operations is same like in framework:
Request
POST /api/2.5/qualifications/61da52d3fbea49129c50b9171ce98c39/documents?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "qualification.doc",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/5b3f7bd6512745f8aa676efc89dbeb46?Signature=m3Nga%2BoCcJjF5p9vtUmhiMVYYyIy0oIl4uWxbYj8ToXWClty9vuaiqdw12cgP7Tn%2FOKA3ZT8Ttq6DtuCJa%2FxDQ%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/msword"
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/qualifications/61da52d3fbea49129c50b9171ce98c39/documents/de1b17be13294eb89f5b48f6763575d7
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "qualification.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/5b3f7bd6512745f8aa676efc89dbeb46?Signature=HafRwGFXL%2BvgAl%2FkDMzxbaOpoWh3YjZb58%2BkOf6OKFH9XNyUQt7JFWJ0Diz2UNYkRW%2BO%2BlpGTu0uOQ9c2OwsAg%3D%3D&KeyID=a8968c46",
"language": "uk",
"id": "de1b17be13294eb89f5b48f6763575d7",
"datePublished": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
}
Request
GET /api/2.5/qualifications/61da52d3fbea49129c50b9171ce98c39/documents HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"hash": "md5:00000000000000000000000000000000",
"title": "qualification.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/5b3f7bd6512745f8aa676efc89dbeb46?Signature=HafRwGFXL%2BvgAl%2FkDMzxbaOpoWh3YjZb58%2BkOf6OKFH9XNyUQt7JFWJ0Diz2UNYkRW%2BO%2BlpGTu0uOQ9c2OwsAg%3D%3D&KeyID=a8968c46",
"language": "uk",
"id": "de1b17be13294eb89f5b48f6763575d7",
"datePublished": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
]
}
Canceled qualification
Qualification can be cancelled only in pending status.
Before cancelling qualification it is required to add sign document to qualification. If there is no sign document during cancelling, we will see an error:
Request
PATCH /api/2.5/qualifications/61da52d3fbea49129c50b9171ce98c39?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"status": "unsuccessful"
}
}
Response
HTTP/1.0 422 Unprocessable Entity
Content-Type: application/json
{
"status": "error",
"errors": [
{
"location": "body",
"name": "documents",
"description": "Document with type 'evaluationReports' and format pkcs7-signature is required"
}
]
}
Sign document should have documentType: evaluationReports and title: *.p7s. Let’s add such document:
Request
POST /api/2.5/qualifications/61da52d3fbea49129c50b9171ce98c39/documents?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "sign.p7s",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/c301888666eb496b836650f2f0c2ff8a?Signature=nU5q91m1UoocPCZHRli0w3PPz59ZvH9VrKriJ0JMe1ufB4QwbxA6U9uVK2jQMlGxukSGwL2wba9EpHu5XcUpAw%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/pkcs7-signature",
"documentType": "evaluationReports"
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/qualifications/61da52d3fbea49129c50b9171ce98c39/documents/26d0ce97ca2b4c2497ef490530723f58
{
"data": {
"documentType": "evaluationReports",
"hash": "md5:00000000000000000000000000000000",
"title": "sign.p7s",
"format": "application/pkcs7-signature",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/c301888666eb496b836650f2f0c2ff8a?Signature=wKR0t9cwE1N4k7CgKYjrDNjhHfhkSwDWNFdaLN5QOAD0197N2NUvOTJJBHG0%2Bj3JEauJ3W%2F0kZrt2%2F6F7PIfCA%3D%3D&KeyID=a8968c46",
"language": "uk",
"id": "26d0ce97ca2b4c2497ef490530723f58",
"datePublished": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
}
Then it is allowed to cancel qualification:
Request
PATCH /api/2.5/qualifications/61da52d3fbea49129c50b9171ce98c39?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"status": "unsuccessful"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"documents": [
{
"id": "de1b17be13294eb89f5b48f6763575d7",
"datePublished": "2023-10-26T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "qualification.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/5b3f7bd6512745f8aa676efc89dbeb46?Signature=HafRwGFXL%2BvgAl%2FkDMzxbaOpoWh3YjZb58%2BkOf6OKFH9XNyUQt7JFWJ0Diz2UNYkRW%2BO%2BlpGTu0uOQ9c2OwsAg%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-26T01:00:00+03:00",
"language": "uk"
},
{
"documentType": "evaluationReports",
"id": "26d0ce97ca2b4c2497ef490530723f58",
"datePublished": "2023-10-26T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "sign.p7s",
"format": "application/pkcs7-signature",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/c301888666eb496b836650f2f0c2ff8a?Signature=wKR0t9cwE1N4k7CgKYjrDNjhHfhkSwDWNFdaLN5QOAD0197N2NUvOTJJBHG0%2Bj3JEauJ3W%2F0kZrt2%2F6F7PIfCA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-26T01:00:00+03:00",
"language": "uk"
}
],
"submissionID": "3da2f72300dc4a9f882583f13279d626",
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a",
"status": "unsuccessful",
"date": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"qualificationType": "internationalFinancialInstitutions",
"id": "61da52d3fbea49129c50b9171ce98c39"
},
"config": {
"restricted": false,
"qualificationComplainDuration": 0
}
}
After cancelling qualification, related submission changed status from active to complete.
Let’s check what happen with submissions after cancelling qualification:
Request
GET /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/submissions HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"tenderers": [
{
"name": "ДКП «Школяр»",
"scale": "micro",
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/",
"legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"locality": "м. Вінниця",
"region": "Вінницька область",
"postalCode": "21100"
},
"contactPoint": {
"name": "Сергій Олексюк",
"telephone": "+380432216930",
"email": "soleksuk@gmail.com"
}
}
],
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a",
"status": "complete",
"dateCreated": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"date": "2023-10-26T01:00:00+03:00",
"qualificationID": "61da52d3fbea49129c50b9171ce98c39",
"datePublished": "2023-10-26T01:00:00+03:00",
"id": "3da2f72300dc4a9f882583f13279d626"
},
{
"tenderers": [
{
"name": "ДКП «Школяр»",
"scale": "micro",
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/",
"legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"locality": "м. Вінниця",
"region": "Вінницька область",
"postalCode": "21100"
},
"contactPoint": {
"name": "Сергій Олексюк",
"telephone": "+380432216930",
"email": "soleksuk@gmail.com"
}
}
],
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a",
"status": "complete",
"dateCreated": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"date": "2023-10-26T01:00:00+03:00",
"qualificationID": "78d4a13a5f274438a568fb8e618862a7",
"datePublished": "2023-10-26T01:00:00+03:00",
"id": "aabf4e9eda30494bb3f63598bb92b86a"
}
],
"next_page": {
"offset": "1698271200.0.2.b271e3d1e95e6e5bef5dad019e180f38",
"path": "/api/2.5/submissions?offset=1698271200.0.2.b271e3d1e95e6e5bef5dad019e180f38",
"uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/submissions?offset=1698271200.0.2.b271e3d1e95e6e5bef5dad019e180f38"
}
}
Approve qualification
Qualification can be approved only in pending status.
Before activating qualification it is required to add sign document to qualification. If there is no sign document during activation, we will see an error:
Request
PATCH /api/2.5/qualifications/78d4a13a5f274438a568fb8e618862a7?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"status": "active"
}
}
Response
HTTP/1.0 422 Unprocessable Entity
Content-Type: application/json
{
"status": "error",
"errors": [
{
"location": "body",
"name": "documents",
"description": "Document with type 'evaluationReports' and format pkcs7-signature is required"
}
]
}
Sign document should have documentType: evaluationReports and title: *.p7s. Let’s add such document:
Request
POST /api/2.5/qualifications/78d4a13a5f274438a568fb8e618862a7/documents?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"title": "sign.p7s",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/ec07f6afeca649b3a960652cfabb5b92?Signature=OxHbkZHci48PBQedo637HEgZyRzrxw7jHhP8h7aDAIaN0IgVGzcVF6wcgGJnJQ%2Bf5zJ9up%2FtbavEUj9OiQ71Ag%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/pkcs7-signature",
"documentType": "evaluationReports"
}
}
Response
HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/qualifications/78d4a13a5f274438a568fb8e618862a7/documents/02d9cb13241e4e2083301a56bd1cf208
{
"data": {
"documentType": "evaluationReports",
"hash": "md5:00000000000000000000000000000000",
"title": "sign.p7s",
"format": "application/pkcs7-signature",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/ec07f6afeca649b3a960652cfabb5b92?Signature=Mrrs75btJeZAunoMdcHhddBaNf6JNq1ODe1bGxi%2F6qAINmtyZivPLUE0LGmDCHCLgYjdpnNVHT4mhnuxlomuDg%3D%3D&KeyID=a8968c46",
"language": "uk",
"id": "02d9cb13241e4e2083301a56bd1cf208",
"datePublished": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
}
Then it is allowed to activate qualification:
Request
PATCH /api/2.5/qualifications/78d4a13a5f274438a568fb8e618862a7?acc_token=c029ed2daf2c446a9adf956529cf0bc3 HTTP/1.0
Authorization: Bearer broker
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua
{
"data": {
"status": "active"
}
}
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"documents": [
{
"documentType": "evaluationReports",
"id": "02d9cb13241e4e2083301a56bd1cf208",
"datePublished": "2023-10-26T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "sign.p7s",
"format": "application/pkcs7-signature",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/ec07f6afeca649b3a960652cfabb5b92?Signature=Mrrs75btJeZAunoMdcHhddBaNf6JNq1ODe1bGxi%2F6qAINmtyZivPLUE0LGmDCHCLgYjdpnNVHT4mhnuxlomuDg%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-26T01:00:00+03:00",
"language": "uk"
}
],
"submissionID": "aabf4e9eda30494bb3f63598bb92b86a",
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a",
"status": "active",
"date": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"qualificationType": "internationalFinancialInstitutions",
"id": "78d4a13a5f274438a568fb8e618862a7"
},
"config": {
"restricted": false,
"qualificationComplainDuration": 0
}
}
After approving qualification, if it was first active qualification system create agreement with contract otherwise system add contract to agreement.
Let’s check current framework
Request
GET /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"prettyID": "UA-F-2023-10-10-000001",
"title": "updated in draft status",
"description": "Назва предмета закупівлі",
"status": "active",
"classification": {
"description": "Mustard seeds",
"scheme": "ДК021",
"id": "03111600-8"
},
"additionalClassifications": [
{
"scheme": "ДК003",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"documents": [
{
"id": "b15c3be7f3bd44fe80ce96043e893b9c",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/3d4ffdd9cb3e4b17a82a3c4ff17b9d36?Signature=tIDXH8wnBO3JBgUN3GoSoE4sW4BjxGNxkWSyxNiflNyarXJhL52k9CgC3cpQRNCO0JoJ2nrhXfCkIhHQJVVSCg%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
},
{
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/a3b4750dd6e84c9ba06bcca72560bf2d?Signature=vCJf2VCGiuPf5SeqwD1awYCS9ZTLVHvhV3fzbpHLLC3w3Pr0UVL8oVBxYX8H7abDCBGS%2FLg7mix%2BK8hsWPTgAA%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
},
{
"id": "26e407ed90cf4b1f944de225426a7576",
"datePublished": "2023-10-10T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "framework_additional_docs.doc",
"format": "application/msword",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/2365a5fbfc964de2a60ddfb175a6cc42?Signature=EQ2YakEGQeWMwX3tiOKOcxsLShIUEa%2B7bB6wmpMCqaC99IWYdRUihRRIElynMe9Ko105jWenrapYnCDSRhGfDw%3D%3D&KeyID=a8968c46",
"dateModified": "2023-10-10T01:00:00+03:00",
"language": "uk"
}
],
"owner": "broker",
"date": "2023-10-10T01:00:00+03:00",
"dateCreated": "2023-10-10T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"qualificationPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2024-11-13T01:00:00+03:00"
},
"frameworkType": "internationalFinancialInstitutions",
"procuringEntity": {
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Назва організації"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220"
},
"contactPoint": {
"name": "Державне управління справами",
"telephone": "+0440000001",
"email": "aa@aa.com"
},
"kind": "general"
},
"enquiryPeriod": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2023-10-25T00:00:00+03:00",
"clarificationsUntil": "2023-10-28T00:00:00+03:00"
},
"period": {
"startDate": "2023-10-10T01:00:00+03:00",
"endDate": "2024-10-14T00:00:00+03:00"
},
"next_check": "2023-10-26T00:00:00+03:00",
"agreementID": "4860703af9044dc19e30f45f4e537fb9",
"id": "89208a5c9d04455eaa4c41e2b5f0d70a"
},
"config": {
"restrictedDerivatives": false,
"clarificationUntilDuration": 3,
"qualificationComplainDuration": 0,
"hasItems": false
}
}
You can see that agreementID appeared in current framework, so let’s check that agreement:
Request
GET /api/2.5/agreements/4860703af9044dc19e30f45f4e537fb9 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"agreementID": "UA-2023-10-26-000001",
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a",
"agreementType": "internationalFinancialInstitutions",
"status": "active",
"period": {
"startDate": "2023-10-26T01:00:00+03:00",
"endDate": "2024-11-13T01:00:00+03:00"
},
"procuringEntity": {
"name": "Державне управління справами",
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"legalName": "Назва організації"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ",
"region": "м. Київ",
"postalCode": "01220"
},
"contactPoint": {
"name": "Державне управління справами",
"telephone": "+0440000001",
"email": "aa@aa.com"
},
"kind": "general"
},
"classification": {
"description": "Mustard seeds",
"scheme": "ДК021",
"id": "03111600-8"
},
"additionalClassifications": [
{
"scheme": "ДК003",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"contracts": [
{
"id": "7ca7cc6e90f946359a8d2d151793e426",
"qualificationID": "78d4a13a5f274438a568fb8e618862a7",
"submissionID": "aabf4e9eda30494bb3f63598bb92b86a",
"status": "active",
"suppliers": [
{
"name": "ДКП «Школяр»",
"scale": "micro",
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/",
"legalName": "Державне комунальне підприємство громадського харчування «Школяр»"
},
"address": {
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"locality": "м. Вінниця",
"region": "Вінницька область",
"postalCode": "21100"
},
"contactPoint": {
"name": "Сергій Олексюк",
"telephone": "+380432216930",
"email": "soleksuk@gmail.com"
}
}
],
"milestones": [
{
"id": "53fd5467e77a4aa2b19d3f9c013aadb1",
"status": "scheduled",
"type": "activation",
"dueDate": "2024-11-13T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
],
"date": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00"
}
],
"owner": "broker",
"dateModified": "2023-10-26T01:00:00+03:00",
"date": "2023-10-26T01:00:00+03:00",
"next_check": "2024-11-13T01:00:00+03:00",
"dateCreated": "2023-10-26T01:00:00+03:00",
"id": "4860703af9044dc19e30f45f4e537fb9"
},
"config": {
"restricted": false
}
}
As you can see agreement now in active status, and already have contract, so we can see that agreement in agreement feed:
Request
GET /api/2.5/agreements HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"dateModified": "2023-10-26T01:00:00+03:00",
"id": "4860703af9044dc19e30f45f4e537fb9"
}
],
"next_page": {
"offset": "1698271200.0.1.30289bd45493ff45e04c4a27978b95be",
"path": "/api/2.5/agreements?offset=1698271200.0.1.30289bd45493ff45e04c4a27978b95be",
"uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/agreements?offset=1698271200.0.1.30289bd45493ff45e04c4a27978b95be"
}
}
Let’s check what qualification registry contains:
Request
GET /api/2.5/qualifications HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"dateModified": "2023-10-26T01:00:00+03:00",
"id": "61da52d3fbea49129c50b9171ce98c39"
},
{
"dateModified": "2023-10-26T01:00:00+03:00",
"id": "78d4a13a5f274438a568fb8e618862a7"
}
],
"next_page": {
"offset": "1698271200.0.2.6fa79395b636aedb511058f56a29aa72",
"path": "/api/2.5/qualifications?offset=1698271200.0.2.6fa79395b636aedb511058f56a29aa72",
"uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/qualifications?offset=1698271200.0.2.6fa79395b636aedb511058f56a29aa72"
}
}
Let’s check all qualifications for current framework:
Request
GET /api/2.5/frameworks/89208a5c9d04455eaa4c41e2b5f0d70a/qualifications HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua
Response
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": [
{
"documents": [
{
"id": "de1b17be13294eb89f5b48f6763575d7",
"datePublished": "2023-10-26T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "qualification.doc",
"format": "application/msword",
"url": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/qualifications/61da52d3fbea49129c50b9171ce98c39/documents/de1b17be13294eb89f5b48f6763575d7?download=5b3f7bd6512745f8aa676efc89dbeb46",
"dateModified": "2023-10-26T01:00:00+03:00",
"language": "uk"
},
{
"documentType": "evaluationReports",
"id": "26d0ce97ca2b4c2497ef490530723f58",
"datePublished": "2023-10-26T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "sign.p7s",
"format": "application/pkcs7-signature",
"url": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/qualifications/61da52d3fbea49129c50b9171ce98c39/documents/26d0ce97ca2b4c2497ef490530723f58?download=c301888666eb496b836650f2f0c2ff8a",
"dateModified": "2023-10-26T01:00:00+03:00",
"language": "uk"
}
],
"submissionID": "3da2f72300dc4a9f882583f13279d626",
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a",
"status": "unsuccessful",
"date": "2023-10-26T01:00:00+03:00",
"dateCreated": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"id": "61da52d3fbea49129c50b9171ce98c39"
},
{
"documents": [
{
"documentType": "evaluationReports",
"id": "02d9cb13241e4e2083301a56bd1cf208",
"datePublished": "2023-10-26T01:00:00+03:00",
"hash": "md5:00000000000000000000000000000000",
"title": "sign.p7s",
"format": "application/pkcs7-signature",
"url": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/qualifications/78d4a13a5f274438a568fb8e618862a7/documents/02d9cb13241e4e2083301a56bd1cf208?download=ec07f6afeca649b3a960652cfabb5b92",
"dateModified": "2023-10-26T01:00:00+03:00",
"language": "uk"
}
],
"submissionID": "aabf4e9eda30494bb3f63598bb92b86a",
"frameworkID": "89208a5c9d04455eaa4c41e2b5f0d70a",
"status": "active",
"date": "2023-10-26T01:00:00+03:00",
"dateCreated": "2023-10-26T01:00:00+03:00",
"dateModified": "2023-10-26T01:00:00+03:00",
"id": "78d4a13a5f274438a568fb8e618862a7"
}
],
"next_page": {
"offset": "1698271200.0.2.6fa79395b636aedb511058f56a29aa72",
"path": "/api/2.5/qualifications?offset=1698271200.0.2.6fa79395b636aedb511058f56a29aa72",
"uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/qualifications?offset=1698271200.0.2.6fa79395b636aedb511058f56a29aa72"
}
}
Framework completing
Framework is completed automatically at qualificationPeriod.endDate moment.
PATCH with new qualificationPeriod.endDate allow to complete framework earlier than was planned, but not earlier than 30 full calendar days from change moment.