Welcome to openprocurement.auctions.appraisal documentation!¶
Please report any problems or suggestions for improvement either via the mailing list or the issue tracker.
Contents:
Overview¶
openprocurement.auctions.appraisal describes the process of insider auction.
The procurementMethodType (type of the procedure) is appraisal.insider.
Features¶
- Auction consists of 3 stages: Dutch auction, sealed bid and best bid parts.
- The only date Organizer has to provide is a preferable day for the auction (
auctionPeriod.startDate
), the rest will be calculated automatically. - Bidders can enter the auction till the end of the Dutch part (tenderPeriod.endDate = auctionPeriod.startDate + Dutch part duration).
- Bids with the value mentioned will be rejected.
- Auction.value is gradually decreasing per 1% during the Dutch part.
- Bidders can’t delete their bids within the first part of the auction.
- The maximum (and default) number of steps within the Dutch part is 99.
- In case of no bid has been made within Dutch auction, the whole procedure will be marked as unsuccessful.
Conventions¶
API accepts JSON or form-encoded content in requests. It returns JSON content in all of its responses, including errors. Only the UTF-8 character encoding is supported for both requests and responses.
All API POST and PUT requests expect a top-level object with a single element in it named data. Successful responses will mirror this format. The data element should itself be an object, containing the parameters for the request. In the case of creating a new auction, these are the fields we want to set on the auction itself.
If the request was successful, we will get a response code of 201 indicating the object was created. That response will have a data field at its top level, which will contain complete information on the new auction, including its ID.
If something went wrong during the request, we’ll get a different status code and the JSON returned will have an errors field at the top level containing a list of problems. We look at the first one and print out its message.
Project status¶
The project has pre alpha status.
The source repository for this project is on GitHub: https://github.com/openprocurement/openprocurement.auctions.appraisal.
API stability¶
API is relatively stable. The changes in the API are communicated via Open Procurement API maillist.
Procedure Workflow¶
Status Workflow¶
Roles¶
Chronograph: | solid |
---|---|
Organizer: | dashed |
Status¶
Status | Description |
---|---|
draft | draft of procedure |
active.tendering | tendering period (tendering) |
active.auction | auction period (auction) |
active.qualification | winner qualification (qualification) |
active.awarded | standstill period (standstill) |
unsuccessful | unsuccessful auction (unsuccessful) |
complete | complete auction (complete) |
cancelled | cancelled auction (cancelled) |
Data Standard¶
Data standard is modelled along the Open Contracting Standard with extensions in areas that were not covered by it.
Auction¶
Schema¶
id: | uid, auto-generated, read-only Internal id of procedure. |
---|---|
auctionID: | string, auto-generated, read-only The auction identifier to refer auction to in “paper” documentation. OpenContracting Description: It is included to make the flattened data structure more convenient. |
date: | Date, auto-generated, read-only The date of the procedure creation/undoing. |
owner: | string, auto-generated, read-only The entity whom the procedure has been created by. |
lotIdentifier: | string, required Identification number of lot in paper documentation. |
title: | string, multilingual, required
Optionally can be mentioned in English/Russian. The name of the auction, displayed in listings. |
description: | string, multilingual, required OpenContracting Description: A description of the goods, services to be provided.
|
tenderAttempts: | integer, optional The number which represents what time procedure with a current lot takes place. |
procurementMethod: | |
string, auto-generated, read-only Purchase method. The only value is “open”. |
|
procurementMethodType: | |
string, required Type of the procedure within the auction announcement. The appropriate value is appraisal.insider. |
|
procurementMethodDetails: | |
string, optional Parameter that accelerates auction periods. Set quick, accelerator=1440 as text value for procurementMethodDetails for the time frames to be reduced in 1440 times. Can be used in sandbox mode only. |
|
submissionMethod: | |
string, auto-generated, read-only The given value is electronicAuction. |
|
submissionMethodDetails: | |
string, optional Parameter that works only with mode = “test” and speeds up auction start date. Can be used in sandbox mode only. |
|
procuringEntity: | |
ProcuringEntity (Organizer), required Organization conducting the auction. OpenContracting Description: The entity managing the procurement, which may be different from the buyer who is paying / using the items being procured. |
|
auctionParameters: | |
The parameters that indicates the major specifications of the procedure. |
|
value: | Value, required OpenContracting Description: The total estimated value of the procurement. |
minimalStep: | Value, auto-generated, read-only Auction step (increment). minimalStep.value that will be always automatically set is 0. |
guarantee: | Guarantee, required The assumption of responsibility for payment of performance of some obligation if the liable party fails to perform to expectations. |
registrationFee: | |
Guarantee, required The sum of money required to enroll on an official register. |
|
bankAccount: | Bank Account, optional Details which uniquely identify a bank account, and are used when making or receiving a payment. |
items: | Array of Item objects, required List that contains single item being sold. OpenContracting Description: The goods and services to be purchased, broken into line items wherever possible. Items should not be duplicated, but a quantity of 2 specified instead. |
documents: | Array of Document objects OpenContracting Description: All documents and attachments related to the auction. |
dateModified: | Date, auto-generated, read-only OpenContracting Description: Date when the auction was last modified. |
questions: | Array of Question objects, optional Questions to procuringEntity and answers to them. |
bids: | Array of Bid objects A list of all bids placed in the auction with information about participants, their proposals and other qualification documentation. OpenContracting Description: A list of all the companies who entered submissions for the auction. |
awards: | Array of Award objects All qualifications (disqualifications and awards). |
awardCriteria: | string, auto-generated, read-only The given value is highestCost. |
contracts: | Array of Contract objects OpenContracting Description: Information on contracts signed as part of a process. |
cancellations: | Array of Cancellation objects, optional Contains 1 object with active status in case of cancelled Auction. The Cancellation object describes the reason of auction cancellation and contains accompanying documents if there are any. |
auctionUrl: | url, auto-generated, read-only A web address where auction is accessible for view. |
status: | string, required |
Status | Description |
---|---|
draft | draft of procedure |
active.tendering | tendering period (tendering) |
active.auction | auction period (auction) |
active.qualification | winner qualification (qualification) |
active.awarded | standstill period (standstill) |
unsuccessful | unsuccessful procedure (unsuccessful) |
complete | complete procedure (complete) |
cancelled | cancelled procedure (cancelled) |
enquiryPeriod: | Period, auto-generated, read-only Period when questions are allowed. OpenContracting Description: The period during which enquiries may be made and will be answered. |
---|---|
tenderPeriod: | Period, auto-generated, read-only Period when bids can be submitted. OpenContracting Description: The period when the auction is open for submissions. The end date is the closing date for auction submissions. |
auctionPeriod: | Period, auto-generated, read-only ( Period when Auction is conducted. startDate should be provided. |
awardPeriod: | Period, auto-generated, read-only Awarding process period. OpenContracting Description: The date or period on which an award is anticipated to be made. |
mode: | string, optional The additional parameter with a value test. |
Auction Parameters¶
Schema¶
type: | string, auto-generated, read-only Type of the auction. |
---|---|
dutchSteps: | integer, optional Number of steps within the Dutch auction phase. The default value is 99. |
Bank Account¶
Schema¶
description: | string, multilingual, optional Additional information that has to be noted from the Organizer point.
|
---|---|
bankName: | string, required Name of the bank. |
accountIdentification: | |
Array of Classification, required Major data on the account details of the state entity selling a lot, to facilitate payments at the end of the process. Most frequently used are:
|
Fields that can be edited in active.tendering status¶
- title
- title_en
- title_ru
- description
- description_en
- description_ru
- tenderAttempts
- lotIdentifier
- value
- minimalStep
- guarantee
- items
- bankAccount
- registrationFee
Organization¶
Schema¶
name: | string, multilingual, optional Name of the organization. |
---|---|
identifier: | Identifier, required The primary identifier for this organization. |
additionalIdentifiers: | |
Array of Identifier objects |
|
address: | Address, required |
contactPoint: | ContactPoint, required |
additionalContactPoints: | |
Array of ContactPoint objects, optional |
Identifier¶
Schema¶
scheme: | string, required OpenContracting Description: Organization identifiers be drawn from an existing identification scheme. This field is used to indicate the scheme or codelist in which the identifier will be found. This value should be drawn from the Organization Identifier Scheme. |
---|---|
id: | string, required OpenContracting Description: The identifier of the organization in the selected scheme. The allowed codes are the ones found in “Organisation Registration Agency” codelist of IATI Standard with addition of UA-EDR code for organizations registered in Ukraine (EDRPOU and IPN). |
legalName: | string, multilingual, optional OpenContracting Description: The legally registered name of the organization. Full legal name (e.g. Nadra Bank). |
uri: | uri, optional OpenContracting Description: A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the url field of the Organization contact point. |
Address¶
Schema¶
streetAddress: | string, optional OpenContracting Description: The street address. For example, 1600 Amphitheatre Pkwy. |
---|---|
locality: | string, optional OpenContracting Description: The locality. For example, Mountain View. |
region: | string, optional OpenContracting Description: The region. For example, CA. |
postalCode: | string, optional OpenContracting Description: The postal code. For example, 94043. |
countryName: | string, required OpenContracting Description: The country name. For example, United States. |
ContactPoint¶
Schema¶
name: | string, multilingual, required OpenContracting Description: The name of the contact person, department, or contact point, for correspondence relating to this contracting process. |
---|---|
email: | OpenContracting Description: The e-mail address of the contact point/person. |
telephone: | string OpenContracting Description: The telephone number of the contact point/person. This should include the international dialling code. |
faxNumber: | string, optional OpenContracting Description: The fax number of the contact point/person. This should include the international dialling code. |
url: | URL, optional OpenContracting Description: A web address for the contact point/person. |
Either email or telephone field has to be provided.
Item¶
Schema¶
id: | uuid, auto-generated Internal identifier for this item. |
||||||
---|---|---|---|---|---|---|---|
description: | string, multilingual, required OpenContracting Description: A description of the goods, services to be provided.
|
||||||
classification: | Classification, required OpenContracting Description: The primary classification for the item. See the itemClassificationScheme to identify preferred classification lists. It is required for classification.scheme to be CPV or CAV-PS. The classification.id should be valid CPV or CAV-PS code. |
||||||
additionalClassifications: | |||||||
Array of Classification objects, optional OpenContracting Description: An array of additional classifications for the item. See the itemClassificationScheme codelist for common options to use in OCDS. This may also be used to present codes from an internal classification scheme. |
|||||||
unit: | Unit, required OpenContracting Description: Description of the unit which the good comes in e.g. hours, kilograms. Made up of a unit name, and the value of a single unit. |
||||||
quantity: | decimal, required OpenContracting Description: The number of units required. |
||||||
address: | Address, required Address, where item is located. |
||||||
location: | dictionary, optional Geographical coordinates of the location. Element consists of the following items:
location usually takes precedence over address if both are present. |
Classification¶
Schema¶
scheme: | string, required OpenContracting Description: A classification should be drawn from an existing scheme or list of codes. This field is used to indicate the scheme/codelist from which the classification is drawn. For line item classifications, this value should represent a known Item Classification Scheme wherever possible. |
---|---|
id: | string, required OpenContracting Description: The classification code drawn from the selected scheme. |
description: | string, required OpenContracting Description: A textual description or title for the code. |
uri: | uri, optional OpenContracting Description: A URI to identify the code. In the event individual URIs are not available for items in the identifier scheme this value should be left blank. |
Unit¶
Schema¶
code: | string, required UN/CEFACT Recommendation 20 unit code. |
---|---|
name: | string, optional OpenContracting Description: Name of the unit |
Registration Details¶
Schema¶
status: | string, required Possible values are:
|
||||||
---|---|---|---|---|---|---|---|
registrationID: | string, optional The document identifier to refer to in the paper documentation. Available for mentioning in status: complete. |
||||||
registrationDate: | |||||||
Date, optional OpenContracting Description: The date on which the document was first published. |
Document¶
Schema¶
id: | string, auto-generated |
---|---|
documentType: | string, required Possible values for Auction or Item
Possible values for Bid
Commercial offers of the auction participants.
Documents confirming the qualification of the participant.
Documents confirming the compliance of the participant with the requirements.
A license that allows you to work with financial documents. Possible values for Cancellation
Document containing information on the reasons for cancellation. Possible values for Award
Documentation of the winning bid, including, wherever applicable, a full copy of the proposal received.
A protocol that allows a contestant to become a winner. Loaded when only one bid was made.
Auction protocol describes all participants and determines the candidate (participant that has submitted the highest bid proposal during the auction).
Documents containing the reasons for termination of work with the participant.
Documents containing the reasons for termination of work with the participant. Possible values for Contract
The formal notice that gives details of a contract being signed and valid to start implementation. This may be a link to a downloadable document, to a web page, or to an official gazette in which the notice is contained.
A copy of the signed contract. Consider providing both machine-readable (e.g. original PDF, Word or Open Document format files), and a separate document entry for scanned-signed pages where this is required.
Copies of annexes and other supporting documentation related to the contract.
Documents containing the reasons for termination of work with the participant.
Documents containing the reasons for termination of work with the participant. |
title: | string, multilingual, required OpenContracting Description: The document title. |
description: | string, multilingual, optional OpenContracting Description: A short description of the document. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document. |
index: | integer, optional Sorting (display order) parameter used for illustrations. The smaller number is, the higher illustration is in the sorting. If index is not specified, illustration will be displayed the last. If two illustrations have the same index, they will be sorted depending on their publishing date. |
format: | string, optional OpenContracting Description: The format of the document taken from the IANA Media Types code list, with the addition of one extra value for ‘offline/print’, used when this document entry is being used to describe the offline publication of a document. |
url: | string, auto-generated OpenContracting Description: Direct link to the document or attachment. |
datePublished: | string, Date, auto-generated OpenContracting Description: The date on which the document was first published. |
dateModified: | string, Date, auto-generated OpenContracting Description: Date that the document was last modified |
language: | string, optional OpenContracting Description: Specifies the language of the linked document using either two-digit ISO 639-1, or extended BCP47 language tags. |
documentOf: | string, required Possible values are:
|
relatedItem: | string, optional Internal ID of related Item. |
accessDetails: | string, optional Required for x_dgfAssetFamiliarization document. |
Bid¶
Schema¶
tenderers: | List of Organization objects, required |
---|---|
date: | string, Date, auto-generated Date when bid has been submitted. |
id: | uid, auto-generated Internal identifire of bid. |
status: | string, required Possible values are:
|
value: | Value, required Validation rules:
|
documents: | Array of Document, optional All documents needed. |
participationUrl: | |
URL, auto-generated A web address for participation in auction. |
|
qualified: | bool, required Confirms the absence of grounds for refusal to participate. CDB accepts only true value. |
eligible: | bool, optional Confirms compliance of eligibility criteria set by the customer in the tendering documents. CDB accepts only true value. |
Award¶
Schema¶
id: | string, auto-generated, read-only OpenContracting Description: Identifier for this award. |
---|---|
bid_id: | string, auto-generated, read-only The ID of a bid that the award relates to. |
status: | string, required OpenContracting Description: The current status of the award drawn from the awardStatus codelist. Possible values are:
|
verificationPeriod: | |
Period, auto-generated, read-only The period of uploading (for the auction winner) and verification (for the bank) of the auction protocol |
|
signingPeriod: | Period, auto-generated, read-only The period for the contract to be activated in the system (by the bank) |
date: | string, Date, auto-generated, read-only OpenContracting Description: The date of the contract award. |
value: | Value object, auto-generated, read-only OpenContracting Description: The total value of this award. |
suppliers: | Array of Organization objects, auto-generated, read-only OpenContracting Description: The suppliers awarded with this award. |
items: | Array of Item objects, auto-generated, read-only OpenContracting Description: The goods and services awarded in this award, broken into line items wherever possible. Items should not be duplicated, but the quantity should be specified instead. |
documents: | Array of Document objects, required OpenContracting Description: All documents and attachments related to the award, including any notices. |
Question¶
Schema¶
id: | uuid, auto-generated, read-only Internal identifier of the object within an array. |
---|---|
author: | Organization, required Who is asking a question (contactPoint - person, identification - organization that person represents). |
title: | string, required Title of the question. |
description: | string, optional Description of the question. |
date: | Date, auto-generated, read-only Date of posting. |
answer: | string, optional Answer for the question. |
questionOf: | string, required Possible values are:
|
relatedItem: | string, optional ID of related Item. |
Contract¶
Schema¶
id: | uuid, auto-generated OpenContracting Description: The identifier for this contract. |
---|---|
awardID: | string, required, auto-generated OpenContracting Description: The Award.id against which this contract is being issued. |
contractID: | string, auto-generated, read-only OpenContracting Description: The Contract.id against which this contract is being issued. |
contractNumber: | string, optional |
value: | Value object, auto-generated, read-only OpenContracting Description: The total value of this contract. |
items: | Array of Item objects, auto-generated, read-only OpenContracting Description: The goods, services, and any intangible outcomes in this contract. Note: If the items are the same as the award, do not repeat. |
suppliers: | Array of Organization objects, auto-generated, read-only |
status: | string, required OpenContracting Description: The current status of the contract. Possible values are:
|
dateSigned: | string, Date OpenContracting Description: The date the contract was signed. In the case of multiple signatures, the date of the last signature. |
signingPeriod: |
OpenContracting Description: The start and end date for the contract signing. |
datePaid: | string, Date OpenContracting Description: The date the contract was paid. |
date: | string, Date The date when the contract was changed or activated. |
documents: | Array of Document objects OpenContracting Description: All documents and attachments related to the contract, including any notices. |
Period¶
Date¶
Date/time in Date Format: ISO 8601.
Value¶
Schema¶
amount: | float, required OpenContracting Description: Amount as a number. Should be positive. |
---|---|
currency: | string, required OpenContracting Description: The currency in 3-letter ISO 4217 format. |
valueAddedTaxIncluded: | |
bool, optional Value by default is True. |
Guarantee¶
Schema¶
amount: | float, required OpenContracting Description: Amount as a number. Should be positive. |
---|---|
currency: | string, required, default = UAH OpenContracting Description: The currency in 3-letter ISO 4217 format. |
Cancellation¶
Schema¶
id: | uuid, auto-generated, read-only Internal identifier of the object within an array. |
||||
---|---|---|---|---|---|
reason: | string, multilingual, required The reason, why auction is being cancelled. |
||||
status: | string, required
|
||||
documents: | Array of Document objects, optional Documents accompanying the Cancellation: Protocol of Auction Committee with decision to cancel the Auction. |
||||
date: | string, Date, auto-generated Cancellation date. |
||||
cancellationOf: | string, required Possible values are:
|
ProcuringEntity (Organizer)¶
Schema¶
name: | string, multilingual, optional OpenContracting Description: The common name of the organization. |
---|---|
identifier: | Identifier, required OpenContracting Description: The primary identifier for this organization. |
additionalIdentifiers: | |
Array of Identifier objects |
|
address: | Address, required |
contactPoint: | ContactPoint, required |
kind: | string, optional Type of organizer
|
Award Workflow¶
Procedure Workflow for 1 Submitted Bid¶
Award Section¶
Legend¶
* protocol is uploaded and award is switched to active by the organizer.
** organizer has decided to disqualify the bidder.
~ organizer switched contract to cancelled.
Contract Section¶
Legend¶
* document was uploaded to contract. The contract itself was successfully activated by the organizer.
** there was no document uploaded. The organizer refused to activate the contract.
Roles¶
Chronograph: | solid |
---|---|
Organizer: | dashed |
Procedure Description¶
The procedure receives active.qualification status.
The award with the qualifying bid initially receives pending status.The process enters the verificationPeriod with the auto-generated duration of 0-6 business days. During this term the organizer uploads the protocol (documentType: auctionProtocol) first and manually switches award to active status then. Simultaneously the awarding process enters the signingPeriod phase and the procedure receives active.awarded status.
2.1 If the organizer decides to disqualify the bidder, a document (documentType: rejectionProtocol or act) has to be uploaded first and the award has to be manually switched to unsuccessful then.
When the qualification procedure enters the signingPeriod stage, which lasts up to 20 days from the beginning of the bidder qualification process. The contract of the qualifying bid initially receives a pending status. Within this time, the organizer should upload the document (documentType: contractSigned) in the system and manually switch contract to active status in order to successfully finish the qualification procedure.
3.1 For the bidder to be disqualified a document (documentType: rejectionProtocol or act) has to be uploaded first and the contract has to be manually switched to cancelled by the organizer then. When all of the actions are done, award will receive unsuccessful status.
Procedure Workflow for 2 Submitted Bids or More¶
Award Section¶
Legend¶
Blue nodes represent statuses for the 2nd award ONLY
* award for winner is always formed in pending.
** protocol is uploaded and award is switched to active by the organizer.
*** organizer has decided to disqualify the bidder.
~ organizer switched contract to cancelled.
Roles¶
Chronograph: | solid |
---|---|
Organizer: | dashed |
Participant: | dotted |
Contract Section¶
Legend¶
* document was uploaded to contract. The contract itself was successfully activated by the organizer.
** there was no document uploaded. The organizer refused to activate the contract.
Roles¶
Chronograph: | solid |
---|---|
Organizer: | dashed |
Procedure Description¶
The procedure receives active.qualification status.
The award with the highest qualifying bid initially receives pending status. The process enters the verificationPeriod with the auto-generated duration of 0-6 business days. During this term the organizer uploads the protocol (documentType: auctionProtocol) first and manually switches award to active status then. Simultaneously the procedure enters the signingPeriod phase and the procedure receives active.awarded status.
2.1 If the organizer decides to disqualify the bidder, a document (documentType: rejectionProtocol or act) has to be uploaded first and the award has to be manually switched to unsuccessful then.
3. When the qualification procedure enters the signingPeriod stage, which lasts up to 20 days from the beginning of the bidder qualification process. The contract of the qualifying bid initially receives a pending status. Within this time, the organizer should upload the document (documentType: contractSigned) in the system and manually switch contract to active status in order to successfully finish the qualification procedure.
3.1 For the bidder to be disqualified a document (documentType: rejectionProtocol or act) has to be uploaded first and the contract has to be manually switched to cancelled by the organizer then. As long as such an action is done, award status will receive unsuccessful.
- The second highest qualifying bidder, immediately after the auction ending receives the pending.waiting status, in which by default they agree to wait for the end of the qualification of the highest qualifying bidder to be eligible to go through the qualification process if the highest bidder is disqualified. The only action that they can make is to manually cancel the award decision (switch award to cancelled status) - withdraw the security deposit and lose the chance to become a winner of the auction. If that is done and the first highest qualifying bidder becomes unsuccessful, the procedure receives the unsuccessful status. Provided that first award gets disqualified while the second has not disqualified themselves, the second award automatically changes its status from pending.waiting to pending, after which they undergo the same qualification procedure as outlined above for the first award.
Notes¶
- The auto-generated period duration does not influence the actions which can be done.
- The organizer can disqualify the award at any stage of the awarding process up to the moment, when a document with the documentType: contractSigned has been uploaded.
- The second highest qualifying bidder can disqualify themselves at any point in time BEFORE the start of their qualification process.
Statuses¶
pending: |
|
||||
---|---|---|---|---|---|
active: |
|
||||
unsuccessful: | Terminal status of award. Rejection protocol or act (documentType: rejectionProtocol/act) was uploaded so that the award could be switched to unsuccessful by the organizer. Or when the contract becomes status cancelled, the status of the award will be unsuccessful. |
||||
cancelled: | Terminal status of contract. Rejection protocol or act (documentType: rejectionProtocol/act) was uploaded so that the contract could be switched to cancelled by the organizer. |
Tutorial¶
Exploring basic rules¶
Let’s try exploring the /auctions endpoint:
GET /api/2.5/auctions HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"next_page": {
"path": "/api/2.5/auctions?offset=",
"uri": "http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions?offset=",
"offset": ""
},
"data": []
}
Just invoking it reveals empty set.
Now let’s attempt creating some auction:
POST /api/2.5/auctions?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 4
Content-Type: application/x-www-form-urlencoded
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 415 Unsupported Media Type
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"status": "error",
"errors": [
{
"description": "Content-Type header should be one of ['application/json']",
"location": "header",
"name": "Content-Type"
}
]
}
Error states that the only accepted Content-Type is application/json.
Let’s satisfy the Content-type requirement:
POST /api/2.5/auctions?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 4
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 422 Unprocessable Entity
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"status": "error",
"errors": [
{
"description": "Expecting value: line 1 column 1 (char 0)",
"location": "body",
"name": "data"
}
]
}
Error states that no data has been found in JSON body.
Creating auction¶
Let’s create auction:
POST /api/2.5/auctions?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 2434
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"lotIdentifier": "Q24421K222",
"documents": [
{
"format": "application/msword",
"title": "укр.doc",
"accessDetails": "access details",
"documentType": "x_dgfAssetFamiliarization"
}
],
"description": "description of appraisal auction",
"title": "футляри до державних нагород",
"auctionPeriod": {
"startDate": "2019-02-07T12:32:10.895130"
},
"tenderAttempts": 1,
"procurementMethodType": "appraisal.insider",
"value": {
"currency": "UAH",
"amount": 100
},
"procuringEntity": {
"contactPoint": {
"name": "Державне управління справами",
"telephone": "0440000000"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"name": "Державне управління справами",
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ"
}
},
"items": [
{
"unit": {
"code": "44617100-9",
"name": "item"
},
"address": {
"countryName": "Україна",
"postalCode": "79000",
"region": "м. Київ",
"streetAddress": "вул. Банкова 1",
"locality": "м. Київ"
},
"description": "Земля для військовослужбовців",
"classification": {
"scheme": "CPV",
"id": "51413000-0",
"description": "Земельні ділянки"
},
"quantity": 5
}
],
"auctionParameters": {
"type": "insider",
"dutchSteps": 88
},
"registrationFee": {
"currency": "UAH",
"amount": 700.87
},
"guarantee": {
"currency": "UAH",
"amount": 1000.99
}
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23
X-Content-Type-Options: nosniff
{
"access": {
"transfer": "bedb1a0ffdea449aad05c8cdf0f8c6be",
"token": "4cc54038a92f4f578a435ca9cb041343"
},
"data": {
"procurementMethod": "open",
"auctionID": "UA-EA-2019-01-28-000002",
"enquiryPeriod": {
"startDate": "2019-01-28T12:32:17.146983+02:00",
"endDate": "2019-02-06T20:00:00+02:00"
},
"registrationFee": {
"currency": "UAH",
"amount": 700.87
},
"submissionMethod": "electronicAuction",
"awardCriteria": "highestCost",
"owner": "broker",
"id": "e0c4d484a95140569171138086703f23",
"description": "description of appraisal auction",
"title": "футляри до державних нагород",
"tenderAttempts": 1,
"auctionParameters": {
"type": "insider",
"dutchSteps": 88
},
"guarantee": {
"currency": "UAH",
"amount": 1000.99
},
"dateModified": "2019-01-28T12:32:17.168827+02:00",
"status": "draft",
"tenderPeriod": {
"startDate": "2019-01-28T12:32:17.146983+02:00",
"endDate": "2019-02-07T16:15:00+02:00"
},
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"procurementMethodType": "appraisal.insider",
"date": "2019-01-28T12:32:17.146983+02:00",
"lotIdentifier": "Q24421K222",
"rectificationPeriod": {
"startDate": "2019-01-28T12:32:17.146983+02:00",
"endDate": "2019-01-31T16:15:00+02:00"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"items": [
{
"description": "Земля для військовослужбовців",
"classification": {
"scheme": "CPV",
"description": "Земельні ділянки",
"id": "51413000-0"
},
"address": {
"postalCode": "79000",
"countryName": "Україна",
"streetAddress": "вул. Банкова 1",
"region": "м. Київ",
"locality": "м. Київ"
},
"id": "46ff602897964fdeb334c4a55e9bc9d7",
"unit": {
"code": "44617100-9",
"name": "item"
},
"quantity": 5
}
],
"value": {
"currency": "UAH",
"amount": 100.0,
"valueAddedTaxIncluded": true
},
"procuringEntity": {
"contactPoint": {
"name": "Державне управління справами",
"telephone": "0440000000"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"name": "Державне управління справами",
"address": {
"postalCode": "01220",
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"region": "м. Київ",
"locality": "м. Київ"
}
}
}
}
Success! Now we can see that new object has been created. Response code is 201 and Location response header reports the location of the created object. The body of response reveals the information about the created auction: its internal id (that matches the Location segment), its official auctionID and dateModified datestamp stating the moment in time when auction has been last modified. Pay attention to the procurementMethodType. Note that the procedure is created in draft status, so you need to manually switch it to active.tendering.
PATCH /api/2.5/auctions/e0c4d484a95140569171138086703f23 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 40
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
X-Access-Token: 4cc54038a92f4f578a435ca9cb041343
DATA:
{
"data": {
"status": "active.tendering"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"procurementMethod": "open",
"auctionID": "UA-EA-2019-01-28-000002",
"enquiryPeriod": {
"startDate": "2019-01-28T12:32:17.146983+02:00",
"endDate": "2019-02-06T20:00:00+02:00"
},
"registrationFee": {
"currency": "UAH",
"amount": 700.87
},
"submissionMethod": "electronicAuction",
"next_check": "2019-02-06T20:00:00+02:00",
"awardCriteria": "highestCost",
"owner": "broker",
"id": "e0c4d484a95140569171138086703f23",
"description": "description of appraisal auction",
"title": "футляри до державних нагород",
"tenderAttempts": 1,
"auctionParameters": {
"type": "insider",
"dutchSteps": 88
},
"guarantee": {
"currency": "UAH",
"amount": 1000.99
},
"dateModified": "2019-01-28T12:32:17.260260+02:00",
"status": "active.tendering",
"tenderPeriod": {
"startDate": "2019-01-28T12:32:17.146983+02:00",
"endDate": "2019-02-07T16:15:00+02:00"
},
"auctionPeriod": {
"shouldStartAfter": "2019-02-07T00:00:00+02:00"
},
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"procurementMethodType": "appraisal.insider",
"date": "2019-01-28T12:32:17.260260+02:00",
"lotIdentifier": "Q24421K222",
"rectificationPeriod": {
"startDate": "2019-01-28T12:32:17.146983+02:00",
"endDate": "2019-01-31T16:15:00+02:00",
"invalidationDate": "2019-01-28T12:32:17.257914+02:00"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"items": [
{
"description": "Земля для військовослужбовців",
"classification": {
"scheme": "CPV",
"description": "Земельні ділянки",
"id": "51413000-0"
},
"address": {
"postalCode": "79000",
"countryName": "Україна",
"streetAddress": "вул. Банкова 1",
"region": "м. Київ",
"locality": "м. Київ"
},
"id": "46ff602897964fdeb334c4a55e9bc9d7",
"unit": {
"code": "44617100-9",
"name": "item"
},
"quantity": 5
}
],
"value": {
"currency": "UAH",
"amount": 100.0,
"valueAddedTaxIncluded": true
},
"procuringEntity": {
"contactPoint": {
"name": "Державне управління справами",
"telephone": "0440000000"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"name": "Державне управління справами",
"address": {
"postalCode": "01220",
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"region": "м. Київ",
"locality": "м. Київ"
}
}
}
}
Let’s access the URL of the created object (the Location header of the response):
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"procurementMethod": "open",
"auctionID": "UA-EA-2019-01-28-000002",
"enquiryPeriod": {
"startDate": "2019-01-28T12:32:17.146983+02:00",
"endDate": "2019-02-06T20:00:00+02:00"
},
"registrationFee": {
"currency": "UAH",
"amount": 700.87
},
"submissionMethod": "electronicAuction",
"next_check": "2019-02-06T20:00:00+02:00",
"awardCriteria": "highestCost",
"owner": "broker",
"id": "e0c4d484a95140569171138086703f23",
"description": "description of appraisal auction",
"title": "футляри до державних нагород",
"tenderAttempts": 1,
"auctionParameters": {
"type": "insider",
"dutchSteps": 88
},
"guarantee": {
"currency": "UAH",
"amount": 1000.99
},
"dateModified": "2019-01-28T12:32:17.260260+02:00",
"status": "active.tendering",
"tenderPeriod": {
"startDate": "2019-01-28T12:32:17.146983+02:00",
"endDate": "2019-02-07T16:15:00+02:00"
},
"auctionPeriod": {
"shouldStartAfter": "2019-02-07T00:00:00+02:00"
},
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"procurementMethodType": "appraisal.insider",
"date": "2019-01-28T12:32:17.260260+02:00",
"lotIdentifier": "Q24421K222",
"rectificationPeriod": {
"startDate": "2019-01-28T12:32:17.146983+02:00",
"endDate": "2019-01-31T16:15:00+02:00",
"invalidationDate": "2019-01-28T12:32:17.257914+02:00"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"items": [
{
"description": "Земля для військовослужбовців",
"classification": {
"scheme": "CPV",
"description": "Земельні ділянки",
"id": "51413000-0"
},
"address": {
"postalCode": "79000",
"countryName": "Україна",
"streetAddress": "вул. Банкова 1",
"region": "м. Київ",
"locality": "м. Київ"
},
"id": "46ff602897964fdeb334c4a55e9bc9d7",
"unit": {
"code": "44617100-9",
"name": "item"
},
"quantity": 5
}
],
"value": {
"currency": "UAH",
"amount": 100.0,
"valueAddedTaxIncluded": true
},
"procuringEntity": {
"contactPoint": {
"name": "Державне управління справами",
"telephone": "0440000000"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"name": "Державне управління справами",
"address": {
"postalCode": "01220",
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"region": "м. Київ",
"locality": "м. Київ"
}
}
}
}
We can see the same response we got after creating auction.
Let’s see what listing of auctions reveals us:
GET /api/2.5/auctions HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"next_page": {
"path": "/api/2.5/auctions?offset=2019-01-28T12%3A32%3A16.843339%2B02%3A00",
"uri": "http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions?offset=2019-01-28T12%3A32%3A16.843339%2B02%3A00",
"offset": "2019-01-28T12:32:16.843339+02:00"
},
"data": [
{
"id": "3fead5d747954a879aa64ef0852cd77a",
"dateModified": "2019-01-28T12:32:16.843339+02:00"
}
]
}
We do see the auction’s internal id and its dateModified datestamp.
Let’s try creating auction with more data:
POST /api/2.5/auctions?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 2463
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"lotIdentifier": "Q24421K222",
"documents": [
{
"format": "application/msword",
"title": "укр.doc",
"accessDetails": "access details",
"documentType": "x_dgfAssetFamiliarization"
}
],
"description": "description of appraisal auction",
"title": "футляри до державних нагород",
"auctionPeriod": {
"startDate": "2019-02-07T12:32:10.895130"
},
"tenderAttempts": 1,
"procurementMethodType": "appraisal.insider",
"value": {
"currency": "UAH",
"amount": 100
},
"procuringEntity": {
"contactPoint": {
"name": "Державне управління справами",
"telephone": "0440000000"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"name": "Державне управління справами",
"kind": "general",
"address": {
"countryName": "Україна",
"postalCode": "01220",
"region": "м. Київ",
"streetAddress": "вул. Банкова, 11, корпус 1",
"locality": "м. Київ"
}
},
"title_ru": "футляры к государственным наградам",
"items": [
{
"classification": {
"scheme": "CPV",
"id": "45255120-6",
"description": "Земельні ділянки"
},
"description": "Земля для військовослужбовців",
"id": "80fdd02d97304cdebb7fc6fbcdc0980f",
"unit": {
"code": "44617100-9",
"name": "item"
},
"quantity": 5
}
],
"auctionParameters": {
"type": "insider",
"dutchSteps": 88
},
"title_en": "Cases with state awards",
"registrationFee": {
"currency": "UAH",
"amount": 700.87
},
"guarantee": {
"currency": "UAH",
"amount": 1000.99
}
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/2a4f3f66ced44d0b9b014e0a814c01b8
X-Content-Type-Options: nosniff
{
"access": {
"transfer": "23333c81574b4a0881a13faabb465343",
"token": "453a05152a3e4685910c1f11cd7a08d4"
},
"data": {
"procurementMethod": "open",
"auctionID": "UA-EA-2019-01-28-000003",
"enquiryPeriod": {
"startDate": "2019-01-28T12:32:17.344409+02:00",
"endDate": "2019-02-06T20:00:00+02:00"
},
"registrationFee": {
"currency": "UAH",
"amount": 700.87
},
"submissionMethod": "electronicAuction",
"awardCriteria": "highestCost",
"owner": "broker",
"id": "2a4f3f66ced44d0b9b014e0a814c01b8",
"description": "description of appraisal auction",
"title": "футляри до державних нагород",
"tenderAttempts": 1,
"auctionParameters": {
"type": "insider",
"dutchSteps": 88
},
"guarantee": {
"currency": "UAH",
"amount": 1000.99
},
"dateModified": "2019-01-28T12:32:17.370791+02:00",
"status": "draft",
"tenderPeriod": {
"startDate": "2019-01-28T12:32:17.344409+02:00",
"endDate": "2019-02-07T16:15:00+02:00"
},
"title_en": "Cases with state awards",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"procurementMethodType": "appraisal.insider",
"date": "2019-01-28T12:32:17.344409+02:00",
"lotIdentifier": "Q24421K222",
"rectificationPeriod": {
"startDate": "2019-01-28T12:32:17.344409+02:00",
"endDate": "2019-01-31T16:15:00+02:00"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"items": [
{
"unit": {
"code": "44617100-9",
"name": "item"
},
"description": "Земля для військовослужбовців",
"id": "80fdd02d97304cdebb7fc6fbcdc0980f",
"classification": {
"scheme": "CPV",
"description": "Земельні ділянки",
"id": "45255120-6"
},
"quantity": 5
}
],
"value": {
"currency": "UAH",
"amount": 100.0,
"valueAddedTaxIncluded": true
},
"title_ru": "футляры к государственным наградам",
"procuringEntity": {
"contactPoint": {
"name": "Державне управління справами",
"telephone": "0440000000"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"name": "Державне управління справами",
"kind": "general",
"address": {
"postalCode": "01220",
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"region": "м. Київ",
"locality": "м. Київ"
}
}
}
}
And again we have 201 Created response code, Location header and body with extra id, auctionID, and dateModified properties.
Let’s check what “auction registry” contains:
GET /api/2.5/auctions HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"next_page": {
"path": "/api/2.5/auctions?offset=2019-01-28T12%3A32%3A17.260260%2B02%3A00",
"uri": "http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions?offset=2019-01-28T12%3A32%3A17.260260%2B02%3A00",
"offset": "2019-01-28T12:32:17.260260+02:00"
},
"data": [
{
"id": "3fead5d747954a879aa64ef0852cd77a",
"dateModified": "2019-01-28T12:32:16.843339+02:00"
},
{
"id": "e0c4d484a95140569171138086703f23",
"dateModified": "2019-01-28T12:32:17.260260+02:00"
}
]
}
And indeed we have 2 procedures now.
Modifying auction¶
Let’s update procedure by supplementing it with all other essential properties:
PATCH /api/2.5/auctions/e0c4d484a95140569171138086703f23?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 75
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"tenderPeriod": {
"endDate": "2019-02-12T12:32:27.509448+02:00"
}
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"procurementMethod": "open",
"auctionID": "UA-EA-2019-01-28-000002",
"enquiryPeriod": {
"startDate": "2019-01-28T12:32:17.146983+02:00",
"endDate": "2019-02-06T20:00:00+02:00"
},
"registrationFee": {
"currency": "UAH",
"amount": 700.87
},
"submissionMethod": "electronicAuction",
"next_check": "2019-02-06T20:00:00+02:00",
"awardCriteria": "highestCost",
"owner": "broker",
"id": "e0c4d484a95140569171138086703f23",
"description": "description of appraisal auction",
"title": "футляри до державних нагород",
"tenderAttempts": 1,
"auctionParameters": {
"type": "insider",
"dutchSteps": 88
},
"guarantee": {
"currency": "UAH",
"amount": 1000.99
},
"dateModified": "2019-01-28T12:32:17.571049+02:00",
"status": "active.tendering",
"tenderPeriod": {
"startDate": "2019-01-28T12:32:17.146983+02:00",
"endDate": "2019-02-12T12:32:27.509448+02:00"
},
"auctionPeriod": {
"shouldStartAfter": "2019-02-07T00:00:00+02:00"
},
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"procurementMethodType": "appraisal.insider",
"date": "2019-01-28T12:32:17.260260+02:00",
"lotIdentifier": "Q24421K222",
"rectificationPeriod": {
"startDate": "2019-01-28T12:32:17.146983+02:00",
"endDate": "2019-02-05T12:32:27.509448+02:00",
"invalidationDate": "2019-01-28T12:32:17.569080+02:00"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"items": [
{
"description": "Земля для військовослужбовців",
"classification": {
"scheme": "CPV",
"description": "Земельні ділянки",
"id": "51413000-0"
},
"address": {
"postalCode": "79000",
"countryName": "Україна",
"streetAddress": "вул. Банкова 1",
"region": "м. Київ",
"locality": "м. Київ"
},
"id": "46ff602897964fdeb334c4a55e9bc9d7",
"unit": {
"code": "44617100-9",
"name": "item"
},
"quantity": 5
}
],
"value": {
"currency": "UAH",
"amount": 100.0,
"valueAddedTaxIncluded": true
},
"procuringEntity": {
"contactPoint": {
"name": "Державне управління справами",
"telephone": "0440000000"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"name": "Державне управління справами",
"address": {
"postalCode": "01220",
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"region": "м. Київ",
"locality": "м. Київ"
}
}
}
}
We see the added properties have merged with existing data. Additionally, the dateModified property was updated to reflect the last modification datestamp.
Checking the listing again reflects the new modification date:
GET /api/2.5/auctions?opt_pretty=1 HTTP/1.0
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"next_page": {
"path": "/api/2.5/auctions?offset=2019-01-28T12%3A32%3A17.260260%2B02%3A00",
"uri": "http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions?offset=2019-01-28T12%3A32%3A17.260260%2B02%3A00",
"offset": "2019-01-28T12:32:17.260260+02:00"
},
"data": [
{
"id": "3fead5d747954a879aa64ef0852cd77a",
"dateModified": "2019-01-28T12:32:16.843339+02:00"
},
{
"id": "e0c4d484a95140569171138086703f23",
"dateModified": "2019-01-28T12:32:17.260260+02:00"
}
]
}
Uploading documentation¶
Organizer can upload PDF files into the created auction. Uploading should follow the Documents Uploading rules.
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 407
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"description": "document description",
"title": "Notice.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/6ac51cb148a042db8c3ff05ca03e17eb?KeyID=172d32c8&Signature=5e4W7kjbPCSTnRdcmDox0Ro9u3Nd2e0kGJnnSvWq1WSFZc95Vk2Kzg2HnCYMsLSscPP8JMYvbjxaB6s9JPHOAw%3D%3D",
"format": "application/pdf",
"documentType": "technicalSpecifications"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/documents/c33444fdcca243b382630e9924d54509
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"description": "document description",
"format": "application/pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/6ac51cb148a042db8c3ff05ca03e17eb?KeyID=172d32c8&Signature=ODek9PjlhbCkmeL80dDgAiaDHzTqYEmQSYBqYnKfyIFMJoQsrLkzcPHkb3Cnpj%2FYCHink%252B2Hl6ag%252BbdlGkv1DA%253D%253D",
"title": "Notice.pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.643280+02:00",
"documentType": "technicalSpecifications",
"dateModified": "2019-01-28T12:32:17.643302+02:00",
"id": "c33444fdcca243b382630e9924d54509"
}
}
201 Created response code and Location header confirm document creation. We can additionally query the documents collection API endpoint to confirm the action:
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents/c33444fdcca243b382630e9924d54509 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"description": "document description",
"format": "application/pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/6ac51cb148a042db8c3ff05ca03e17eb?KeyID=172d32c8&Signature=ODek9PjlhbCkmeL80dDgAiaDHzTqYEmQSYBqYnKfyIFMJoQsrLkzcPHkb3Cnpj%2FYCHink%252B2Hl6ag%252BbdlGkv1DA%253D%253D",
"title": "Notice.pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.643280+02:00",
"previousVersions": [],
"documentType": "technicalSpecifications",
"dateModified": "2019-01-28T12:32:17.643302+02:00",
"id": "c33444fdcca243b382630e9924d54509"
}
}
The single array element describes the uploaded document. We can upload more documents:
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 338
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/2a50abcb014040178e7422cf1e55cca5?KeyID=172d32c8&Signature=We5g3BGI2rDgwnPIeYsc56v90VyARtx3eTUBXUIEGKPD0EotViIKc%2BcOdvjT%2BtoIaLbrZFhnQTtAZH%2BqQp6vDQ%3D%3D",
"title": "AwardCriteria.pdf",
"hash": "md5:00000000000000000000000000000000",
"format": "application/pdf"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/documents/b85a9b4422084bd49a2885b32fe9b4b9
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "AwardCriteria.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/2a50abcb014040178e7422cf1e55cca5?KeyID=172d32c8&Signature=Fl3iQGfQngVzqc8YA2LFUMT6xg8mCVfoYw82EDdi6eC2G0OnvFmLiGVbfN1hLSudC%2F7pUs7mBtVxF%2FxtASBsBA%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.724608+02:00",
"dateModified": "2019-01-28T12:32:17.724645+02:00",
"id": "b85a9b4422084bd49a2885b32fe9b4b9"
}
}
And again we can confirm that there are two documents uploaded.
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": [
{
"hash": "md5:00000000000000000000000000000000",
"description": "document description",
"format": "application/pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/6ac51cb148a042db8c3ff05ca03e17eb?KeyID=172d32c8&Signature=ODek9PjlhbCkmeL80dDgAiaDHzTqYEmQSYBqYnKfyIFMJoQsrLkzcPHkb3Cnpj%2FYCHink%252B2Hl6ag%252BbdlGkv1DA%253D%253D",
"title": "Notice.pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.643280+02:00",
"documentType": "technicalSpecifications",
"dateModified": "2019-01-28T12:32:17.643302+02:00",
"id": "c33444fdcca243b382630e9924d54509"
},
{
"hash": "md5:00000000000000000000000000000000",
"title": "AwardCriteria.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/2a50abcb014040178e7422cf1e55cca5?KeyID=172d32c8&Signature=Fl3iQGfQngVzqc8YA2LFUMT6xg8mCVfoYw82EDdi6eC2G0OnvFmLiGVbfN1hLSudC%2F7pUs7mBtVxF%2FxtASBsBA%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.724608+02:00",
"dateModified": "2019-01-28T12:32:17.724645+02:00",
"id": "b85a9b4422084bd49a2885b32fe9b4b9"
}
]
}
In case we made an error, we can reupload the document over the older version:
PUT /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents/b85a9b4422084bd49a2885b32fe9b4b9?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 340
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/53ef485f1a1f41b6a6fbad631572346c?KeyID=172d32c8&Signature=iGf3uU89QfT3uYjaki1iOM3cwLEK9edS1%2Bu9y7VKX7Nixog6vvI%2BQL9kVh23Dzgh52QK7bX%2BXQQqoAq4uraKBQ%3D%3D",
"title": "AwardCriteria-2.pdf",
"hash": "md5:00000000000000000000000000000000",
"format": "application/pdf"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "AwardCriteria-2.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/53ef485f1a1f41b6a6fbad631572346c?KeyID=172d32c8&Signature=zS2ipM2G7i8Y%252BpT9XNBXW2Hi9LM4x8w40wpyHXaZJRCymcX5BJLEELPBgK8SDWqB22j8DvskE1XSa75hh7n3Dg%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.724608+02:00",
"dateModified": "2019-01-28T12:32:17.817955+02:00",
"id": "b85a9b4422084bd49a2885b32fe9b4b9"
}
}
And we can see that it is overriding the original version:
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": [
{
"hash": "md5:00000000000000000000000000000000",
"description": "document description",
"format": "application/pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/6ac51cb148a042db8c3ff05ca03e17eb?KeyID=172d32c8&Signature=ODek9PjlhbCkmeL80dDgAiaDHzTqYEmQSYBqYnKfyIFMJoQsrLkzcPHkb3Cnpj%2FYCHink%252B2Hl6ag%252BbdlGkv1DA%253D%253D",
"title": "Notice.pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.643280+02:00",
"documentType": "technicalSpecifications",
"dateModified": "2019-01-28T12:32:17.643302+02:00",
"id": "c33444fdcca243b382630e9924d54509"
},
{
"hash": "md5:00000000000000000000000000000000",
"title": "AwardCriteria-2.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/53ef485f1a1f41b6a6fbad631572346c?KeyID=172d32c8&Signature=zS2ipM2G7i8Y%252BpT9XNBXW2Hi9LM4x8w40wpyHXaZJRCymcX5BJLEELPBgK8SDWqB22j8DvskE1XSa75hh7n3Dg%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.724608+02:00",
"dateModified": "2019-01-28T12:32:17.817955+02:00",
"id": "b85a9b4422084bd49a2885b32fe9b4b9"
}
]
}
Uploading illustration¶
Organizer can upload illustration files into the created auction. Uploading should follow the Documents Uploading rules.
In order to specify illustration display order, index field can be used (for details see Document). Since this illustration should be displayed first, it has "index": 1
.
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 428
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"index": 1,
"hash": "md5:00000000000000000000000000000000",
"description": "First illustration description",
"title": "first_illustration.jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/c82312f5185f4134ad73697a076eb077?KeyID=172d32c8&Signature=RDpoZap%2FZ3WKj77W1eW5jZNpKDQl3vC22B7pWglsO9J6bG4fbU9L6VG5UrcgauAJSeEgOGE7I9PXpsm92qlyDw%3D%3D",
"format": "image/jpeg",
"documentType": "illustration"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/documents/44c7331c169b47f6aea97b05846b0d74
X-Content-Type-Options: nosniff
{
"data": {
"index": 1,
"hash": "md5:00000000000000000000000000000000",
"description": "First illustration description",
"format": "image/jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/c82312f5185f4134ad73697a076eb077?KeyID=172d32c8&Signature=TGH4gd2rROfKB3wsnIwhIfPMu45Caqv2EG3yjy5NJl1C12z1wf1XcfvsavyA%2F7pnWqRX3Eo%252BTUqSn69pPiiiCQ%253D%253D",
"title": "first_illustration.jpeg",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.924605+02:00",
"documentType": "illustration",
"dateModified": "2019-01-28T12:32:17.924642+02:00",
"id": "44c7331c169b47f6aea97b05846b0d74"
}
}
We can check whether illustration is uploaded.
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": [
{
"hash": "md5:00000000000000000000000000000000",
"description": "document description",
"format": "application/pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/6ac51cb148a042db8c3ff05ca03e17eb?KeyID=172d32c8&Signature=ODek9PjlhbCkmeL80dDgAiaDHzTqYEmQSYBqYnKfyIFMJoQsrLkzcPHkb3Cnpj%2FYCHink%252B2Hl6ag%252BbdlGkv1DA%253D%253D",
"title": "Notice.pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.643280+02:00",
"documentType": "technicalSpecifications",
"dateModified": "2019-01-28T12:32:17.643302+02:00",
"id": "c33444fdcca243b382630e9924d54509"
},
{
"hash": "md5:00000000000000000000000000000000",
"title": "AwardCriteria-2.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/53ef485f1a1f41b6a6fbad631572346c?KeyID=172d32c8&Signature=zS2ipM2G7i8Y%252BpT9XNBXW2Hi9LM4x8w40wpyHXaZJRCymcX5BJLEELPBgK8SDWqB22j8DvskE1XSa75hh7n3Dg%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.724608+02:00",
"dateModified": "2019-01-28T12:32:17.817955+02:00",
"id": "b85a9b4422084bd49a2885b32fe9b4b9"
},
{
"index": 1,
"hash": "md5:00000000000000000000000000000000",
"description": "First illustration description",
"format": "image/jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/c82312f5185f4134ad73697a076eb077?KeyID=172d32c8&Signature=TGH4gd2rROfKB3wsnIwhIfPMu45Caqv2EG3yjy5NJl1C12z1wf1XcfvsavyA%2F7pnWqRX3Eo%252BTUqSn69pPiiiCQ%253D%253D",
"title": "first_illustration.jpeg",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.924605+02:00",
"documentType": "illustration",
"dateModified": "2019-01-28T12:32:17.924642+02:00",
"id": "44c7331c169b47f6aea97b05846b0d74"
}
]
}
Organizer can upload second illustration. This illustration should be displayed second, so it has "index": 2
.
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 432
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"index": 2,
"hash": "md5:00000000000000000000000000000000",
"description": "Second illustration description",
"title": "second_illustration.jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/8581590c05844a9c8d527b63232aff4a?KeyID=172d32c8&Signature=59BJ8pQObCY9eHUi9v5Bp%2B0s67mYVWCZWLR7Z5FVKYcWfzO4aDn1NNse3g1odrR4rJJhfS%2B6SClFFF2KAdUUCA%3D%3D",
"format": "image/jpeg",
"documentType": "illustration"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/documents/84bace22f9114d8d98f2c9c06a858c6d
X-Content-Type-Options: nosniff
{
"data": {
"index": 2,
"hash": "md5:00000000000000000000000000000000",
"description": "Second illustration description",
"format": "image/jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/8581590c05844a9c8d527b63232aff4a?KeyID=172d32c8&Signature=4lr0rXnd1icb0cmt9itu1y2c1OWAZrI3nyi8JYtfY6llpSryb2sVvlV6HgGDJiJTYA4yW7OqXmMZXwZuzArxDA%253D%253D",
"title": "second_illustration.jpeg",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:18.049118+02:00",
"documentType": "illustration",
"dateModified": "2019-01-28T12:32:18.049168+02:00",
"id": "84bace22f9114d8d98f2c9c06a858c6d"
}
}
Add third illustration:
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 428
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"index": 2,
"hash": "md5:00000000000000000000000000000000",
"description": "Third illustration description",
"title": "third_illustration.jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/175b11887c4d48498b9aa02d194ed679?KeyID=172d32c8&Signature=TCn4MV60rm7fFzjgDaIxQJgYy%2Bhkp3Dxnruyz9F0uyEBRejuU1wx9x7i8pgw2ZiOXfP8aVVLxb0qzkwo4J7EDg%3D%3D",
"format": "image/jpeg",
"documentType": "illustration"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/documents/2e87d27713dd488ab403104d6b41b338
X-Content-Type-Options: nosniff
{
"data": {
"index": 2,
"hash": "md5:00000000000000000000000000000000",
"description": "Third illustration description",
"format": "image/jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/175b11887c4d48498b9aa02d194ed679?KeyID=172d32c8&Signature=TOp%252BFcDvaNPDgm%2Fl%252BznQuaqJRM7qjfxV4EvgmHIfM9fXyJjyneOu9k%252B28BNJn0qA3FEGFzDyHONIx8msSzlvDw%253D%253D",
"title": "third_illustration.jpeg",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:18.139983+02:00",
"documentType": "illustration",
"dateModified": "2019-01-28T12:32:18.140007+02:00",
"id": "2e87d27713dd488ab403104d6b41b338"
}
}
Note that index of the third illustration is the same as for the second illustration: "index": 2
. In such cases firstly will be displayed illustration that was uploaded earlier.
We can check that there are three uploaded illustrations.
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": [
{
"hash": "md5:00000000000000000000000000000000",
"description": "document description",
"format": "application/pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/6ac51cb148a042db8c3ff05ca03e17eb?KeyID=172d32c8&Signature=ODek9PjlhbCkmeL80dDgAiaDHzTqYEmQSYBqYnKfyIFMJoQsrLkzcPHkb3Cnpj%2FYCHink%252B2Hl6ag%252BbdlGkv1DA%253D%253D",
"title": "Notice.pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.643280+02:00",
"documentType": "technicalSpecifications",
"dateModified": "2019-01-28T12:32:17.643302+02:00",
"id": "c33444fdcca243b382630e9924d54509"
},
{
"hash": "md5:00000000000000000000000000000000",
"title": "AwardCriteria-2.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/53ef485f1a1f41b6a6fbad631572346c?KeyID=172d32c8&Signature=zS2ipM2G7i8Y%252BpT9XNBXW2Hi9LM4x8w40wpyHXaZJRCymcX5BJLEELPBgK8SDWqB22j8DvskE1XSa75hh7n3Dg%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.724608+02:00",
"dateModified": "2019-01-28T12:32:17.817955+02:00",
"id": "b85a9b4422084bd49a2885b32fe9b4b9"
},
{
"index": 1,
"hash": "md5:00000000000000000000000000000000",
"description": "First illustration description",
"format": "image/jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/c82312f5185f4134ad73697a076eb077?KeyID=172d32c8&Signature=TGH4gd2rROfKB3wsnIwhIfPMu45Caqv2EG3yjy5NJl1C12z1wf1XcfvsavyA%2F7pnWqRX3Eo%252BTUqSn69pPiiiCQ%253D%253D",
"title": "first_illustration.jpeg",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.924605+02:00",
"documentType": "illustration",
"dateModified": "2019-01-28T12:32:17.924642+02:00",
"id": "44c7331c169b47f6aea97b05846b0d74"
},
{
"index": 2,
"hash": "md5:00000000000000000000000000000000",
"description": "Second illustration description",
"format": "image/jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/8581590c05844a9c8d527b63232aff4a?KeyID=172d32c8&Signature=4lr0rXnd1icb0cmt9itu1y2c1OWAZrI3nyi8JYtfY6llpSryb2sVvlV6HgGDJiJTYA4yW7OqXmMZXwZuzArxDA%253D%253D",
"title": "second_illustration.jpeg",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:18.049118+02:00",
"documentType": "illustration",
"dateModified": "2019-01-28T12:32:18.049168+02:00",
"id": "84bace22f9114d8d98f2c9c06a858c6d"
},
{
"index": 2,
"hash": "md5:00000000000000000000000000000000",
"description": "Third illustration description",
"format": "image/jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/175b11887c4d48498b9aa02d194ed679?KeyID=172d32c8&Signature=TOp%252BFcDvaNPDgm%2Fl%252BznQuaqJRM7qjfxV4EvgmHIfM9fXyJjyneOu9k%252B28BNJn0qA3FEGFzDyHONIx8msSzlvDw%253D%253D",
"title": "third_illustration.jpeg",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:18.139983+02:00",
"documentType": "illustration",
"dateModified": "2019-01-28T12:32:18.140007+02:00",
"id": "2e87d27713dd488ab403104d6b41b338"
}
]
}
Enquiries¶
When a procedure is in active.tendering status, interested parties can ask questions:
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/questions HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 1506
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"author": {
"contactPoint": {
"telephone": "+380 (432) 21-69-30",
"name": "Сергій Олексюк",
"email": "soleksuk@gmail.com"
},
"identifier": {
"scheme": "UA-EDR",
"legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
"id": "00137226",
"uri": "http://sch10.edu.vn.ua/"
},
"name": "ДКП «Школяр»",
"address": {
"countryName": "Україна",
"postalCode": "21100",
"region": "м. Вінниця",
"streetAddress": "вул. Островського, 33",
"locality": "м. Вінниця"
}
},
"description": "Просимо додати таблицю потрібної калорійності харчування",
"title": "Калорійність"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/questions/8a9247bb32fe4b1abcc87d59d4b65f53
X-Content-Type-Options: nosniff
{
"data": {
"description": "Просимо додати таблицю потрібної калорійності харчування",
"author": {
"contactPoint": {
"email": "soleksuk@gmail.com",
"telephone": "+380 (432) 21-69-30",
"name": "Сергій Олексюк"
},
"identifier": {
"scheme": "UA-EDR",
"legalName": "Державне комунальне підприємство громадського харчування «Школяр»",
"uri": "http://sch10.edu.vn.ua/",
"id": "00137226"
},
"name": "ДКП «Школяр»",
"address": {
"postalCode": "21100",
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"region": "м. Вінниця",
"locality": "м. Вінниця"
}
},
"title": "Калорійність",
"date": "2019-01-28T12:32:18.382280+02:00",
"id": "8a9247bb32fe4b1abcc87d59d4b65f53",
"questionOf": "tender"
}
}
Organizer can answer them:
PATCH /api/2.5/auctions/e0c4d484a95140569171138086703f23/questions/8a9247bb32fe4b1abcc87d59d4b65f53?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 162
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"answer": "Таблицю додано в файлі \"Kalorijnist.xslx\""
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"description": "Просимо додати таблицю потрібної калорійності харчування",
"title": "Калорійність",
"date": "2019-01-28T12:32:18.382280+02:00",
"answer": "Таблицю додано в файлі \"Kalorijnist.xslx\"",
"id": "8a9247bb32fe4b1abcc87d59d4b65f53",
"questionOf": "tender"
}
}
And one can retrieve the questions list:
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23/questions HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": [
{
"description": "Просимо додати таблицю потрібної калорійності харчування",
"title": "Калорійність",
"date": "2019-01-28T12:32:18.382280+02:00",
"answer": "Таблицю додано в файлі \"Kalorijnist.xslx\"",
"id": "8a9247bb32fe4b1abcc87d59d4b65f53",
"questionOf": "tender"
}
]
}
Or an individual answer:
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23/questions/8a9247bb32fe4b1abcc87d59d4b65f53 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"description": "Просимо додати таблицю потрібної калорійності харчування",
"title": "Калорійність",
"date": "2019-01-28T12:32:18.382280+02:00",
"answer": "Таблицю додано в файлі \"Kalorijnist.xslx\"",
"id": "8a9247bb32fe4b1abcc87d59d4b65f53",
"questionOf": "tender"
}
}
Registering bid¶
Bidder can register a bid in draft status:
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/bids HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 768
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"status": "draft",
"qualified": true,
"tenderers": [
{
"contactPoint": {
"telephone": "+380 (432) 21-69-30",
"name": "Сергій Олексюк",
"email": "soleksuk@gmail.com"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Школяр»",
"address": {
"countryName": "Україна",
"postalCode": "21100",
"region": "м. Вінниця",
"streetAddress": "вул. Островського, 33",
"locality": "м. Вінниця"
}
}
],
"eligible": true
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/bids/f59572206a724c87901cfd00ff8244ff
X-Content-Type-Options: nosniff
{
"access": {
"token": "898cfa971bac42239310ee094fdb7b78"
},
"data": {
"status": "draft",
"eligible": true,
"date": "2019-01-28T12:32:18.673849+02:00",
"qualified": true,
"tenderers": [
{
"contactPoint": {
"email": "soleksuk@gmail.com",
"telephone": "+380 (432) 21-69-30",
"name": "Сергій Олексюк"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Школяр»",
"address": {
"postalCode": "21100",
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"region": "м. Вінниця",
"locality": "м. Вінниця"
}
}
],
"owner": "broker",
"id": "f59572206a724c87901cfd00ff8244ff"
}
}
And activate a bid:
PATCH /api/2.5/auctions/e0c4d484a95140569171138086703f23/bids/f59572206a724c87901cfd00ff8244ff?acc_token=898cfa971bac42239310ee094fdb7b78 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 30
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"status": "active"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "active",
"eligible": true,
"date": "2019-01-28T12:32:18.673849+02:00",
"qualified": true,
"tenderers": [
{
"contactPoint": {
"email": "soleksuk@gmail.com",
"telephone": "+380 (432) 21-69-30",
"name": "Сергій Олексюк"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Школяр»",
"address": {
"postalCode": "21100",
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"region": "м. Вінниця",
"locality": "м. Вінниця"
}
}
],
"owner": "broker",
"id": "f59572206a724c87901cfd00ff8244ff",
"participationUrl": "http://auction-sandbox.openprocurement.org/insider-auctions/e0c4d484a95140569171138086703f23/login?bidder_id=f59572206a724c87901cfd00ff8244ff&signature=qlOLANfxG6AFyIZQ1OW4yMLNPZyNNexBKT5LicVdwBCqBICJyql4YvkHdQ8bI4qDhdqV61B/CRq7Xqc3DtXzDA%3D%3D"
}
}
And upload proposal document:
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/bids/f59572206a724c87901cfd00ff8244ff/documents?acc_token=898cfa971bac42239310ee094fdb7b78 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 331
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/68750b094c3e49d08e5dbde6f6350844?KeyID=172d32c8&Signature=rcoakWhdJofbUeKG355Xqadwrv%2FdUnl0TTdQ%2BLdQUK4ZGVD59s98ifkx3glx2UpORR7W3Zy6Iw7PgtOVo3GRCg%3D%3D",
"title": "Proposal.pdf",
"hash": "md5:00000000000000000000000000000000",
"format": "application/pdf"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/bids/f59572206a724c87901cfd00ff8244ff/documents/32dc664664054b7fa466ab487abbd735
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "Proposal.pdf",
"url": "http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/bids/f59572206a724c87901cfd00ff8244ff/documents/32dc664664054b7fa466ab487abbd735?download=68750b094c3e49d08e5dbde6f6350844",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:18.924319+02:00",
"dateModified": "2019-01-28T12:32:18.924374+02:00",
"id": "32dc664664054b7fa466ab487abbd735"
}
}
It is possible to check the uploaded documents:
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23/bids/f59572206a724c87901cfd00ff8244ff/documents?acc_token=898cfa971bac42239310ee094fdb7b78 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": [
{
"hash": "md5:00000000000000000000000000000000",
"title": "Proposal.pdf",
"url": "http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/bids/f59572206a724c87901cfd00ff8244ff/documents/32dc664664054b7fa466ab487abbd735?download=68750b094c3e49d08e5dbde6f6350844",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:18.924319+02:00",
"dateModified": "2019-01-28T12:32:18.924374+02:00",
"id": "32dc664664054b7fa466ab487abbd735"
}
]
}
For the best effect (biggest economy) auction should have multiple bidders registered:
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/bids HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 741
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"qualified": true,
"tenderers": [
{
"contactPoint": {
"telephone": "+380 (322) 91-69-30",
"name": "Андрій Олексюк",
"email": "aagt@gmail.com"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00137226",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Книга»",
"address": {
"countryName": "Україна",
"postalCode": "79013",
"region": "м. Львів",
"streetAddress": "вул. Островського, 34",
"locality": "м. Львів"
}
}
],
"value": {
"amount": 501
},
"eligible": true
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/bids/a22200d873de40e39f7f4ab5dd59f7eb
X-Content-Type-Options: nosniff
{
"access": {
"token": "40b7cd7fd2b4441396c1efa92bfc2b1b"
},
"data": {
"status": "active",
"eligible": true,
"date": "2019-01-28T12:32:19.091300+02:00",
"qualified": true,
"tenderers": [
{
"contactPoint": {
"email": "aagt@gmail.com",
"telephone": "+380 (322) 91-69-30",
"name": "Андрій Олексюк"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00137226",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Книга»",
"address": {
"postalCode": "79013",
"countryName": "Україна",
"streetAddress": "вул. Островського, 34",
"region": "м. Львів",
"locality": "м. Львів"
}
}
],
"owner": "broker",
"id": "a22200d873de40e39f7f4ab5dd59f7eb",
"participationUrl": "http://auction-sandbox.openprocurement.org/insider-auctions/e0c4d484a95140569171138086703f23/login?bidder_id=a22200d873de40e39f7f4ab5dd59f7eb&signature=PVInewnhc5/KpOU5TwAeWEu3yUmtGNJt1NUINQgyQ%2Bqnmjs7emZvnCx8KcsfL2eVAH5MtNNDxCQYPPL5HZTsAw%3D%3D"
}
}
Auction¶
The auction can be reached at Auction.auctionUrl:
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"procurementMethod": "open",
"auctionID": "UA-EA-2019-01-28-000002",
"auctionUrl": "http://auction-sandbox.openprocurement.org/insider-auctions/e0c4d484a95140569171138086703f23",
"enquiryPeriod": {
"startDate": "2019-01-08T12:32:10.895130+02:00",
"endDate": "2019-01-28T12:32:10.895130+02:00"
},
"registrationFee": {
"currency": "UAH",
"amount": 700.87
},
"submissionMethod": "electronicAuction",
"next_check": "2019-01-28T19:48:00.895130+02:00",
"awardCriteria": "highestCost",
"questions": [
{
"description": "Просимо додати таблицю потрібної калорійності харчування",
"title": "Калорійність",
"date": "2019-01-28T12:32:18.382280+02:00",
"answer": "Таблицю додано в файлі \"Kalorijnist.xslx\"",
"id": "8a9247bb32fe4b1abcc87d59d4b65f53",
"questionOf": "tender"
}
],
"owner": "broker",
"id": "e0c4d484a95140569171138086703f23",
"description": "description of appraisal auction",
"documents": [
{
"hash": "md5:00000000000000000000000000000000",
"description": "document description",
"format": "application/pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/6ac51cb148a042db8c3ff05ca03e17eb?KeyID=172d32c8&Signature=ODek9PjlhbCkmeL80dDgAiaDHzTqYEmQSYBqYnKfyIFMJoQsrLkzcPHkb3Cnpj%2FYCHink%252B2Hl6ag%252BbdlGkv1DA%253D%253D",
"title": "Notice.pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.643280+02:00",
"documentType": "technicalSpecifications",
"dateModified": "2019-01-28T12:32:17.643302+02:00",
"id": "c33444fdcca243b382630e9924d54509"
},
{
"hash": "md5:00000000000000000000000000000000",
"title": "AwardCriteria.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/2a50abcb014040178e7422cf1e55cca5?KeyID=172d32c8&Signature=Fl3iQGfQngVzqc8YA2LFUMT6xg8mCVfoYw82EDdi6eC2G0OnvFmLiGVbfN1hLSudC%2F7pUs7mBtVxF%2FxtASBsBA%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.724608+02:00",
"dateModified": "2019-01-28T12:32:17.724645+02:00",
"id": "b85a9b4422084bd49a2885b32fe9b4b9"
},
{
"hash": "md5:00000000000000000000000000000000",
"title": "AwardCriteria-2.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/53ef485f1a1f41b6a6fbad631572346c?KeyID=172d32c8&Signature=zS2ipM2G7i8Y%252BpT9XNBXW2Hi9LM4x8w40wpyHXaZJRCymcX5BJLEELPBgK8SDWqB22j8DvskE1XSa75hh7n3Dg%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.724608+02:00",
"dateModified": "2019-01-28T12:32:17.817955+02:00",
"id": "b85a9b4422084bd49a2885b32fe9b4b9"
},
{
"index": 1,
"hash": "md5:00000000000000000000000000000000",
"description": "First illustration description",
"format": "image/jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/c82312f5185f4134ad73697a076eb077?KeyID=172d32c8&Signature=TGH4gd2rROfKB3wsnIwhIfPMu45Caqv2EG3yjy5NJl1C12z1wf1XcfvsavyA%2F7pnWqRX3Eo%252BTUqSn69pPiiiCQ%253D%253D",
"title": "first_illustration.jpeg",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:17.924605+02:00",
"documentType": "illustration",
"dateModified": "2019-01-28T12:32:17.924642+02:00",
"id": "44c7331c169b47f6aea97b05846b0d74"
},
{
"index": 2,
"hash": "md5:00000000000000000000000000000000",
"description": "Second illustration description",
"format": "image/jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/8581590c05844a9c8d527b63232aff4a?KeyID=172d32c8&Signature=4lr0rXnd1icb0cmt9itu1y2c1OWAZrI3nyi8JYtfY6llpSryb2sVvlV6HgGDJiJTYA4yW7OqXmMZXwZuzArxDA%253D%253D",
"title": "second_illustration.jpeg",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:18.049118+02:00",
"documentType": "illustration",
"dateModified": "2019-01-28T12:32:18.049168+02:00",
"id": "84bace22f9114d8d98f2c9c06a858c6d"
},
{
"index": 2,
"hash": "md5:00000000000000000000000000000000",
"description": "Third illustration description",
"format": "image/jpeg",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/175b11887c4d48498b9aa02d194ed679?KeyID=172d32c8&Signature=TOp%252BFcDvaNPDgm%2Fl%252BznQuaqJRM7qjfxV4EvgmHIfM9fXyJjyneOu9k%252B28BNJn0qA3FEGFzDyHONIx8msSzlvDw%253D%253D",
"title": "third_illustration.jpeg",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:18.139983+02:00",
"documentType": "illustration",
"dateModified": "2019-01-28T12:32:18.140007+02:00",
"id": "2e87d27713dd488ab403104d6b41b338"
},
{
"title": "Familiarization with bank asset",
"format": "offline/on-site-examination",
"accessDetails": "Familiar with asset: days, time, address",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:18.267862+02:00",
"documentType": "x_dgfAssetFamiliarization",
"dateModified": "2019-01-28T12:32:18.267912+02:00",
"id": "70f92e8fa46046e3955bab0701ffedf1"
}
],
"title": "футляри до державних нагород",
"tenderAttempts": 1,
"auctionParameters": {
"type": "insider",
"dutchSteps": 88
},
"guarantee": {
"currency": "UAH",
"amount": 1000.99
},
"dateModified": "2019-01-28T12:32:19.472633+02:00",
"status": "active.auction",
"tenderPeriod": {
"startDate": "2019-01-08T12:32:10.895130+02:00",
"endDate": "2019-01-28T19:17:10.895130+02:00"
},
"auctionPeriod": {
"startDate": "2019-01-28T12:32:10.895130+02:00",
"shouldStartAfter": "2019-01-29T00:00:00+02:00"
},
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"procurementMethodType": "appraisal.insider",
"date": "2019-01-28T12:32:19.472633+02:00",
"lotIdentifier": "Q24421K222",
"rectificationPeriod": {
"startDate": "2019-01-08T12:32:10.895130+02:00",
"endDate": "2019-01-21T19:17:10.895130+02:00",
"invalidationDate": "2019-01-28T12:32:18.268192+02:00"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"items": [
{
"description": "Земля для військовослужбовців",
"classification": {
"scheme": "CPV",
"description": "Земельні ділянки",
"id": "51413000-0"
},
"address": {
"postalCode": "79000",
"countryName": "Україна",
"streetAddress": "вул. Банкова 1",
"region": "м. Київ",
"locality": "м. Київ"
},
"id": "46ff602897964fdeb334c4a55e9bc9d7",
"unit": {
"code": "44617100-9",
"name": "item"
},
"quantity": 5
}
],
"value": {
"currency": "UAH",
"amount": 100.0,
"valueAddedTaxIncluded": true
},
"procuringEntity": {
"contactPoint": {
"name": "Державне управління справами",
"telephone": "0440000000"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"name": "Державне управління справами",
"address": {
"postalCode": "01220",
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"region": "м. Київ",
"locality": "м. Київ"
}
}
}
}
And bidders can find their participation URLs via their bids:
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23/bids/f59572206a724c87901cfd00ff8244ff?acc_token=898cfa971bac42239310ee094fdb7b78 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "active",
"documents": [
{
"hash": "md5:00000000000000000000000000000000",
"title": "Proposal.pdf",
"url": "http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/bids/f59572206a724c87901cfd00ff8244ff/documents/32dc664664054b7fa466ab487abbd735?download=68750b094c3e49d08e5dbde6f6350844",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:18.924319+02:00",
"dateModified": "2019-01-28T12:32:18.924374+02:00",
"id": "32dc664664054b7fa466ab487abbd735"
}
],
"eligible": true,
"date": "2019-01-28T12:32:18.673849+02:00",
"qualified": true,
"tenderers": [
{
"contactPoint": {
"email": "soleksuk@gmail.com",
"telephone": "+380 (432) 21-69-30",
"name": "Сергій Олексюк"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Школяр»",
"address": {
"postalCode": "21100",
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"region": "м. Вінниця",
"locality": "м. Вінниця"
}
}
],
"owner": "broker",
"id": "f59572206a724c87901cfd00ff8244ff",
"participationUrl": "http://auction-sandbox.openprocurement.org/insider-auctions/e0c4d484a95140569171138086703f23/login?bidder_id=f59572206a724c87901cfd00ff8244ff&signature=qlOLANfxG6AFyIZQ1OW4yMLNPZyNNexBKT5LicVdwBCqBICJyql4YvkHdQ8bI4qDhdqV61B/CRq7Xqc3DtXzDA%3D%3D"
}
}
See the Bid.participationUrl in the response. The links can be also retrieved for other participants:
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23/bids/a22200d873de40e39f7f4ab5dd59f7eb?acc_token=40b7cd7fd2b4441396c1efa92bfc2b1b HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "active",
"eligible": true,
"date": "2019-01-28T12:32:19.091300+02:00",
"qualified": true,
"tenderers": [
{
"contactPoint": {
"email": "aagt@gmail.com",
"telephone": "+380 (322) 91-69-30",
"name": "Андрій Олексюк"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00137226",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Книга»",
"address": {
"postalCode": "79013",
"countryName": "Україна",
"streetAddress": "вул. Островського, 34",
"region": "м. Львів",
"locality": "м. Львів"
}
}
],
"owner": "broker",
"id": "a22200d873de40e39f7f4ab5dd59f7eb",
"participationUrl": "http://auction-sandbox.openprocurement.org/insider-auctions/e0c4d484a95140569171138086703f23/login?bidder_id=a22200d873de40e39f7f4ab5dd59f7eb&signature=PVInewnhc5/KpOU5TwAeWEu3yUmtGNJt1NUINQgyQ%2Bqnmjs7emZvnCx8KcsfL2eVAH5MtNNDxCQYPPL5HZTsAw%3D%3D"
}
}
Qualification¶
- After the competitive auction two awards are created:
- for the first candidate (a participant that has submitted the highest valid bid at the auction) - initially has a pending status and awaits auction protocol to be uploaded by the organizer;
- for the second candidate (a participant that has submitted the second highest valid bid at the auction).
The procedure receives active.qualification status. The process enters the verificationPeriod with the auto-generated duration of 0-10 business days.
GET /api/2.5/auctions/e0c4d484a95140569171138086703f23/awards HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": [
{
"status": "pending",
"verificationPeriod": {
"startDate": "2019-01-28T12:32:19.988125+02:00",
"endDate": "2019-02-05T18:00:00+02:00"
},
"signingPeriod": {
"startDate": "2019-01-28T12:32:19.988125+02:00",
"endDate": "2019-02-18T18:00:00+02:00"
},
"suppliers": [
{
"contactPoint": {
"email": "aagt@gmail.com",
"telephone": "+380 (322) 91-69-30",
"name": "Андрій Олексюк"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00137226",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Книга»",
"address": {
"postalCode": "79013",
"countryName": "Україна",
"streetAddress": "вул. Островського, 34",
"region": "м. Львів",
"locality": "м. Львів"
}
}
],
"complaintPeriod": {
"startDate": "2019-01-28T12:32:19.988125+02:00"
},
"bid_id": "a22200d873de40e39f7f4ab5dd59f7eb",
"value": {
"currency": "UAH",
"amount": 479,
"valueAddedTaxIncluded": true
},
"date": "2019-01-28T12:32:19.988125+02:00",
"id": "8e0279bc48cd41949e6ba8d436f31a0f"
},
{
"status": "pending.waiting",
"complaintPeriod": {
"startDate": "2019-01-28T12:32:19.988125+02:00"
},
"suppliers": [
{
"contactPoint": {
"email": "soleksuk@gmail.com",
"telephone": "+380 (432) 21-69-30",
"name": "Сергій Олексюк"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Школяр»",
"address": {
"postalCode": "21100",
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"region": "м. Вінниця",
"locality": "м. Вінниця"
}
}
],
"bid_id": "f59572206a724c87901cfd00ff8244ff",
"value": {
"currency": "UAH",
"amount": 469,
"valueAddedTaxIncluded": true
},
"date": "2019-01-28T12:32:19.988125+02:00",
"id": "24f7e995bebe479d8acf5d3a9337ff3d"
}
]
}
Confirming qualification¶
For the winner to be qualified, the Organizer has to upload auctionProtocol first:
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/awards/8e0279bc48cd41949e6ba8d436f31a0f/documents?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 379
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/a833a8df66ed44a18260bd021ab7cd2c?KeyID=172d32c8&Signature=WxuIUBpwMIwSUEF2P9gA6ssqgFgDWhMIFjBGJ7DWrP2CsBF%2F0Tki7Nce2nhc4FMLwORG2sf%2FxTAgTWIKWyBKBg%3D%3D",
"title": "SignedAuctionProtocol.pdf",
"format": "application/pdf",
"hash": "md5:00000000000000000000000000000000",
"documentType": "auctionProtocol"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/awards/8e0279bc48cd41949e6ba8d436f31a0f/documents/85b3a0d97fcb4b83af6b5a21b2789c4c
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"author": "auction_owner",
"title": "SignedAuctionProtocol.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/a833a8df66ed44a18260bd021ab7cd2c?KeyID=172d32c8&Signature=eAp2158FA%2F7m6SiQ9tICQOXDjLYWFjoEcyvhx%2FIJ6gio4FBZig5r9IVWZFBMKC%252Bl36EJOWUwDKVnKTT0OlK5AA%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:20.543980+02:00",
"documentType": "auctionProtocol",
"dateModified": "2019-01-28T12:32:20.544014+02:00",
"id": "85b3a0d97fcb4b83af6b5a21b2789c4c"
}
}
The winner can also upload auctionProtocol to award:
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/awards/8e0279bc48cd41949e6ba8d436f31a0f/documents?acc_token=40b7cd7fd2b4441396c1efa92bfc2b1b HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 381
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/733e3efd60604f2c8c2e2142fca2f269?KeyID=172d32c8&Signature=zORh6NIwF4bOKmcQss5VZgna8%2B1r%2FunOE3NKB42km3MExo3f3N5L391aAoWePu6%2Fwq4MKG3ZFzDYP2uPcL6vAw%3D%3D",
"title": "SignedAuctionProtocol.pdf",
"format": "application/pdf",
"hash": "md5:00000000000000000000000000000000",
"documentType": "auctionProtocol"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/awards/8e0279bc48cd41949e6ba8d436f31a0f/documents/c15f1049d5c84aeaa164e4bb650daa0f
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"author": "bid_owner",
"title": "SignedAuctionProtocol.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/733e3efd60604f2c8c2e2142fca2f269?KeyID=172d32c8&Signature=aof6f%252BRhjahdFxYpQm%2Fc8bJxVu0TLoPAWVrMptbcSVoWiIGRObTlVDvelXFarRhIkCrZsp9laoSOA%252BYN8c%2FrDQ%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:20.409366+02:00",
"documentType": "auctionProtocol",
"dateModified": "2019-01-28T12:32:20.409386+02:00",
"id": "c15f1049d5c84aeaa164e4bb650daa0f"
}
}
With the document being uploaded the Organizer has to switch the award to active status:
PATCH /api/2.5/auctions/e0c4d484a95140569171138086703f23/awards/8e0279bc48cd41949e6ba8d436f31a0f?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 30
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"status": "active"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "active",
"documents": [
{
"hash": "md5:00000000000000000000000000000000",
"author": "bid_owner",
"title": "SignedAuctionProtocol.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/733e3efd60604f2c8c2e2142fca2f269?KeyID=172d32c8&Signature=aof6f%252BRhjahdFxYpQm%2Fc8bJxVu0TLoPAWVrMptbcSVoWiIGRObTlVDvelXFarRhIkCrZsp9laoSOA%252BYN8c%2FrDQ%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:20.409366+02:00",
"documentType": "auctionProtocol",
"dateModified": "2019-01-28T12:32:20.409386+02:00",
"id": "c15f1049d5c84aeaa164e4bb650daa0f"
},
{
"hash": "md5:00000000000000000000000000000000",
"author": "auction_owner",
"title": "SignedAuctionProtocol.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/a833a8df66ed44a18260bd021ab7cd2c?KeyID=172d32c8&Signature=eAp2158FA%2F7m6SiQ9tICQOXDjLYWFjoEcyvhx%2FIJ6gio4FBZig5r9IVWZFBMKC%252Bl36EJOWUwDKVnKTT0OlK5AA%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:20.543980+02:00",
"documentType": "auctionProtocol",
"dateModified": "2019-01-28T12:32:20.544014+02:00",
"id": "85b3a0d97fcb4b83af6b5a21b2789c4c"
}
],
"verificationPeriod": {
"startDate": "2019-01-28T12:32:19.988125+02:00",
"endDate": "2019-01-28T12:32:20.693449+02:00"
},
"signingPeriod": {
"startDate": "2019-01-28T12:32:19.988125+02:00",
"endDate": "2019-02-18T18:00:00+02:00"
},
"suppliers": [
{
"contactPoint": {
"email": "aagt@gmail.com",
"telephone": "+380 (322) 91-69-30",
"name": "Андрій Олексюк"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00137226",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Книга»",
"address": {
"postalCode": "79013",
"countryName": "Україна",
"streetAddress": "вул. Островського, 34",
"region": "м. Львів",
"locality": "м. Львів"
}
}
],
"complaintPeriod": {
"startDate": "2019-01-28T12:32:19.988125+02:00",
"endDate": "2019-01-28T12:32:20.693449+02:00"
},
"bid_id": "a22200d873de40e39f7f4ab5dd59f7eb",
"value": {
"currency": "UAH",
"amount": 479,
"valueAddedTaxIncluded": true
},
"date": "2019-01-28T12:32:20.705871+02:00",
"id": "8e0279bc48cd41949e6ba8d436f31a0f"
}
}
Disqualification of a candidate¶
In case of a manual disqualification, the organizer has to upload file with act or rejectionProtocol document type:
POST /api/2.5/auctions/17a42b23eaed4286a8937da1348817bb/awards/4e8136ff281a4f97aca77361f2e29641/documents?acc_token=b08a569f0fc244778d05c70166974957 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 377
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/990c527a9fe34b218bcb6330691b6a3a?KeyID=172d32c8&Signature=iE%2F8ruakyL6beJiIgA2h8QaYgOyzRNYqkUxIVDtumj%2Bat2Zs9lrWAHl9XpPtYmAzsrm6ovTGQaf44wY6XHuWCg%3D%3D",
"title": "RejectionProtocol.pdf",
"format": "application/pdf",
"hash": "md5:00000000000000000000000000000000",
"documentType": "rejectionProtocol"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/17a42b23eaed4286a8937da1348817bb/awards/4e8136ff281a4f97aca77361f2e29641/documents/b743cbdfd1444110bfdf3740457ddff1
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"author": "auction_owner",
"title": "RejectionProtocol.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/990c527a9fe34b218bcb6330691b6a3a?KeyID=172d32c8&Signature=npfcCCOLpOyFNfnK9p0RC4z5%252BMbLIAozLJ4nOE0tw033hfeLUdS%252BFndF4MtD8MZPw86N%2FG79eG%2F62fpy54S9BQ%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:16.508364+02:00",
"documentType": "rejectionProtocol",
"dateModified": "2019-01-28T12:32:16.508385+02:00",
"id": "b743cbdfd1444110bfdf3740457ddff1"
}
}
And disqualify candidate:
PATCH /api/2.5/auctions/17a42b23eaed4286a8937da1348817bb/awards/4e8136ff281a4f97aca77361f2e29641?acc_token=b08a569f0fc244778d05c70166974957 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 146
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"status": "unsuccessful",
"description": "Candidate didn’t sign the auction protocol in 3 business days",
"title": "Disqualified"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "unsuccessful",
"documents": [
{
"hash": "md5:00000000000000000000000000000000",
"author": "bid_owner",
"title": "auction_protocol.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/f7bfc14aee6f407dbce67342bec27cfe?KeyID=172d32c8&Signature=Z2WHBaMxm15G%252BTbq%2F5DNaCRA05rZV9F0XK1yx2%2FnywzB5d5aNfCSJSW1S6vYZleOfvx%252B11CBfXTAfe34x%2FYYCg%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:16.391113+02:00",
"documentType": "auctionProtocol",
"dateModified": "2019-01-28T12:32:16.391142+02:00",
"id": "81dd291ccb2342628e48c70e22593b4d"
},
{
"hash": "md5:00000000000000000000000000000000",
"author": "auction_owner",
"title": "RejectionProtocol.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/990c527a9fe34b218bcb6330691b6a3a?KeyID=172d32c8&Signature=npfcCCOLpOyFNfnK9p0RC4z5%252BMbLIAozLJ4nOE0tw033hfeLUdS%252BFndF4MtD8MZPw86N%2FG79eG%2F62fpy54S9BQ%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:16.508364+02:00",
"documentType": "rejectionProtocol",
"dateModified": "2019-01-28T12:32:16.508385+02:00",
"id": "b743cbdfd1444110bfdf3740457ddff1"
}
],
"verificationPeriod": {
"startDate": "2019-01-28T12:32:16.245982+02:00",
"endDate": "2019-01-28T12:32:16.660016+02:00"
},
"description": "Candidate didn’t sign the auction protocol in 3 business days",
"title": "Disqualified",
"suppliers": [
{
"additionalIdentifiers": [
{
"scheme": "UA-FIN",
"id": "А01 457213"
}
],
"contactPoint": {
"name": "Державне управління справами",
"telephone": "0440000000"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00037256",
"uri": "http://www.dus.gov.ua/"
},
"name": "Державне управління справами",
"address": {
"postalCode": "01220",
"countryName": "Україна",
"streetAddress": "вул. Банкова, 11, корпус 1",
"region": "м. Київ",
"locality": "м. Київ"
}
}
],
"complaintPeriod": {
"startDate": "2019-01-28T12:32:15.706689+02:00",
"endDate": "2019-01-28T12:32:16.660016+02:00"
},
"bid_id": "9d7e4eed27534b56b663ea362332e0ab",
"value": {
"currency": "UAH",
"amount": 500.0,
"valueAddedTaxIncluded": true
},
"date": "2019-01-28T12:32:16.672132+02:00",
"id": "4e8136ff281a4f97aca77361f2e29641",
"signingPeriod": {
"startDate": "2019-01-28T12:32:16.245982+02:00",
"endDate": "2019-02-18T18:00:00+02:00"
}
}
}
Refusal of waiting by another participant¶
The second candidate (participant that has submitted the second highest valid bid at the auction) can refuse to wait for the disqualification of the first candidate:
PATCH /api/2.5/auctions/e0c4d484a95140569171138086703f23/awards/24f7e995bebe479d8acf5d3a9337ff3d?acc_token=898cfa971bac42239310ee094fdb7b78 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 33
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"status": "cancelled"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "cancelled",
"complaintPeriod": {
"startDate": "2019-01-28T12:32:19.988125+02:00",
"endDate": "2019-01-28T12:32:20.223166+02:00"
},
"suppliers": [
{
"contactPoint": {
"email": "soleksuk@gmail.com",
"telephone": "+380 (432) 21-69-30",
"name": "Сергій Олексюк"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00137256",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Школяр»",
"address": {
"postalCode": "21100",
"countryName": "Україна",
"streetAddress": "вул. Островського, 33",
"region": "м. Вінниця",
"locality": "м. Вінниця"
}
}
],
"bid_id": "f59572206a724c87901cfd00ff8244ff",
"value": {
"currency": "UAH",
"amount": 469,
"valueAddedTaxIncluded": true
},
"date": "2019-01-28T12:32:20.234410+02:00",
"id": "24f7e995bebe479d8acf5d3a9337ff3d"
}
}
Note that the action can be completed till the award has pending.waiting status.
Signing contract¶
Contract registration¶
For the contract to be activated, the Organizer has
- to upload contractSigned first:
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/contracts/d76886a9843e4f808588f58574dcb6c9/documents?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 371
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/9148af89eed54101a3fa62cf4422f6d0?KeyID=172d32c8&Signature=PEmdmSpKU9bufx2gED%2BalhGjAyQyrKScHdiXD2FcoDc1jn%2BNEg4FwzEBtvWRmlgFxJeqwG%2FjQEUNPaAa4HjlCg%3D%3D",
"title": "signDocument.pdf",
"format": "application/pdf",
"hash": "md5:00000000000000000000000000000000",
"documentType": "contractSigned"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/contracts/d76886a9843e4f808588f58574dcb6c9/documents/277b59122b864c5fbdee3161f295e02d
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "signDocument.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/9148af89eed54101a3fa62cf4422f6d0?KeyID=172d32c8&Signature=BQNh3no6i2XeO7SjTp1kmzNMtUN3n31qczIjfxF%2FYBzO%2FLNZdr3UXrgR7rdTbQ7vu9uvwNvURBrZCeFq234dAQ%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:21.514717+02:00",
"documentType": "contractSigned",
"dateModified": "2019-01-28T12:32:21.514739+02:00",
"id": "277b59122b864c5fbdee3161f295e02d"
}
}
- set value for dateSigned and
- switch contract status to active:
PATCH /api/2.5/auctions/e0c4d484a95140569171138086703f23/contracts/d76886a9843e4f808588f58574dcb6c9?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 80
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"status": "active",
"dateSigned": "2019-01-28T12:32:21.632395+02:00"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "active",
"documents": [
{
"hash": "md5:00000000000000000000000000000000",
"title": "contract_first_document.doc",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/b7d0b588dd384a978d9ffb21449240f1?KeyID=172d32c8&Signature=LgYWwqGPjlhYsD53mpm8fhwedTGzfeLj0fi6TReADET4PMRZN4qnMRCAMnTnMVQnfNAVvLbWyJ4WvCq3XdWGCQ%253D%253D",
"format": "application/msword",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:21.096880+02:00",
"dateModified": "2019-01-28T12:32:21.096930+02:00",
"id": "bc2700d6e7fd485ea78e86cb23fbe9bf"
},
{
"hash": "md5:00000000000000000000000000000000",
"title": "contract_second_document.doc",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/27494a750520467582b01376318dd217?KeyID=172d32c8&Signature=9sdWrx0iQvYIUAxDgiR32B9BSYmOZ96gJsR0e8MPapGT5dFb8q2N2GfJddGJEFRcNLBTJT%2Fup4jUrmMJeOOvBA%253D%253D",
"format": "application/msword",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:21.318353+02:00",
"dateModified": "2019-01-28T12:32:21.318392+02:00",
"id": "60b804cd00ec403f99158d127f552d7e"
},
{
"hash": "md5:00000000000000000000000000000000",
"title": "signDocument.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/9148af89eed54101a3fa62cf4422f6d0?KeyID=172d32c8&Signature=BQNh3no6i2XeO7SjTp1kmzNMtUN3n31qczIjfxF%2FYBzO%2FLNZdr3UXrgR7rdTbQ7vu9uvwNvURBrZCeFq234dAQ%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:21.514717+02:00",
"documentType": "contractSigned",
"dateModified": "2019-01-28T12:32:21.514739+02:00",
"id": "277b59122b864c5fbdee3161f295e02d"
}
],
"signingPeriod": {
"startDate": "2019-01-28T12:32:19.988125+02:00",
"endDate": "2019-02-18T18:00:00+02:00"
},
"items": [
{
"description": "Земля для військовослужбовців",
"classification": {
"scheme": "CPV",
"description": "Земельні ділянки",
"id": "51413000-0"
},
"address": {
"postalCode": "79000",
"countryName": "Україна",
"streetAddress": "вул. Банкова 1",
"region": "м. Київ",
"locality": "м. Київ"
},
"id": "46ff602897964fdeb334c4a55e9bc9d7",
"unit": {
"code": "44617100-9",
"name": "item"
},
"quantity": 5
}
],
"suppliers": [
{
"contactPoint": {
"email": "aagt@gmail.com",
"telephone": "+380 (322) 91-69-30",
"name": "Андрій Олексюк"
},
"identifier": {
"scheme": "UA-EDR",
"id": "00137226",
"uri": "http://www.sc.gov.ua/"
},
"name": "ДКП «Книга»",
"address": {
"postalCode": "79013",
"countryName": "Україна",
"streetAddress": "вул. Островського, 34",
"region": "м. Львів",
"locality": "м. Львів"
}
}
],
"period": {
"startDate": "2019-01-28T12:32:10.896560+02:00",
"endDate": "2020-01-28T12:32:10.896560+02:00"
},
"dateSigned": "2019-01-28T12:32:21.632395+02:00",
"value": {
"currency": "UAH",
"amount": 479,
"valueAddedTaxIncluded": true
},
"date": "2019-01-28T12:32:21.772640+02:00",
"awardID": "8e0279bc48cd41949e6ba8d436f31a0f",
"id": "d76886a9843e4f808588f58574dcb6c9",
"contractID": "UA-EA-2019-01-28-000002-1"
}
}
As soon as the contracts receives active status, the procedure becomes complete.
Cancelling auction¶
Organizer can cancel auction anytime (except when auction has terminal status e.g. unsuccesfull, canceled, complete).
The following steps should be applied:
- Prepare cancellation request.
- Fill it with the protocol describing the cancellation reasons.
- Cancel the auction with the reasons prepared.
Only the request that has been activated (3rd step above) has power to cancel auction. I.e. you have to not only prepare cancellation request but to activate it as well.
See Cancellation data structure for details.
Preparing the cancellation request¶
You should pass reason, status defaults to pending. id is autogenerated and passed in the Location header of response.
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/cancellations?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 43
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"reason": "cancellation reason"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/cancellations/a26b6050db80408983ad92b6bca5f1c6
X-Content-Type-Options: nosniff
{
"data": {
"date": "2019-01-28T12:32:22.086444+02:00",
"status": "pending",
"reason": "cancellation reason",
"cancellationOf": "tender",
"id": "a26b6050db80408983ad92b6bca5f1c6"
}
}
Filling cancellation with protocol and supplementary documentation¶
Upload the file contents:
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/cancellations/a26b6050db80408983ad92b6bca5f1c6/documents?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 329
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/0b8cfaf813ef42ab9fb4368c3502ad3d?KeyID=172d32c8&Signature=aj4XnrwIw5XtQ4RtCrc7ouV9FeUCjO5v5TeLwtvzcn2raOsdKZI%2B4O7Jcin3nQT1O1sgkCh9J%2FEK0W89ilDbDQ%3D%3D",
"title": "Notice.pdf",
"hash": "md5:00000000000000000000000000000000",
"format": "application/pdf"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/cancellations/a26b6050db80408983ad92b6bca5f1c6/documents/fb5be37e1ada459ab4a05622f31541e4
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"title": "Notice.pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/0b8cfaf813ef42ab9fb4368c3502ad3d?KeyID=172d32c8&Signature=aPf4hHKbP%252BxZkpagxIVO136KI66kwUjjSSvwS56J0HMOGb0vT1cc3HgMhnAD1K%252B4v6Nvr%2FATeDCjqFotR3asDA%253D%253D",
"format": "application/pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:22.306099+02:00",
"dateModified": "2019-01-28T12:32:22.306133+02:00",
"id": "fb5be37e1ada459ab4a05622f31541e4"
}
}
Change the document description and other properties:
PATCH /api/2.5/auctions/e0c4d484a95140569171138086703f23/cancellations/a26b6050db80408983ad92b6bca5f1c6/documents/fb5be37e1ada459ab4a05622f31541e4?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 48
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"description": "Changed description"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"description": "Changed description",
"format": "application/pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/0b8cfaf813ef42ab9fb4368c3502ad3d?KeyID=172d32c8&Signature=aPf4hHKbP%252BxZkpagxIVO136KI66kwUjjSSvwS56J0HMOGb0vT1cc3HgMhnAD1K%252B4v6Nvr%2FATeDCjqFotR3asDA%253D%253D",
"title": "Notice.pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:22.306099+02:00",
"dateModified": "2019-01-28T12:32:22.306133+02:00",
"id": "fb5be37e1ada459ab4a05622f31541e4"
}
}
Upload new version of the document:
PUT /api/2.5/auctions/e0c4d484a95140569171138086703f23/cancellations/a26b6050db80408983ad92b6bca5f1c6/documents/fb5be37e1ada459ab4a05622f31541e4?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 327
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/3f54300127784140bd8dc69c407ac851?KeyID=172d32c8&Signature=PxO3c07cLYGXhhtgqM4muUTOIeNRy2EoI2r0ZvSboFJCHsqqjGxOrOTGKFlBk2GGdTdJyFQkLG0dVp0NOobcBA%3D%3D",
"title": "Notice-2.pdf",
"hash": "md5:00000000000000000000000000000000",
"format": "application/pdf"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"description": "Changed description",
"format": "application/pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/3f54300127784140bd8dc69c407ac851?KeyID=172d32c8&Signature=70fWiI5taKEkiCIFmLijKvdnZ3jEemrJfFlLEbQ63JvQGRRO9WgMdUt57TSC0SMkEnlwsLRr%252BM1FsyQuNkDrAw%253D%253D",
"title": "Notice-2.pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:22.306099+02:00",
"dateModified": "2019-01-28T12:32:22.792398+02:00",
"id": "fb5be37e1ada459ab4a05622f31541e4"
}
}
Activating the request and cancelling auction¶
PATCH /api/2.5/auctions/e0c4d484a95140569171138086703f23/cancellations/a26b6050db80408983ad92b6bca5f1c6?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 30
Content-Type: application/json
Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions
DATA:
{
"data": {
"status": "active"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "active",
"documents": [
{
"hash": "md5:00000000000000000000000000000000",
"description": "Changed description",
"format": "application/pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/0b8cfaf813ef42ab9fb4368c3502ad3d?KeyID=172d32c8&Signature=aPf4hHKbP%252BxZkpagxIVO136KI66kwUjjSSvwS56J0HMOGb0vT1cc3HgMhnAD1K%252B4v6Nvr%2FATeDCjqFotR3asDA%253D%253D",
"title": "Notice.pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:22.306099+02:00",
"dateModified": "2019-01-28T12:32:22.306133+02:00",
"id": "fb5be37e1ada459ab4a05622f31541e4"
},
{
"hash": "md5:00000000000000000000000000000000",
"description": "Changed description",
"format": "application/pdf",
"url": "http://public.docs-sandbox.ea.openprocurement.org/get/3f54300127784140bd8dc69c407ac851?KeyID=172d32c8&Signature=70fWiI5taKEkiCIFmLijKvdnZ3jEemrJfFlLEbQ63JvQGRRO9WgMdUt57TSC0SMkEnlwsLRr%252BM1FsyQuNkDrAw%253D%253D",
"title": "Notice-2.pdf",
"documentOf": "auction",
"datePublished": "2019-01-28T12:32:22.306099+02:00",
"dateModified": "2019-01-28T12:32:22.792398+02:00",
"id": "fb5be37e1ada459ab4a05622f31541e4"
}
],
"reason": "cancellation reason",
"date": "2019-01-28T12:32:22.947408+02:00",
"cancellationOf": "tender",
"id": "a26b6050db80408983ad92b6bca5f1c6"
}
}
Acceleration mode for sandbox¶
If you want to experiment with auctions, you can use acceleration mode and start your auction name with “TESTING”.
Acceleration mode was developed to enable the procedure testing in the sandbox and to reduce time frames of this procedure.
- To enable acceleration mode you will need to:
add additional parameter mode with a value
test
;set
quick, accelerator=1440
as text value for procurementMethodDetails. This parameter will accelerate auction periods. The number 1440 shows that restrictions and time frames will be reduced in 1440 times.- for the submissionMethodDetails you need to select 1 of 4 options:
- set
fast-forward,dutch=-:-,sealedbid=-:---,bestbid=-:---
as text value.dutch= - : -
- at which step and who won in dutch part.sealedbid= - : ---
- who scored on sealedbid and with what rate.bestbid= - : ---
- who scored on bestbid and with what rate. - set
fast-forward,option1
as text value. The auction will have a bet in dutch part. Minimum required number of participants - 1. - set
fast-forward,option2
as text value. The auction will have a bet in dutch part, a bet on sealedbid. Minimum required number of participants - 2. - set
fast-forward,option3
as text value. The auction will have a bet in dutch part, a bet on sealedbid, and a bet on bestbid. Minimum required number of participants - 2.
- set
This mode will work only in the sandbox.
Documents Uploading¶
All of the document uploading API endpoints follow the same set of rules.
Upload document with registration¶
Add document in API:
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0 Authorization: Basic YnJva2VyOg== Content-Length: 407 Content-Type: application/json Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions DATA: { "data": { "hash": "md5:00000000000000000000000000000000", "description": "document description", "title": "Notice.pdf", "url": "http://public.docs-sandbox.ea.openprocurement.org/get/6ac51cb148a042db8c3ff05ca03e17eb?KeyID=172d32c8&Signature=5e4W7kjbPCSTnRdcmDox0Ro9u3Nd2e0kGJnnSvWq1WSFZc95Vk2Kzg2HnCYMsLSscPP8JMYvbjxaB6s9JPHOAw%3D%3D", "format": "application/pdf", "documentType": "technicalSpecifications" } } Response: 201 Created Content-Type: application/json Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/documents/c33444fdcca243b382630e9924d54509 X-Content-Type-Options: nosniff { "data": { "hash": "md5:00000000000000000000000000000000", "description": "document description", "format": "application/pdf", "url": "http://public.docs-sandbox.ea.openprocurement.org/get/6ac51cb148a042db8c3ff05ca03e17eb?KeyID=172d32c8&Signature=ODek9PjlhbCkmeL80dDgAiaDHzTqYEmQSYBqYnKfyIFMJoQsrLkzcPHkb3Cnpj%2FYCHink%252B2Hl6ag%252BbdlGkv1DA%253D%253D", "title": "Notice.pdf", "documentOf": "auction", "datePublished": "2019-01-28T12:32:17.643280+02:00", "documentType": "technicalSpecifications", "dateModified": "2019-01-28T12:32:17.643302+02:00", "id": "c33444fdcca243b382630e9924d54509" } }
Upload document without registration¶
Add document in API:
POST /api/2.5/auctions/e0c4d484a95140569171138086703f23/documents?acc_token=4cc54038a92f4f578a435ca9cb041343 HTTP/1.0 Authorization: Basic YnJva2VyOg== Content-Length: 407 Content-Type: application/json Host: https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions DATA: { "data": { "hash": "md5:00000000000000000000000000000000", "description": "document description", "title": "Notice.pdf", "url": "http://public.docs-sandbox.ea.openprocurement.org/get/6ac51cb148a042db8c3ff05ca03e17eb?KeyID=172d32c8&Signature=5e4W7kjbPCSTnRdcmDox0Ro9u3Nd2e0kGJnnSvWq1WSFZc95Vk2Kzg2HnCYMsLSscPP8JMYvbjxaB6s9JPHOAw%3D%3D", "format": "application/pdf", "documentType": "technicalSpecifications" } } Response: 201 Created Content-Type: application/json Location: http://https://lb.api-sandbox.ea2.openprocurement.net/api/2.3/auctions/api/2.5/auctions/e0c4d484a95140569171138086703f23/documents/c33444fdcca243b382630e9924d54509 X-Content-Type-Options: nosniff { "data": { "hash": "md5:00000000000000000000000000000000", "description": "document description", "format": "application/pdf", "url": "http://public.docs-sandbox.ea.openprocurement.org/get/6ac51cb148a042db8c3ff05ca03e17eb?KeyID=172d32c8&Signature=ODek9PjlhbCkmeL80dDgAiaDHzTqYEmQSYBqYnKfyIFMJoQsrLkzcPHkb3Cnpj%2FYCHink%252B2Hl6ag%252BbdlGkv1DA%253D%253D", "title": "Notice.pdf", "documentOf": "auction", "datePublished": "2019-01-28T12:32:17.643280+02:00", "documentType": "technicalSpecifications", "dateModified": "2019-01-28T12:32:17.643302+02:00", "id": "c33444fdcca243b382630e9924d54509" } }