Tutorial

Framework creation

Let’s create a framework:

Request

POST /api/2.5/frameworks HTTP/1.0
Authorization: Bearer broker
Content-Length: 1874
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "frameworkType": "dynamicPurchasingSystem",
    "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": "2023-12-09T01:00:00+03:00"
    }
  },
  "config": {
    "restrictedDerivatives": false
  }
}

Response

HTTP/1.0 201 Created
Content-Type: application/json
Location: http://lb-api-sandbox.prozorro.gov.ua/api/2.5/frameworks/4178f66eebf04c4497d0fb223feeb0fe

{
  "data": {
    "status": "draft",
    "title": "Узагальнена назва закупівлі",
    "description": "Назва предмета закупівлі",
    "qualificationPeriod": {
      "endDate": "2023-12-09T01:00:00+03:00"
    },
    "classification": {
      "description": "Mustard seeds",
      "scheme": "ДК021",
      "id": "03111600-8"
    },
    "additionalClassifications": [
      {
        "scheme": "ДК003",
        "id": "17.21.1",
        "description": "папір і картон гофровані, паперова й картонна тара"
      }
    ],
    "frameworkType": "dynamicPurchasingSystem",
    "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": "4178f66eebf04c4497d0fb223feeb0fe"
  },
  "access": {
    "token": "f8e6a2bdea5d45a086590324ce351932",
    "transfer": "d1b02fe7d70549d0a52fa552d2a36d38"
  },
  "config": {
    "restrictedDerivatives": 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/4178f66eebf04c4497d0fb223feeb0fe?acc_token=f8e6a2bdea5d45a086590324ce351932 HTTP/1.0
Authorization: Bearer broker
Content-Length: 113
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": "2023-12-09T01:00:00+03:00"
    },
    "frameworkType": "dynamicPurchasingSystem",
    "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": "4178f66eebf04c4497d0fb223feeb0fe"
  },
  "config": {
    "restrictedDerivatives": 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/4178f66eebf04c4497d0fb223feeb0fe/documents?acc_token=f8e6a2bdea5d45a086590324ce351932 HTTP/1.0
Authorization: Bearer broker
Content-Length: 326
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "title": "framework.doc",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/f5cb842886f141e681b47175faee1ea1?Signature=pHqDG1lqYutJy8U7HPCCyc8uax0f19KdoWORHwN5qVLAew5b0Hp96XPiixj3voULdWbi6yws6Dun%2BLrAjxL9CA%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/4178f66eebf04c4497d0fb223feeb0fe/documents/ecdce85901c748e3ba722d06c584a578

{
  "data": {
    "hash": "md5:00000000000000000000000000000000",
    "title": "framework.doc",
    "format": "application/msword",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/f5cb842886f141e681b47175faee1ea1?Signature=G7BvnAz3bGtcoEJQ4VMw2s9ARIPKFD0ZsNnTzvkGoYumAUv61r%2BTP0NXiTQhwebXxqUJM1d5aNg5AU8LtKBSCw%3D%3D&KeyID=a8968c46",
    "language": "uk",
    "id": "ecdce85901c748e3ba722d06c584a578",
    "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/4178f66eebf04c4497d0fb223feeb0fe/documents?acc_token=f8e6a2bdea5d45a086590324ce351932 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/f5cb842886f141e681b47175faee1ea1?Signature=G7BvnAz3bGtcoEJQ4VMw2s9ARIPKFD0ZsNnTzvkGoYumAUv61r%2BTP0NXiTQhwebXxqUJM1d5aNg5AU8LtKBSCw%3D%3D&KeyID=a8968c46",
      "language": "uk",
      "id": "ecdce85901c748e3ba722d06c584a578",
      "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/4178f66eebf04c4497d0fb223feeb0fe/documents?acc_token=f8e6a2bdea5d45a086590324ce351932 HTTP/1.0
Authorization: Bearer broker
Content-Length: 342
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/beda32f664fb459291d362e650147d5d?Signature=bYb8hxPMbpbofg8oIwNNwb9BUp9reoraHXU6GZblP7s7Pu8S4DU6fPKo1JCRGsJIZPd1fiAqqwl1k%2FCvpDTSBQ%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/4178f66eebf04c4497d0fb223feeb0fe/documents/f52dbfeff7274a58bf377da4cbc7cd26

{
  "data": {
    "hash": "md5:00000000000000000000000000000000",
    "title": "framework_additional_docs.doc",
    "format": "application/msword",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/beda32f664fb459291d362e650147d5d?Signature=pcYNBP%2FAj04nzgykslGVmqMOd3wtV9PptoB5NuzsDBne78GS2HGn9hmq%2ByTIhaYOr%2Bdtv6mO63IBY8NkQ3jrAg%3D%3D&KeyID=a8968c46",
    "language": "uk",
    "id": "f52dbfeff7274a58bf377da4cbc7cd26",
    "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/4178f66eebf04c4497d0fb223feeb0fe/documents/f52dbfeff7274a58bf377da4cbc7cd26?acc_token=f8e6a2bdea5d45a086590324ce351932 HTTP/1.0
Authorization: Bearer broker
Content-Length: 346
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/d369fa8572584fffba4fe7fb70daffe2?Signature=EmZiy1sJbyF%2B57PZ0EQiXmY%2BJlmcJialbXCJQKobt8GnBP%2BEE7hUt5RTQRWEDahAni80wQNTaqc6IzQZvDYNDw%3D%3D&KeyID=a8968c46",
    "hash": "md5:00000000000000000000000000000000",
    "format": "application/msword"
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "id": "f52dbfeff7274a58bf377da4cbc7cd26",
    "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/d369fa8572584fffba4fe7fb70daffe2?Signature=%2B8G4s2LtJtEl9ij7xF17ayvO5H1BxrBWc7bAMhNt6pn9JkPAOCocA1BAkf3wIPgRzu8bKDe4qvayMpJcnL%2FlAQ%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/4178f66eebf04c4497d0fb223feeb0fe/documents/f52dbfeff7274a58bf377da4cbc7cd26?acc_token=f8e6a2bdea5d45a086590324ce351932 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": "f52dbfeff7274a58bf377da4cbc7cd26",
    "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/d369fa8572584fffba4fe7fb70daffe2?Signature=%2B8G4s2LtJtEl9ij7xF17ayvO5H1BxrBWc7bAMhNt6pn9JkPAOCocA1BAkf3wIPgRzu8bKDe4qvayMpJcnL%2FlAQ%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/beda32f664fb459291d362e650147d5d?Signature=pcYNBP%2FAj04nzgykslGVmqMOd3wtV9PptoB5NuzsDBne78GS2HGn9hmq%2ByTIhaYOr%2Bdtv6mO63IBY8NkQ3jrAg%3D%3D&KeyID=a8968c46",
        "language": "uk",
        "id": "f52dbfeff7274a58bf377da4cbc7cd26",
        "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 30 and 1095 days from activation moment.

There should be at least 1 document in addition to sign document.

Request

PATCH /api/2.5/frameworks/4178f66eebf04c4497d0fb223feeb0fe?acc_token=f8e6a2bdea5d45a086590324ce351932 HTTP/1.0
Authorization: Bearer broker
Content-Length: 30
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": "ecdce85901c748e3ba722d06c584a578",
        "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/f5cb842886f141e681b47175faee1ea1?Signature=G7BvnAz3bGtcoEJQ4VMw2s9ARIPKFD0ZsNnTzvkGoYumAUv61r%2BTP0NXiTQhwebXxqUJM1d5aNg5AU8LtKBSCw%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "f52dbfeff7274a58bf377da4cbc7cd26",
        "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/beda32f664fb459291d362e650147d5d?Signature=pcYNBP%2FAj04nzgykslGVmqMOd3wtV9PptoB5NuzsDBne78GS2HGn9hmq%2ByTIhaYOr%2Bdtv6mO63IBY8NkQ3jrAg%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "f52dbfeff7274a58bf377da4cbc7cd26",
        "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/d369fa8572584fffba4fe7fb70daffe2?Signature=%2B8G4s2LtJtEl9ij7xF17ayvO5H1BxrBWc7bAMhNt6pn9JkPAOCocA1BAkf3wIPgRzu8bKDe4qvayMpJcnL%2FlAQ%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": {
      "endDate": "2023-12-09T01:00:00+03:00",
      "startDate": "2023-10-10T01:00:00+03:00"
    },
    "frameworkType": "dynamicPurchasingSystem",
    "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": "2023-11-09T00:00:00+02:00"
    },
    "next_check": "2023-11-08T00:00:00+03:00",
    "id": "4178f66eebf04c4497d0fb223feeb0fe"
  },
  "config": {
    "restrictedDerivatives": 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/4178f66eebf04c4497d0fb223feeb0fe 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": "ecdce85901c748e3ba722d06c584a578",
        "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/f5cb842886f141e681b47175faee1ea1?Signature=G7BvnAz3bGtcoEJQ4VMw2s9ARIPKFD0ZsNnTzvkGoYumAUv61r%2BTP0NXiTQhwebXxqUJM1d5aNg5AU8LtKBSCw%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "f52dbfeff7274a58bf377da4cbc7cd26",
        "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/beda32f664fb459291d362e650147d5d?Signature=pcYNBP%2FAj04nzgykslGVmqMOd3wtV9PptoB5NuzsDBne78GS2HGn9hmq%2ByTIhaYOr%2Bdtv6mO63IBY8NkQ3jrAg%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "f52dbfeff7274a58bf377da4cbc7cd26",
        "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/d369fa8572584fffba4fe7fb70daffe2?Signature=%2B8G4s2LtJtEl9ij7xF17ayvO5H1BxrBWc7bAMhNt6pn9JkPAOCocA1BAkf3wIPgRzu8bKDe4qvayMpJcnL%2FlAQ%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",
    "period": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-11-09T00:00:00+02:00"
    },
    "qualificationPeriod": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-12-09T01: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-11-08T00:00:00+03:00",
    "frameworkType": "dynamicPurchasingSystem",
    "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"
    },
    "agreementID": "a7900726fadb4012a73167666b9af707",
    "id": "4178f66eebf04c4497d0fb223feeb0fe"
  },
  "config": {
    "restrictedDerivatives": 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": "4178f66eebf04c4497d0fb223feeb0fe"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/frameworks?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/frameworks?offset=1698271200.0"
  }
}

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, endDate for qualificationPeriod, description and documents.

