API Reference¶
Tender Auction service at /tenders/{tender_id}/auction¶
GET¶
Get auction info.
Get tender auction info¶
Example request to get tender auction information:
GET /tenders/4879d3f8ee2443169b5fbbc9f89fa607/auction HTTP/1.1
Host: example.com
Accept: application/json
This is what one should expect in response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"modified": "2014-10-27T08:06:58.158Z",
"bids": [
{
"totalValue": {
"amount": 500,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
},
{
"totalValue": {
"amount": 485,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
}
],
"minimalStep":{
"amount": 35,
"currency": "UAH"
},
"tenderPeriod":{
"startDate": "2014-11-04T08:00:00"
}
}
}
Response: json
PATCH¶
Report auction results.
Report auction results¶
Example request to report auction results:
PATCH /tenders/4879d3f8ee2443169b5fbbc9f89fa607/auction HTTP/1.1
Host: example.com
Accept: application/json
{
"data": {
"modified": "2014-10-27T08:06:58.158Z",
"bids": [
{
"totalValue": {
"amount": 400,
"currency": "UAH"
}
},
{
"totalValue": {
"amount": 385,
"currency": "UAH"
}
}
]
}
}
This is what one should expect in response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"modified": "2014-10-27T08:06:58.158Z",
"bids": [
{
"totalValue": {
"amount": 400,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
},
{
"totalValue": {
"amount": 385,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
}
],
"minimalStep":{
"amount": 35,
"currency": "UAH"
},
"tenderPeriod":{
"startDate": "2014-11-04T08:00:00"
}
}
}
Response: json
Collection_Tender service at /tenders¶
Open Contracting compatible data exchange format. See http://ocds.open-contracting.org/standard/r/master/#tender for more info
GET¶
Tenders List
Get Tenders List¶
Example request to get tenders list:
GET /tenders HTTP/1.1
Host: example.com
Accept: application/json
This is what one should expect in response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"id": "64e93250be76435397e8c992ed4214d1",
"modified": "2014-10-27T08:06:58.158Z"
}
]
}
Response: json
POST¶
This API request is targeted to creating new Tenders by procuring organizations.
Creating new Tender¶
Example request to create tender:
POST /tenders HTTP/1.1
Host: example.com
Accept: application/json
{
"data": {
"procuringEntity": {
"id": {
"name": "Державне управління справами",
"scheme": "https://ns.openprocurement.org/ua/edrpou",
"uid": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"locality": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1"
}
},
"totalValue": {
"amount": 500,
"currency": "UAH",
"valueAddedTaxIncluded": true
},
"itemsToBeProcured": [
{
"description": "футляри до державних нагород",
"primaryClassification": {
"scheme": "CPV",
"id": "44617100-9",
"description": "Cartons"
},
"additionalClassification": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"unitOfMeasure": "item",
"quantity": 5
}
],
"enquiryPeriod": {
"endDate": "2014-10-31T00:00:00"
},
"tenderPeriod": {
"startDate": "2014-11-03T00:00:00",
"endDate": "2014-11-06T10:00:00"
},
"awardPeriod": {
"endDate": "2014-11-13T00:00:00"
},
"deliveryDate": {
"endDate": "2014-11-20T00:00:00"
},
"minimalStep": {
"amount": 35,
"currency": "UAH"
}
}
}
This is what one should expect in response:
HTTP/1.1 201 Created
Location: http://localhost/api/0.1/tenders/64e93250be76435397e8c992ed4214d1
Content-Type: application/json
{
"data": {
"id": "64e93250be76435397e8c992ed4214d1",
"tenderID": "UA-64e93250be76435397e8c992ed4214d1",
"modified": "2014-10-27T08:06:58.158Z",
"procuringEntity": {
"id": {
"name": "Державне управління справами",
"scheme": "https://ns.openprocurement.org/ua/edrpou",
"uid": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"locality": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1"
}
},
"totalValue": {
"amount": 500,
"currency": "UAH",
"valueAddedTaxIncluded": true
},
"itemsToBeProcured": [
{
"description": "футляри до державних нагород",
"primaryClassification": {
"scheme": "CPV",
"id": "44617100-9",
"description": "Cartons"
},
"additionalClassification": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"unitOfMeasure": "item",
"quantity": 5
}
],
"enquiryPeriod": {
"endDate": "2014-10-31T00:00:00"
},
"tenderPeriod": {
"startDate": "2014-11-03T00:00:00",
"endDate": "2014-11-06T10:00:00"
},
"awardPeriod": {
"endDate": "2014-11-13T00:00:00"
},
"deliveryDate": {
"endDate": "2014-11-20T00:00:00"
},
"minimalStep": {
"amount": 35,
"currency": "UAH"
}
}
}
Response: json
Tender service at /tenders/{id}¶
Open Contracting compatible data exchange format. See http://ocds.open-contracting.org/standard/r/master/#tender for more info
GET¶
Tender Read
Get Tender¶
Example request to get tender:
GET /tenders/64e93250be76435397e8c992ed4214d1 HTTP/1.1
Host: example.com
Accept: application/json
This is what one should expect in response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": {
"id": "64e93250be76435397e8c992ed4214d1",
"tenderID": "UA-64e93250be76435397e8c992ed4214d1",
"modified": "2014-10-27T08:06:58.158Z",
"procuringEntity": {
"id": {
"name": "Державне управління справами",
"scheme": "https://ns.openprocurement.org/ua/edrpou",
"uid": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"locality": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1"
}
},
"totalValue": {
"amount": 500,
"currency": "UAH",
"valueAddedTaxIncluded": true
},
"itemsToBeProcured": [
{
"description": "футляри до державних нагород",
"primaryClassification": {
"scheme": "CPV",
"id": "44617100-9",
"description": "Cartons"
},
"additionalClassification": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"unitOfMeasure": "item",
"quantity": 5
}
],
"enquiryPeriod": {
"endDate": "2014-10-31T00:00:00"
},
"tenderPeriod": {
"startDate": "2014-11-03T00:00:00",
"endDate": "2014-11-06T10:00:00"
},
"awardPeriod": {
"endDate": "2014-11-13T00:00:00"
},
"deliveryDate": {
"endDate": "2014-11-20T00:00:00"
},
"minimalStep": {
"amount": 35,
"currency": "UAH"
}
}
}
Response: json
PATCH¶
Tender Edit (partial)
For example here is how procuring entity can change number of items to be procured and total Value of a tender:
PATCH /tenders/4879d3f8ee2443169b5fbbc9f89fa607 HTTP/1.1
Host: example.com
Accept: application/json
{
"data": {
"totalValue": {
"amount": 600
},
"itemsToBeProcured": [
{
"quantity": 6
}
]
}
}
And here is the response to be expected:
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"id": "4879d3f8ee2443169b5fbbc9f89fa607",
"tenderID": "UA-64e93250be76435397e8c992ed4214d1",
"modified": "2014-10-27T08:12:34.956Z",
"totalValue": {
"amount": 600
},
"itemsToBeProcured": [
{
"quantity": 6
}
]
}
}
Response: json
Collection_Tender Documents service at /tenders/{tender_id}/documents¶
Tender related binary files (PDFs, etc.)
Tender Documents service at /tenders/{tender_id}/documents/{id}¶
Tender related binary files (PDFs, etc.)
Collection_Tender Bids service at /tenders/{tender_id}/bidders¶
Tender bidders
GET¶
Bids Listing
Get Bids List¶
Example request to get bids list:
GET /tenders/4879d3f8ee2443169b5fbbc9f89fa607/bidders HTTP/1.1
Host: example.com
Accept: application/json
This is what one should expect in response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"totalValue": {
"amount": 489,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
}
]
}
Response: json
POST¶
Registration of new bid proposal
Creating new Bid proposal¶
Example request to create bid proposal:
POST /tenders/4879d3f8ee2443169b5fbbc9f89fa607/bidders HTTP/1.1
Host: example.com
Accept: application/json
{
"data": {
"bidders": [
{
"id": {
"name": "Державне управління справами",
"scheme": "https://ns.openprocurement.org/ua/edrpou",
"uid": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"locality": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1"
}
}
],
"totalValue": {
"amount": 489,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
}
}
This is what one should expect in response:
HTTP/1.1 201 Created
Content-Type: application/json
{
"data": {
"id": "4879d3f8ee2443169b5fbbc9f89fa607",
"status": "registration",
"date": "2014-10-28T11:44:17.947Z",
"bidders": [
{
"id": {
"name": "Державне управління справами",
"scheme": "https://ns.openprocurement.org/ua/edrpou",
"uid": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"locality": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1"
}
}
],
"totalValue": {
"amount": 489,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
}
}
Response: json
Tender Bids service at /tenders/{tender_id}/bidders/{id}¶
Tender bidders
GET¶
Retrieving the proposal
Example request for retrieving the proposal:
GET /tenders/4879d3f8ee2443169b5fbbc9f89fa607/bidders/71b6c23ed8944d688e92a31ec8c3f61a HTTP/1.1
Host: example.com
Accept: application/json
And here is the response to be expected:
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"totalValue": {
"amount": 600,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
}
}
Response: json
DELETE¶
Cancelling the proposal
Example request for cancelling the proposal:
DELETE /tenders/4879d3f8ee2443169b5fbbc9f89fa607/bidders/71b6c23ed8944d688e92a31ec8c3f61a HTTP/1.1
Host: example.com
Accept: application/json
And here is the response to be expected:
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"totalValue": {
"amount": 489,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
}
}
Response: json
PATCH¶
Update of proposal
Example request to change bid proposal:
PATCH /tenders/4879d3f8ee2443169b5fbbc9f89fa607/bidders/71b6c23ed8944d688e92a31ec8c3f61a HTTP/1.1
Host: example.com
Accept: application/json
{
"data": {
"totalValue": {
"amount": 600
}
}
}
And here is the response to be expected:
HTTP/1.0 200 OK
Content-Type: application/json
{
"data": {
"totalValue": {
"amount": 600,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
}
}
Response: json
Collection_Tender Bid Documents service at /tenders/{tender_id}/bidders/{bid_id}/documents¶
Tender bidder documents
Tender Bid Documents service at /tenders/{tender_id}/bidders/{bid_id}/documents/{id}¶
Tender bidder documents
Collection_Tender Awards service at /tenders/{tender_id}/awards¶
Tender awards
GET¶
Tender Awards List
Get Awards List¶
Example request to get awards list:
GET /tenders/4879d3f8ee2443169b5fbbc9f89fa607/awards HTTP/1.1
Host: example.com
Accept: application/json
This is what one should expect in response:
HTTP/1.1 200 OK
Content-Type: application/json
{
"data": [
{
"awardStatus": "active",
"suppliers": [
{
"id": {
"name": "Державне управління справами",
"scheme": "https://ns.openprocurement.org/ua/edrpou",
"uid": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"locality": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1"
}
}
],
"awardValue": {
"amount": 489,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
}
]
}
Response: json
POST¶
Accept or reject bidder application
Creating new Award¶
Example request to create award:
POST /tenders/4879d3f8ee2443169b5fbbc9f89fa607/bidders HTTP/1.1
Host: example.com
Accept: application/json
{
"data": {
"awardStatus": "active",
"suppliers": [
{
"id": {
"name": "Державне управління справами",
"scheme": "https://ns.openprocurement.org/ua/edrpou",
"uid": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"locality": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1"
}
}
],
"awardValue": {
"amount": 489,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
}
}
This is what one should expect in response:
HTTP/1.1 201 Created
Content-Type: application/json
{
"data": {
"awardID": "4879d3f8ee2443169b5fbbc9f89fa607",
"awardDate": "2014-10-28T11:44:17.947Z",
"awardStatus": "active",
"suppliers": [
{
"id": {
"name": "Державне управління справами",
"scheme": "https://ns.openprocurement.org/ua/edrpou",
"uid": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"locality": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1"
}
}
],
"awardValue": {
"amount": 489,
"currency": "UAH",
"valueAddedTaxIncluded": true
}
}
}
Response: json
Tender Awards service at /tenders/{tender_id}/awards/{id}¶
Tender awards