Skip to content
Permalink
master
Switch branches/tags

Name already in use

A tag already exists with the provided branch name. Many Git commands accept both tag and branch names, so creating this branch may cause unexpected behavior. Are you sure you want to create this branch?

openprocurement.tender.esco/docs/source/tutorial.rst

Go to file
 
 
Cannot retrieve contributors at this time
Tutorial Exploring basic rules Creating tender Modifying tender Uploading documentation Enquiries Registering bid Bid registration Proposal Uploading Confidentiality Financial, eligibility and qualification documents uploading Bid invalidation Bid confirmation Batch-mode bid registration Bid Qualification Auction Confirming qualification Setting contract signature date Setting contract validity period Uploading contract documentation Cancelling tender Preparing the cancellation request Filling cancellation with protocol and supplementary documentation Activating the request and cancelling tender
507 lines (301 sloc) 14 KB
Raw Blame
Open in GitHub Desktop

Tutorial

Exploring basic rules

Let's try exploring the /tenders endpoint:

Just invoking it reveals empty set.

Now let's attempt creating some tender:

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:: Tender

Creating tender

Let's provide the data attribute in the submitted body :

Success! Now we can see that new object was 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 tender: its internal id (that matches the Location segment), its official tenderID and dateModified datestamp stating the moment in time when tender was last modified. Note that tender is created with active.tendering status.

The peculiarity of the ESCO procedure is that procurementMethodType is esco. Also, new fields NBUdiscountRate, minimalStepPercentage, fundingKind, yearlyPaymentsPercentageRange were added to tender object.

There is also no opportunity to set up enquiryPeriod, it will be assigned automatically.

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 tender.

Let's see what listing of tenders reveals us:

We do see the internal id of a tender (that can be used to construct full URL by prepending http://api-sandbox.openprocurement.org/api/0/tenders/) and its dateModified datestamp.

Modifying tender

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

We see the added properies have merged with existing tender data. Additionally, the dateModified property was updated to reflect the last modification datestamp.

Checking the listing again reflects the new modification date:

Procuring entity can not change tender if there are less than 7 days before tenderPeriod ends. Changes will not be accepted by API.

That is why tenderPeriod has to be extended by 7 days.

Procuring entity can set bid guarantee:

.. index:: Document

Uploading documentation

Procuring entity can upload PDF files into the created tender. 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

Enquiries

When tender has active.tendering status and Tender.enquiryPeriod.endDate hasn't come yet, interested parties can ask questions:

Procuring entity can answer them:

One can retrieve either questions list:

or individual answer:

Enquiries can be made only during Tender.enquiryPeriod

.. index:: Bidding

Registering bid

Bid registration

Tender status active.tendering allows registration of bids.

Bidder can register a bid with draft status:

and approve to pending status:

Proposal Uploading

Then bidder should upload proposal technical document(s):

Confidentiality

Documents can be either public or private:

  1. Privacy settings can be changed only for the latest version of the document.
  2. When you upload new version of the document, privacy settings are copied from the previous version.
  3. Privacy settings can be changed only during tenderPeriod (with active.tendering status).
  4. If tender has status active.qualification winner can upload only public documents.

Let's upload private document:

To define the document as "private" - confidentiality and confidentialityRationale fields should be set.

confidentiality field value can be either buyerOnly (document is private) or public (document is publicly accessible).

Content of private documents (buyerOnly) can be accessed only by procuring entity or by participant who uploaded them.

confidentialityRationale field is required only for private documents and should contain at least 30 characters.

Let's mark the document as "private":

It is possible to check the uploaded documents:

Financial, eligibility and qualification documents uploading

Financial, eligibility and qualification documents are also a part of Bid but are located in different end-points.

In order to create and/or get financial document financial_documents end-point should be used:

Get financial documents:

In order to create and/or get eligibility document eligibility_documents end-point should be used:

In order to create and/or get qualification document qualification_documents end-point should be used:

Financial and qualification documents will be publicly accessible after the auction. Eligibility documents will become publicly accessible starting from tender pre-qualification period.

Here is bidder proposal with all documents.

Note that financial, eligibility, and qualification documents are stored in financialDocuments, eligibilityDocuments, and qualificationDocuments attributes of :ref:`Bid`.

Bid invalidation

If tender is modified, status of all bid proposals will be changed to invalid. Bid proposal will look the following way after tender has been modified:

Bid confirmation

Bidder should confirm bid proposal:

ESCO procedure demands at least two bidders, so there should be at least two bid proposals registered to move to auction stage. So let's create second bid:

Batch-mode bid registration

Register one more bid with documents using single request (batch-mode):

.. index:: Awarding, Qualification

Bid Qualification

ESCO procedure requires bid qualification.

Let's list qualifications:

Approve first two bids through qualification objects:

We can also reject bid:

And check that qualified bids are switched to active:

Rejected bid is not shown in bids/ listing.

We can access rejected bid by id:

Procuring entity approves qualifications by switching to next status:

You may notice 10 day stand-still time set in qualificationPeriod.

Auction

After auction is scheduled anybody can visit it to watch. The auction can be reached at Tender.auctionUrl:

Bidders can find out their participation URLs via their bids:

See the Bid.participationUrl in the response. Similar, but different, URL can be retrieved for other participants:

Confirming qualification

Qualification commission registers its decision via the following call:

Setting contract signature date

There is a possibility to set custom contract signature date. You can insert appropriate date into the dateSigned field.

If this date is not set, it will be auto-generated on the date of contract registration.

Setting contract validity period

Setting contract validity period is optional, but if it is needed, you can set appropriate startDate and endDate.

Uploading contract documentation

You can upload contract documents for the ESCO procedure.

Let's upload contract document:

201 Created response code and Location header confirm that this document was added.

Let's see the list of contract documents:

We can upload another contract document:

201 Created response code and Location header confirm that the second document was uploaded.

By default, document language is Ukrainian. You can can change it and set another language for the document by assigning appropriate language code to the language field (available options: uk, en, ru). You can also set document's title (e.g. title_en) and description (e.g. description_en) fields. See :ref:`Document` data structure for details.

Let's see the list of all added contract documents:

Let's view separate contract document:

Cancelling tender

Tender creator can cancel tender anytime. The following steps should be applied:

  1. Prepare cancellation request.
  2. Fill it with the protocol describing the cancellation reasons.
  3. Cancel the tender with the prepared reasons.

Only the request that has been activated (3rd step above) has power to cancel tender. 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.

There are two possible types of cancellation reason: tender was cancelled or unsuccessful. By default reasonType value is cancelled.

You can change reasonType value to unsuccessful.

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 tender

We can check if tender was actually cancelled.

Now status value is cancelled.