If qualificationPeriod.endDate was changed all periods will be recalculated.

Request

PATCH /api/2.5/frameworks/4178f66eebf04c4497d0fb223feeb0fe?acc_token=f8e6a2bdea5d45a086590324ce351932 HTTP/1.0
Authorization: Bearer broker
Content-Length: 360
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "procuringEntity": {
      "contactPoint": {
        "telephone": "+0440000002",
        "name": "зміна",
        "email": "ab@aa.com"
      }
    },
    "description": "Назва предмета закупівлі1",
    "qualificationPeriod": {
      "endDate": "2023-12-24T01:00:00+03:00"
    }
  }
}

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": "ecdce85901c748e3ba722d06c584a578",
        "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/f5cb842886f141e681b47175faee1ea1?Signature=G7BvnAz3bGtcoEJQ4VMw2s9ARIPKFD0ZsNnTzvkGoYumAUv61r%2BTP0NXiTQhwebXxqUJM1d5aNg5AU8LtKBSCw%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "f52dbfeff7274a58bf377da4cbc7cd26",
        "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/beda32f664fb459291d362e650147d5d?Signature=pcYNBP%2FAj04nzgykslGVmqMOd3wtV9PptoB5NuzsDBne78GS2HGn9hmq%2ByTIhaYOr%2Bdtv6mO63IBY8NkQ3jrAg%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "f52dbfeff7274a58bf377da4cbc7cd26",
        "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/d369fa8572584fffba4fe7fb70daffe2?Signature=%2B8G4s2LtJtEl9ij7xF17ayvO5H1BxrBWc7bAMhNt6pn9JkPAOCocA1BAkf3wIPgRzu8bKDe4qvayMpJcnL%2FlAQ%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      }
    ],
    "agreementID": "a7900726fadb4012a73167666b9af707",
    "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-24T00:00:00+02:00"
    },
    "qualificationPeriod": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-12-24T01: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-11-08T00:00:00+03:00",
    "frameworkType": "dynamicPurchasingSystem",
    "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": "4178f66eebf04c4497d0fb223feeb0fe"
  },
  "config": {
    "restrictedDerivatives": 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": "4178f66eebf04c4497d0fb223feeb0fe"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/frameworks?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/frameworks?offset=1698271200.0"
  }
}

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-Length: 1237
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": "4178f66eebf04c4497d0fb223feeb0fe"
  },
  "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/1a3c672e71594a09a9009ac58c77b120

