Skip to content

Commit b3b0992

Browse files
myroslavmyroslav
committed
Updating tutorial with sections about documentation uploading, Bid registration, and qualification confirmation. Fixes: #5. a18673866971731
1 parent c4075fa commit b3b0992

21 files changed

Lines changed: 530 additions & 289 deletions

‎docs/source/tutorial.rst‎

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -88,3 +88,68 @@ Checking the listing again reflects the new modification date:
8888

8989
.. include:: tutorial/tender-listing-after-patch.http
9090
:code:
91+
92+
Uploading documentation
93+
-----------------------
94+
95+
Procuring entity can upload PDF files into tender created. Uploading should
96+
follow the :ref:`upload` rules.
97+
98+
.. include:: tutorial/upload-tender-notice.http
99+
:code:
100+
101+
`201 Created` response code and `Location` header confirm document creation.
102+
We can additionally query the `documents` collection API endpoint to confirm the
103+
action:
104+
105+
.. include:: tutorial/tender-documents.http
106+
:code:
107+
108+
The single array element describes the document uploaded. We can upload more documents:
109+
110+
.. include:: tutorial/upload-award-criteria.http
111+
:code:
112+
113+
And again we can confirm that there are two documents uploaded.
114+
115+
.. include:: tutorial/tender-documents-2.http
116+
:code:
117+
118+
In case we made an error, we can reupload the document over the older version:
119+
120+
.. include:: tutorial/update-award-criteria.http
121+
:code:
122+
123+
And we can see that it is overriding the original version:
124+
125+
.. include:: tutorial/tender-documents-3.http
126+
:code:
127+
128+
129+
Registering bid
130+
---------------
131+
132+
Bidder can register a bid:
133+
134+
.. include:: tutorial/register-bidder.http
135+
:code:
136+
137+
And upload proposal document:
138+
139+
.. include:: tutorial/upload-bid-proposal.http
140+
:code:
141+
142+
It is possible to check documents uploaded:
143+
144+
.. include:: tutorial/bidder-documents.http
145+
:code:
146+
147+
148+
Confirming qualification
149+
------------------------
150+
151+
Qualification comission registers its decision via following call:
152+
153+
.. include:: tutorial/confirm-qualification.http
154+
:code:
155+

‎docs/source/tutorial/bidder-documents.http‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
$ http http://api-sandbox.openprocurement.org/api/0/tenders/b65397298b2e4d9b987adf576d13b9f5/bidders/8b10e0c38c0747739515b420123d94a8/documents
2+
GET /api/0/tenders/b65397298b2e4d9b987adf576d13b9f5/bidders/8b10e0c38c0747739515b420123d94a8/documents HTTP/1.1
3+
4+
5+
6+
HTTP/1.1 200 OK
7+
Content-Type: application/json; charset=UTF-8
8+
9+
{
10+
"data": [
11+
{
12+
"datePublished": "2014-11-08T00:09:37.274444",
13+
"format": "text/plain",
14+
"id": "16a9eab495de4f1ebb747a0804384422",
15+
"modified": "2014-11-08T00:09:37.274477",
16+
"title": "Proposal.pdf",
17+
"url": "http://api-sandbox.openprocurement.org/api/0/tenders/b65397298b2e4d9b987adf576d13b9f5/bidders/8b10e0c38c0747739515b420123d94a8/documents/16a9eab495de4f1ebb747a0804384422?download=b18c49f26d7b4e5a988f8955552b12fd"
18+
}
19+
]
20+
}

‎docs/source/tutorial/blank-tender-view.http‎

