Skip to content
Switch branches/tags
Go to file
Cannot retrieve contributors at this time


Exploring basic rules

Let's try exploring the /auctions endpoint:

Just invoking it reveals empty set.

Now let's attempt creating some auction:

Error states that the only accepted Content-Type is application/json.

Let's satisfy the Content-type requirement:

Error states that no data has been found in JSON body.

.. index:: Auction

Creating auction

Let's create auction:

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.

Let's access the URL of the created object (the Location header of the response):

We can see the same response we got after creating auction.

Let's see what listing of auctions reveals us:

We do see the auction's internal id and its dateModified datestamp.

Let's try creating auction with more data:

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:

And indeed we have 2 procedures now.

Modifying auction

Let's update procedure by supplementing it with all other essential properties:

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:

.. index:: Document

Uploading documentation

Organizer can upload PDF files into the created auction. Uploading should follow the :ref:`upload` rules.

201 Created response code and Location header confirm document creation. We can additionally query the documents collection API endpoint to confirm the action:

The single array element describes the uploaded document. We can upload more documents:

And again we can confirm that there are two documents uploaded.

In case we made an error, we can reupload the document over the older version:

And we can see that it is overriding the original version:

.. index:: Enquiries, Question, Answer

Uploading illustration

Organizer can upload illustration files into the created auction. Uploading should follow the :ref:`upload` rules.

In order to specify illustration display order, index field can be used (for details see :ref:`document`). Since this illustration should be displayed first, it has "index": 1.

We can check whether illustration is uploaded.

Organizer can upload second illustration. This illustration should be displayed second, so it has "index": 2.

Add third illustration:

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.


When a procedure is in active.tendering status, interested parties can ask questions:

Organizer can answer them:

And one can retrieve the questions list:

Or an individual answer:

.. index:: Bidding

Registering bid

Bidder can register a bid in draft status:

And activate a bid:

And upload proposal document:

It is possible to check the uploaded documents:

For the best effect (biggest economy) auction should have multiple bidders registered:

.. index:: Awarding, Qualification


The auction can be reached at Auction.auctionUrl:

And bidders can find their participation URLs via their bids:

See the Bid.participationUrl in the response. The links can be also retrieved for other participants:


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.

Confirming qualification

For the winner to be qualified, the Organizer has to upload auctionProtocol first:

The winner can also upload auctionProtocol to award:

With the document being uploaded the Organizer has to switch the award to active status:

Disqualification of a candidate

In case of a manual disqualification, the organizer has to upload file with act or rejectionProtocol document type:

And disqualify candidate:

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:

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

  1. to upload contractSigned first:
  1. set value for dateSigned and
  2. switch contract status to active:

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:

  1. Prepare cancellation request.
  2. Fill it with the protocol describing the cancellation reasons.
  3. 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 :ref:`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.

Filling cancellation with protocol and supplementary documentation

Upload the file contents:

Change the document description and other properties:

Upload new version of the document:

Activating the request and cancelling auction