{
  "data": {
    "tenderers": [
      {
        "name": "ДКП «Школяр»",
        "scale": "micro",
        "identifier": {
          "scheme": "UA-EDR",
          "id": "00137256",
          "legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
          "uri": "http://www.sc.gov.ua/"
        },
        "address": {
          "streetAddress": "вул. Островського, 33",
          "locality": "м. Вінниця",
          "region": "Вінницька область",
          "postalCode": "21100",
          "countryName": "Україна"
        },
        "contactPoint": {
          "name": "Сергій Олексюк",
          "email": "soleksuk@gmail.com",
          "telephone": "+380432216930"
        }
      }
    ],
    "frameworkID": "4178f66eebf04c4497d0fb223feeb0fe",
    "status": "draft",
    "submissionType": "dynamicPurchasingSystem",
    "owner": "broker",
    "date": "2023-10-26T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "id": "1a3c672e71594a09a9009ac58c77b120"
  },
  "access": {
    "token": "2eb4c1997d59433f8059f8a5c3f7527f",
    "transfer": "7e28dbd1bc4a4ae180b8c5d8717f7f24"
  },
  "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/1a3c672e71594a09a9009ac58c77b120/documents?acc_token=2eb4c1997d59433f8059f8a5c3f7527f HTTP/1.0
Authorization: Bearer broker
Content-Length: 336
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/46a9cf8cd1034d57b7e550b1c7bb0339?Signature=m8pEjAMzTTzsk4We7njaIzWu9J7f31SKITtDf15DVWrmfUh1Jth0BLO0NBGomcyDNmOyHrg%2F3Cjc%2F3yuIba%2FBA%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/1a3c672e71594a09a9009ac58c77b120/documents/8c587c07e098494086ec16f55b1f4285

{
  "data": {
    "hash": "md5:00000000000000000000000000000000",
    "title": "submission_docs.doc",
    "format": "application/msword",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/46a9cf8cd1034d57b7e550b1c7bb0339?Signature=CV6toqmVNh7aYzT8Sn0JjsdtsYR66FqDDLdqXszr49BvU7fkKFV59qITAmgwNxHwaNZ3mGH6rZH5LtzNFshCAQ%3D%3D&KeyID=a8968c46",
    "language": "uk",
    "id": "8c587c07e098494086ec16f55b1f4285",
    "datePublished": "2023-10-26T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00"
  }
}

Request

GET /api/2.5/submissions/1a3c672e71594a09a9009ac58c77b120/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/46a9cf8cd1034d57b7e550b1c7bb0339?Signature=CV6toqmVNh7aYzT8Sn0JjsdtsYR66FqDDLdqXszr49BvU7fkKFV59qITAmgwNxHwaNZ3mGH6rZH5LtzNFshCAQ%3D%3D&KeyID=a8968c46",
      "language": "uk",
      "id": "8c587c07e098494086ec16f55b1f4285",
      "datePublished": "2023-10-26T01:00:00+03:00",
      "dateModified": "2023-10-26T01:00:00+03:00"
    }
  ]
}