Lines changed: 14 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -1,14 +1,16 @@
1-
curl -v http://api-sandbox.openprocurement.org/api/0/tenders/be40e257812044f3913534cc537d1f99
2-
> GET /api/0/tenders/be40e257812044f3913534cc537d1f99 HTTP/1.1
3-
> Host: api-sandbox.openprocurement.org
4-
>
5-
< HTTP/1.1 200 OK
6-
< Content-Type: application/json; charset=UTF-8
7-
<
1+
$ http http://api-sandbox.openprocurement.org/api/0/tenders/f66b5a7d00504245b26961bda8d90ba6
2+
GET /api/0/tenders/f66b5a7d00504245b26961bda8d90ba6 HTTP/1.1
3+
4+
5+
6+
HTTP/1.1 200 OK
7+
Content-Type: application/json; charset=UTF-8
8+
89
{
9-
"data": {
10-
"id": "be40e257812044f3913534cc537d1f99",
11-
"tenderID": "UA-be40e257812044f3913534cc537d1f99",
12-
"modified": "2014-10-25T00:24:12.772078"
13-
}
10+
"data": {
11+
"id": "f66b5a7d00504245b26961bda8d90ba6",
12+
"modified": "2014-11-08T00:09:28.530198",
13+
"status": "enquiries",
14+
"tenderID": "UA-f66b5a7d00504245b26961bda8d90ba6"
15+
}
1416
}

‎docs/source/tutorial/confirm-qualification.http‎

Lines changed: 20 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,20 @@
1+
$ http -j POST http://api-sandbox.openprocurement.org/api/0/tenders/b65397298b2e4d9b987adf576d13b9f5/awards data:={"awardStatus":"pending"}
2+
POST /api/0/tenders/b65397298b2e4d9b987adf576d13b9f5/awards HTTP/1.1
3+
Content-Type: application/json; charset=utf-8
4+
5+
{
6+
"data": {
7+
"awardStatus": "pending"
8+
}
9+
}
10+
11+
HTTP/1.1 201 Created
12+
Content-Type: application/json; charset=UTF-8
13+
14+
{
15+
"data": {
16+
"awardDate": "2014-11-08T00:09:38.405176",
17+
"awardID": "013c5278db3d4ef7a3fa1452cbd0ab69",
18+
"awardStatus": "pending"
19+
}
20+
}

‎docs/source/tutorial/create-tender-procuringEntity.http‎

Lines changed: 47 additions & 47 deletions
Original file line numberDiff line numberDiff line change
@@ -1,51 +1,51 @@
1-
curl -v -H "Content-Type: application/json" --data @tender.json -X POST http://api-sandbox.openprocurement.org/api/0/tenders
2-
> POST /api/0/tenders HTTP/1.1
3-
> Host: api-sandbox.openprocurement.org
4-
> Content-Type: application/json
5-
>
6-
> {
7-
> "data":{
8-
> "procuringEntity": {
9-
> "id": {
10-
> "name": "Заклад \"Загальноосвітня школа І-ІІІ ступенів № 10 Вінницької міської ради\"",
11-
> "scheme": "https://ns.openprocurement.org/ua/edrpou",
12-
> "uid": "21725150",
13-
> "uri": "http://sch10.edu.vn.ua/"
14-
> },
15-
> "address": {
16-
> "countryName": "Україна",
17-
> "postalCode": "21027",
18-
> "region": "м. Вінниця",
19-
> "locality": "м. Вінниця",
20-
> "streetAddress": "вул. Стахурського. 22"
21-
> }
22-
> }
23-
> }
24-
> }
1+
$ http -j POST http://api-sandbox.openprocurement.org/api/0/tenders data:=@./school-tender.json
2+
POST /api/0/tenders HTTP/1.1
3+
Content-Type: application/json; charset=utf-8
4+
5+
{
6+
"data": {
7+
"procuringEntity": {
8+
"address": {
9+
"countryName": "Україна",
10+
"locality": "м. Вінниця",
11+
"postalCode": "21027",
12+
"region": "м. Вінниця",
13+
"streetAddress": "вул. Стахурського. 22"
14+
},
15+
"id": {
16+
"name": "Заклад \"Загальноосвітня школа І-ІІІ ступенів № 10 Вінницької міської ради\"",
17+
"scheme": "https://ns.openprocurement.org/ua/edrpou",
18+
"uid": "21725150",
19+
"uri": "http://sch10.edu.vn.ua/"
20+
}
21+
}
22+
}
23+
}
2524