Deleting submission

Submission can be deleted only in draft status:

Request

PATCH /api/2.5/submissions/1a3c672e71594a09a9009ac58c77b120?acc_token=2eb4c1997d59433f8059f8a5c3f7527f HTTP/1.0
Authorization: Bearer broker
Content-Length: 31
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",
          "legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
          "uri": "http://www.sc.gov.ua/"
        },
        "address": {
          "streetAddress": "вул. Островського, 33",
          "locality": "м. Вінниця",
          "region": "Вінницька область",
          "postalCode": "21100",
          "countryName": "Україна"
        },
        "contactPoint": {
          "name": "Сергій Олексюк",
          "email": "soleksuk@gmail.com",
          "telephone": "+380432216930"
        }
      }
    ],
    "documents": [
      {
        "id": "8c587c07e098494086ec16f55b1f4285",
        "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/46a9cf8cd1034d57b7e550b1c7bb0339?Signature=CV6toqmVNh7aYzT8Sn0JjsdtsYR66FqDDLdqXszr49BvU7fkKFV59qITAmgwNxHwaNZ3mGH6rZH5LtzNFshCAQ%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-26T01:00:00+03:00",
        "language": "uk"
      }
    ],
    "frameworkID": "4178f66eebf04c4497d0fb223feeb0fe",
    "status": "deleted",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "date": "2023-10-26T01:00:00+03:00",
    "owner": "broker",
    "submissionType": "dynamicPurchasingSystem",
    "id": "1a3c672e71594a09a9009ac58c77b120"
  },
  "config": {
    "restricted": false
  }
}

Updating Submission

Submission can be changed only in draft status:

Request

PATCH /api/2.5/submissions/1a3c672e71594a09a9009ac58c77b120?acc_token=2eb4c1997d59433f8059f8a5c3f7527f HTTP/1.0
Authorization: Bearer broker
Content-Length: 69
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "tenderers": [
      {
        "name": "НАЗВА"
      }
    ]
  }
}

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "tenderers": [
      {
        "name": "НАЗВА",
        "scale": "micro",
        "identifier": {
          "scheme": "UA-EDR",
          "id": "00137256",
          "legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
          "uri": "http://www.sc.gov.ua/"
        },
        "address": {
          "streetAddress": "вул. Островського, 33",
          "locality": "м. Вінниця",
          "region": "Вінницька область",
          "postalCode": "21100",
          "countryName": "Україна"
        },
        "contactPoint": {
          "name": "Сергій Олексюк",
          "email": "soleksuk@gmail.com",
          "telephone": "+380432216930"
        }
      }
    ],
    "documents": [
      {
        "id": "8c587c07e098494086ec16f55b1f4285",
        "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/46a9cf8cd1034d57b7e550b1c7bb0339?Signature=CV6toqmVNh7aYzT8Sn0JjsdtsYR66FqDDLdqXszr49BvU7fkKFV59qITAmgwNxHwaNZ3mGH6rZH5LtzNFshCAQ%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-26T01:00:00+03:00",
        "language": "uk"
      }
    ],
    "frameworkID": "4178f66eebf04c4497d0fb223feeb0fe",
    "status": "draft",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "date": "2023-10-26T01:00:00+03:00",
    "owner": "broker",
    "submissionType": "dynamicPurchasingSystem",
    "id": "1a3c672e71594a09a9009ac58c77b120"
  },
  "config": {
    "restricted": false
  }
}

Submission activation

Submission can be activated before period.endDate

Request

PATCH /api/2.5/submissions/2b442aa99f344298bdd76797307adfd7?acc_token=3720f4f801594888bebca3b20c6877b3 HTTP/1.0
Authorization: Bearer broker
Content-Length: 30
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",
          "legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
          "uri": "http://www.sc.gov.ua/"
        },
        "address": {
          "streetAddress": "вул. Островського, 33",
          "locality": "м. Вінниця",
          "region": "Вінницька область",
          "postalCode": "21100",
          "countryName": "Україна"
        },
        "contactPoint": {
          "name": "Сергій Олексюк",
          "email": "soleksuk@gmail.com",
          "telephone": "+380432216930"
        }
      }
    ],
    "frameworkID": "4178f66eebf04c4497d0fb223feeb0fe",
    "status": "active",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "date": "2023-10-26T01:00:00+03:00",
    "owner": "broker",
    "submissionType": "dynamicPurchasingSystem",
    "datePublished": "2023-10-26T01:00:00+03:00",
    "qualificationID": "bc6f4b3647164e6286e78d8909d848c7",
    "id": "2b442aa99f344298bdd76797307adfd7"
  },
  "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": "2b442aa99f344298bdd76797307adfd7"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/submissions?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/submissions?offset=1698271200.0"
  }
}