26-
< HTTP/1.1 201 Created
27-
< Content-Type: application/json; charset=UTF-8
28-
< Location: http://api-sandbox.openprocurement.org/api/0/tenders/8c2ba371505348ed8f5f0e5119a80451
29-
<
25+
HTTP/1.1 201 Created
26+
Content-Type: application/json; charset=UTF-8
27+
Location: http://api-sandbox.openprocurement.org/api/0/tenders/b65397298b2e4d9b987adf576d13b9f5
28+
3029
{
31-
"data": {
32-
"id": "8c2ba371505348ed8f5f0e5119a80451",
33-
"tenderID": "UA-8c2ba371505348ed8f5f0e5119a80451",
34-
"modified": "2014-10-25T00:37:13.847358",
35-
"procuringEntity": {
36-
"id": {
37-
"scheme": "https:\/\/ns.openprocurement.org\/ua\/edrpou",
38-
"name": "\u0417\u0430\u043a\u043b\u0430\u0434 \"\u0417\u0430\u0433\u0430\u043b\u044c\u043d\u043e\u043e\u0441\u0432\u0456\u0442\u043d\u044f \u0448\u043a\u043e\u043b\u0430 \u0406-\u0406\u0406\u0406 \u0441\u0442\u0443\u043f\u0435\u043d\u0456\u0432 \u2116 10 \u0412\u0456\u043d\u043d\u0438\u0446\u044c\u043a\u043e\u0457 \u043c\u0456\u0441\u044c\u043a\u043e\u0457 \u0440\u0430\u0434\u0438\"",
39-
"uri": "http:\/\/sch10.edu.vn.ua\/",
40-
"uid": "21725150"
41-
},
42-
"address": {
43-
"postalCode": "21027",
44-
"countryName": "\u0423\u043a\u0440\u0430\u0457\u043d\u0430",
45-
"streetAddress": "\u0432\u0443\u043b. \u0421\u0442\u0430\u0445\u0443\u0440\u0441\u044c\u043a\u043e\u0433\u043e. 22",
46-
"region": "\u043c. \u0412\u0456\u043d\u043d\u0438\u0446\u044f",
47-
"locality": "\u043c. \u0412\u0456\u043d\u043d\u0438\u0446\u044f"
48-
}
30+
"data": {
31+
"id": "b65397298b2e4d9b987adf576d13b9f5",
32+
"modified": "2014-11-08T00:09:30.047639",
33+
"procuringEntity": {
34+
"address": {
35+
"countryName": "Україна",
36+
"locality": "м. Вінниця",
37+
"postalCode": "21027",
38+
"region": "м. Вінниця",
39+
"streetAddress": "вул. Стахурського. 22"
40+
},
41+
"id": {
42+
"name": "Заклад \"Загальноосвітня школа І-ІІІ ступенів № 10 Вінницької міської ради\"",
43+
"scheme": "https://ns.openprocurement.org/ua/edrpou",
44+
"uid": "21725150",
45+
"uri": "http://sch10.edu.vn.ua/"
46+
}
47+
},
48+
"status": "enquiries",
49+
"tenderID": "UA-b65397298b2e4d9b987adf576d13b9f5"
4950
}
50-
}
5151
}

‎docs/source/tutorial/initial-tender-listing.http‎

Lines changed: 14 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,16 @@
1-
curl -v http://api-sandbox.openprocurement.org/api/0/tenders
2-
> GET /api/0/tenders HTTP/1.1
3-
> Host: api-sandbox.openprocurement.org
4-
>
5-
< HTTP/1.1 200 OK
6-
< Content-Type: application/json; charset=UTF-8
7-
<
1+
$ http http://api-sandbox.openprocurement.org/api/0/tenders
2+
GET /api/0/tenders HTTP/1.1
3+
4+
5+
6+
HTTP/1.1 200 OK
7+
Content-Type: application/json; charset=UTF-8
8+
89
{
9-
"data": []
10+
"data": [],
11+
"next_page": {
12+
"offset": "2014-11-08T00:09:27.097664",
13+
"path": "/api/0/tenders?offset=2014-11-08T00%3A09%3A27.097664",
14+
"uri": "http://api-sandbox.openprocurement.org/api/0/tenders?offset=2014-11-08T00%3A09%3A27.097664"
15+
}
1016
}

0 commit comments

Comments
 (0)