Let’s check created qualification object:

Request

GET /api/2.5/qualifications/bc6f4b3647164e6286e78d8909d848c7 HTTP/1.0
Authorization: Bearer broker
Host: public-api-sandbox.prozorro.gov.ua

Response

HTTP/1.0 200 OK
Content-Type: application/json

{
  "data": {
    "submissionID": "2b442aa99f344298bdd76797307adfd7",
    "frameworkID": "4178f66eebf04c4497d0fb223feeb0fe",
    "status": "pending",
    "date": "2023-10-26T01:00:00+03:00",
    "qualificationType": "dynamicPurchasingSystem",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "id": "bc6f4b3647164e6286e78d8909d848c7"
  },
  "config": {}
}

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/bc6f4b3647164e6286e78d8909d848c7/documents?acc_token=f8e6a2bdea5d45a086590324ce351932 HTTP/1.0
Authorization: Bearer broker
Content-Length: 330
Content-Type: application/json
Host: lb-api-sandbox.prozorro.gov.ua

{
  "data": {
    "title": "qualification.doc",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/7150a692fd2b402d92a484375bfb60db?Signature=BHAhapA8GQgB5S4z2V%2FLFj2oxynHkeaZ1k1R1dzr7ai2QM7MXF8c2hn6sbzQmVl0nbvTKYzc02wYRktMZijSAg%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/bc6f4b3647164e6286e78d8909d848c7/documents/ff47cb123d934a4bb467e339b6e20776

{
  "data": {
    "hash": "md5:00000000000000000000000000000000",
    "title": "qualification.doc",
    "format": "application/msword",
    "url": "http://public-docs-sandbox.prozorro.gov.ua/get/7150a692fd2b402d92a484375bfb60db?Signature=UgEPCEpal%2BFRnsyybBE9MM%2F4WyYGaFxRHOiqivCYGdM6cou17uwuF9sF3m83LN9%2B4KUiM4plezab%2BpJRbTyPDw%3D%3D&KeyID=a8968c46",
    "language": "uk",
    "id": "ff47cb123d934a4bb467e339b6e20776",
    "datePublished": "2023-10-26T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00"
  }
}

Request

GET /api/2.5/qualifications/bc6f4b3647164e6286e78d8909d848c7/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/7150a692fd2b402d92a484375bfb60db?Signature=UgEPCEpal%2BFRnsyybBE9MM%2F4WyYGaFxRHOiqivCYGdM6cou17uwuF9sF3m83LN9%2B4KUiM4plezab%2BpJRbTyPDw%3D%3D&KeyID=a8968c46",
      "language": "uk",
      "id": "ff47cb123d934a4bb467e339b6e20776",
      "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.

Request

PATCH /api/2.5/qualifications/bc6f4b3647164e6286e78d8909d848c7?acc_token=f8e6a2bdea5d45a086590324ce351932 HTTP/1.0
Authorization: Bearer broker
Content-Length: 36
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": "ff47cb123d934a4bb467e339b6e20776",
        "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/7150a692fd2b402d92a484375bfb60db?Signature=UgEPCEpal%2BFRnsyybBE9MM%2F4WyYGaFxRHOiqivCYGdM6cou17uwuF9sF3m83LN9%2B4KUiM4plezab%2BpJRbTyPDw%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-26T01:00:00+03:00",
        "language": "uk"
      }
    ],
    "submissionID": "2b442aa99f344298bdd76797307adfd7",
    "frameworkID": "4178f66eebf04c4497d0fb223feeb0fe",
    "status": "unsuccessful",
    "date": "2023-10-26T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "qualificationType": "dynamicPurchasingSystem",
    "id": "bc6f4b3647164e6286e78d8909d848c7"
  },
  "config": {}
}

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/4178f66eebf04c4497d0fb223feeb0fe/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",
            "legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
            "uri": "http://www.sc.gov.ua/"
          },
          "address": {
            "streetAddress": "вул. Островського, 33",
            "locality": "м. Вінниця",
            "region": "Вінницька область",
            "postalCode": "21100",
            "countryName": "Україна"
          },
          "contactPoint": {
            "name": "Сергій Олексюк",
            "email": "soleksuk@gmail.com",
            "telephone": "+380432216930"
          }
        }
      ],
      "qualificationID": "bc6f4b3647164e6286e78d8909d848c7",
      "frameworkID": "4178f66eebf04c4497d0fb223feeb0fe",
      "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",
      "datePublished": "2023-10-26T01:00:00+03:00",
      "id": "2b442aa99f344298bdd76797307adfd7"
    },
    {
      "tenderers": [
        {
          "name": "ДКП «Школяр»",
          "scale": "micro",
          "identifier": {
            "scheme": "UA-EDR",
            "id": "00137256",
            "legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
            "uri": "http://www.sc.gov.ua/"
          },
          "address": {
            "streetAddress": "вул. Островського, 33",
            "locality": "м. Вінниця",
            "region": "Вінницька область",
            "postalCode": "21100",
            "countryName": "Україна"
          },
          "contactPoint": {
            "name": "Сергій Олексюк",
            "email": "soleksuk@gmail.com",
            "telephone": "+380432216930"
          }
        }
      ],
      "qualificationID": "eb806357c18c47699e716411551fd638",
      "frameworkID": "4178f66eebf04c4497d0fb223feeb0fe",
      "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",
      "datePublished": "2023-10-26T01:00:00+03:00",
      "id": "bf2ce393748f44d59d1843fe54e318e8"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/submissions?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/submissions?offset=1698271200.0"
  }
}

Approve qualification

Qualification can be approved only in pending status.

Request

PATCH /api/2.5/qualifications/eb806357c18c47699e716411551fd638?acc_token=f8e6a2bdea5d45a086590324ce351932 HTTP/1.0
Authorization: Bearer broker
Content-Length: 30
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": {
    "submissionID": "bf2ce393748f44d59d1843fe54e318e8",
    "frameworkID": "4178f66eebf04c4497d0fb223feeb0fe",
    "status": "active",
    "date": "2023-10-26T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "qualificationType": "dynamicPurchasingSystem",
    "id": "eb806357c18c47699e716411551fd638"
  },
  "config": {}
}

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/4178f66eebf04c4497d0fb223feeb0fe 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": "ecdce85901c748e3ba722d06c584a578",
        "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/f5cb842886f141e681b47175faee1ea1?Signature=G7BvnAz3bGtcoEJQ4VMw2s9ARIPKFD0ZsNnTzvkGoYumAUv61r%2BTP0NXiTQhwebXxqUJM1d5aNg5AU8LtKBSCw%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "f52dbfeff7274a58bf377da4cbc7cd26",
        "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/beda32f664fb459291d362e650147d5d?Signature=pcYNBP%2FAj04nzgykslGVmqMOd3wtV9PptoB5NuzsDBne78GS2HGn9hmq%2ByTIhaYOr%2Bdtv6mO63IBY8NkQ3jrAg%3D%3D&KeyID=a8968c46",
        "dateModified": "2023-10-10T01:00:00+03:00",
        "language": "uk"
      },
      {
        "id": "f52dbfeff7274a58bf377da4cbc7cd26",
        "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/d369fa8572584fffba4fe7fb70daffe2?Signature=%2B8G4s2LtJtEl9ij7xF17ayvO5H1BxrBWc7bAMhNt6pn9JkPAOCocA1BAkf3wIPgRzu8bKDe4qvayMpJcnL%2FlAQ%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",
    "period": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-11-09T00:00:00+02:00"
    },
    "qualificationPeriod": {
      "startDate": "2023-10-10T01:00:00+03:00",
      "endDate": "2023-12-09T01: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-11-08T00:00:00+03:00",
    "frameworkType": "dynamicPurchasingSystem",
    "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"
    },
    "agreementID": "a7900726fadb4012a73167666b9af707",
    "id": "4178f66eebf04c4497d0fb223feeb0fe"
  },
  "config": {
    "restrictedDerivatives": false
  }
}

You can see that agreementID appeared in current framework, so let’s check that agreement:

Request

GET /api/2.5/agreements/a7900726fadb4012a73167666b9af707 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",
    "status": "active",
    "period": {
      "startDate": "2023-10-26T01:00:00+03:00",
      "endDate": "2023-12-09T01:00:00+03:00"
    },
    "contracts": [
      {
        "id": "08418f5f19004ac89b0c136850bd4df2",
        "qualificationID": "eb806357c18c47699e716411551fd638",
        "status": "active",
        "submissionID": "bf2ce393748f44d59d1843fe54e318e8",
        "suppliers": [
          {
            "name": "ДКП «Школяр»",
            "identifier": {
              "scheme": "UA-EDR",
              "id": "00137256",
              "legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
              "uri": "http://www.sc.gov.ua/"
            },
            "scale": "micro",
            "contactPoint": {
              "name": "Сергій Олексюк",
              "email": "soleksuk@gmail.com",
              "telephone": "+380432216930"
            },
            "address": {
              "streetAddress": "вул. Островського, 33",
              "locality": "м. Вінниця",
              "region": "Вінницька область",
              "postalCode": "21100",
              "countryName": "Україна"
            }
          }
        ],
        "milestones": [
          {
            "id": "4ade676cc95843e9b70f919aa3c0fb5c",
            "type": "activation",
            "status": "scheduled",
            "dueDate": "2023-12-09T01:00:00+03:00",
            "dateModified": "2023-10-26T01:00:00+03:00"
          }
        ],
        "date": "2023-10-26T01:00:00+03:00"
      }
    ],
    "dateCreated": "2023-10-26T01:00:00+03:00",
    "dateModified": "2023-10-26T01:00:00+03:00",
    "date": "2023-10-26T01:00:00+03:00",
    "owner": "broker",
    "agreementType": "dynamicPurchasingSystem",
    "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"
    },
    "frameworkID": "4178f66eebf04c4497d0fb223feeb0fe",
    "classification": {
      "description": "Mustard seeds",
      "scheme": "ДК021",
      "id": "03111600-8"
    },
    "additionalClassifications": [
      {
        "scheme": "ДК003",
        "id": "17.21.1",
        "description": "папір і картон гофровані, паперова й картонна тара"
      }
    ],
    "next_check": "2023-12-09T01:00:00+03:00",
    "id": "a7900726fadb4012a73167666b9af707"
  },
  "config": {}
}

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": "a7900726fadb4012a73167666b9af707"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/agreements?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/agreements?offset=1698271200.0"
  }
}

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": "bc6f4b3647164e6286e78d8909d848c7"
    },
    {
      "dateModified": "2023-10-26T01:00:00+03:00",
      "id": "eb806357c18c47699e716411551fd638"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/qualifications?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/qualifications?offset=1698271200.0"
  }
}

Let’s check all qualifications for current framework:

Request

GET /api/2.5/frameworks/4178f66eebf04c4497d0fb223feeb0fe/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": "ff47cb123d934a4bb467e339b6e20776",
          "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/bc6f4b3647164e6286e78d8909d848c7/documents/ff47cb123d934a4bb467e339b6e20776?download=7150a692fd2b402d92a484375bfb60db",
          "dateModified": "2023-10-26T01:00:00+03:00",
          "language": "uk"
        }
      ],
      "submissionID": "2b442aa99f344298bdd76797307adfd7",
      "frameworkID": "4178f66eebf04c4497d0fb223feeb0fe",
      "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": "bc6f4b3647164e6286e78d8909d848c7"
    },
    {
      "submissionID": "bf2ce393748f44d59d1843fe54e318e8",
      "frameworkID": "4178f66eebf04c4497d0fb223feeb0fe",
      "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": "eb806357c18c47699e716411551fd638"
    }
  ],
  "next_page": {
    "offset": 1698271200.0,
    "path": "/api/2.5/qualifications?offset=1698271200.0",
    "uri": "http://public-api-sandbox.prozorro.gov.ua/api/2.5/qualifications?offset=1698271200.0"
  }
}

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.