Skip to content

Commit

Permalink
docs update: ids, data, statuses, listings
Browse files Browse the repository at this point in the history
  • Loading branch information
vmaksymiv committed May 6, 2016
1 parent 713159f commit 7ec5d01
Show file tree
Hide file tree
Showing 10 changed files with 207 additions and 127 deletions.
24 changes: 12 additions & 12 deletions docs/source/tutorial/contract-credentials.http
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PATCH /api/2.3/contracts/7d43086cb00145c2a1fa686cedc49b33/credentials?acc_token=046f42a4a22b465f979cba6594e95de2 HTTP/1.0
PATCH /api/2.3/contracts/6fcb4217dba94b3bb4a0be2a4f9295e8/credentials?acc_token=4254c2346dbf41a9b7729ef251d7d4a0 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 0
Content-Type: application/json
Expand All @@ -8,10 +8,10 @@ Response: 200 OK
Content-Type: application/json; charset=UTF-8
{
"access": {
"token": "f29bb9b5198a4f8e8874ffd88e46d620"
"token": "c3519c536a6949a097b0917669859dc6"
},
"data": {
"status": "active",
"status": "draft",
"items": [
{
"description": "футляри до державних нагород",
Expand All @@ -35,10 +35,10 @@ Content-Type: application/json; charset=UTF-8
"locality": "м. Київ"
},
"deliveryDate": {
"startDate": "2016-04-30T17:13:58.405092+03:00",
"endDate": "2016-05-03T17:13:58.405092+03:00"
"startDate": "2016-05-08T13:05:00.557188+03:00",
"endDate": "2016-05-11T13:05:00.557188+03:00"
},
"id": "31e376b7fa5b4b94b48e434dc407b48b",
"id": "f1313c1c4d1b48e0977260ff43b180a0",
"unit": {
"code": "44617100-9",
"name": "item"
Expand Down Expand Up @@ -67,18 +67,18 @@ Content-Type: application/json; charset=UTF-8
}
}
],
"dateSigned": "2016-04-28T17:14:02.259536+03:00",
"id": "7d43086cb00145c2a1fa686cedc49b33",
"dateSigned": "2016-05-06T13:05:07.386234+03:00",
"id": "6fcb4217dba94b3bb4a0be2a4f9295e8",
"value": {
"currency": "UAH",
"amount": 500.0,
"valueAddedTaxIncluded": true
},
"contractID": "UA-2016-04-28-000001-1",
"contractID": "UA-2016-05-06-000001-1",
"owner": "broker",
"awardID": "3173bad2d423406aac88db17ef83ee6d",
"dateModified": "2016-04-28T17:14:02.709146+03:00",
"tender_id": "9debb416ffc84af8a4925181b063aef6"
"awardID": "d74d7e2719c7439d9a26bef7177fac11",
"dateModified": "2016-05-06T13:05:07.780615+03:00",
"tender_id": "7bb7573b1cd04f8aa238da49ee9059cb"
}
}

14 changes: 12 additions & 2 deletions docs/source/tutorial/contract-documents.http
Original file line number Diff line number Diff line change
@@ -1,10 +1,20 @@
GET /api/2.3/contracts/7d43086cb00145c2a1fa686cedc49b33/documents?acc_token=f29bb9b5198a4f8e8874ffd88e46d620 HTTP/1.0
GET /api/2.3/contracts/6fcb4217dba94b3bb4a0be2a4f9295e8/documents?acc_token=c3519c536a6949a097b0917669859dc6 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: api-sandbox.openprocurement.org

Response: 200 OK
Content-Type: application/json; charset=UTF-8
{
"data": []
"data": [
{
"title": "contract.doc",
"url": "http://api-sandbox.openprocurement.org/api/2.3/contracts/6fcb4217dba94b3bb4a0be2a4f9295e8/documents/085b12492dad438784bdad25ecea9c34?download=d52861ca683b448cb98a6d29cf0a1f61",
"format": "application/msword",
"documentOf": "tender",
"datePublished": "2016-05-06T13:05:08.575843+03:00",
"id": "085b12492dad438784bdad25ecea9c34",
"dateModified": "2016-05-06T13:05:08.575885+03:00"
}
]
}

11 changes: 6 additions & 5 deletions docs/source/tutorial/contracts-listing-1.http
Original file line number Diff line number Diff line change
@@ -1,18 +1,19 @@
GET /api/2.3/contracts HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: api-sandbox.openprocurement.org

Response: 200 OK
Content-Type: application/json; charset=UTF-8
{
"next_page": {
"path": "/api/2.3/contracts?offset=2016-04-28T17%3A14%3A02.519390%2B03%3A00",
"uri": "http://api-sandbox.openprocurement.org/api/2.3/contracts?offset=2016-04-28T17%3A14%3A02.519390%2B03%3A00",
"offset": "2016-04-28T17:14:02.519390+03:00"
"path": "/api/2.3/contracts?offset=2016-05-06T13%3A05%3A07.780615%2B03%3A00",
"uri": "http://api-sandbox.openprocurement.org/api/2.3/contracts?offset=2016-05-06T13%3A05%3A07.780615%2B03%3A00",
"offset": "2016-05-06T13:05:07.780615+03:00"
},
"data": [
{
"id": "7d43086cb00145c2a1fa686cedc49b33",
"dateModified": "2016-04-28T17:14:02.519390+03:00"
"id": "6fcb4217dba94b3bb4a0be2a4f9295e8",
"dateModified": "2016-05-06T13:05:07.780615+03:00"
}
]
}
Expand Down
141 changes: 105 additions & 36 deletions docs/source/tutorial/contracts-patch.http
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
PATCH /api/2.3/contracts/7d43086cb00145c2a1fa686cedc49b33?acc_token=f29bb9b5198a4f8e8874ffd88e46d620 HTTP/1.0
PATCH /api/2.3/contracts/6fcb4217dba94b3bb4a0be2a4f9295e8?acc_token=c3519c536a6949a097b0917669859dc6 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 32
Content-Type: application/json
Expand All @@ -15,35 +15,100 @@ Content-Type: application/json; charset=UTF-8
{
"data": {
"status": "active",
"documents": [
{
"title": "contract.doc",
"url": "http://api-sandbox.openprocurement.org/api/2.3/contracts/7d43086cb00145c2a1fa686cedc49b33/documents/429a2e06edaa44039efe7007dc4d2416?download=1d19a7bd2fc546e39237a4b52629d44b",
"format": "application/msword",
"documentOf": "tender",
"datePublished": "2016-04-28T17:14:03.088354+03:00",
"id": "429a2e06edaa44039efe7007dc4d2416",
"dateModified": "2016-04-28T17:14:03.088392+03:00"
},
"title": "New Title",
"items": [
{
"title": "contract_update.doc",
"url": "http://api-sandbox.openprocurement.org/api/2.3/contracts/7d43086cb00145c2a1fa686cedc49b33/documents/dfc79dc058f24c33a6a6820ebe44a384?download=473d0a5033d74c189d3ea0a7ba6ff5bd",
"format": "application/msword",
"documentOf": "tender",
"datePublished": "2016-04-28T17:14:03.239503+03:00",
"id": "dfc79dc058f24c33a6a6820ebe44a384",
"dateModified": "2016-04-28T17:14:03.239544+03:00"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Cartons",
"id": "44617100-9"
},
"additionalClassifications": [
{
"scheme": "ДКПП",
"id": "17.21.1",
"description": "папір і картон гофровані, паперова й картонна тара"
}
],
"deliveryAddress": {
"postalCode": "79000",
"countryName": "Україна",
"streetAddress": "вул. Банкова 1",
"region": "м. Київ",
"locality": "м. Київ"
},
"deliveryDate": {
"startDate": "2016-05-08T13:05:00.557188+03:00",
"endDate": "2016-05-11T13:05:00.557188+03:00"
},
"id": "f1313c1c4d1b48e0977260ff43b180a0",
"unit": {
"code": "44617100-9",
"name": "item"
},
"quantity": 5
}
],
"suppliers": [
{
"title": "contract_update.doc",
"url": "http://api-sandbox.openprocurement.org/api/2.3/contracts/7d43086cb00145c2a1fa686cedc49b33/documents/dfc79dc058f24c33a6a6820ebe44a384?download=083ae815e3bc40f797afe60eaac3d841",
"format": "application/msword",
"documentOf": "tender",
"datePublished": "2016-04-28T17:14:03.239503+03:00",
"id": "dfc79dc058f24c33a6a6820ebe44a384",
"dateModified": "2016-04-28T17:14:03.365355+03:00"
"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": "м. Київ"
}
}
],
"dateSigned": "2016-05-06T13:05:07.386234+03:00",
"id": "6fcb4217dba94b3bb4a0be2a4f9295e8",
"value": {
"currency": "UAH",
"amount": 500.0,
"valueAddedTaxIncluded": true
},
"contractID": "UA-2016-05-06-000001-1",
"owner": "broker",
"awardID": "d74d7e2719c7439d9a26bef7177fac11",
"dateModified": "2016-05-06T13:05:08.073732+03:00",
"tender_id": "7bb7573b1cd04f8aa238da49ee9059cb"
}
}

PATCH /api/2.3/contracts/6fcb4217dba94b3bb4a0be2a4f9295e8?acc_token=c3519c536a6949a097b0917669859dc6 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 144
Content-Type: application/json
Host: api-sandbox.openprocurement.org
DATA:
{
"data": {
"period": {
"startDate": "2016-05-06T13:05:08.093238+03:00",
"endDate": "2016-06-05T13:05:08.093324+03:00"
},
"value": {
"amount": 438
}
}
}

Response: 200 OK
Content-Type: application/json; charset=UTF-8
{
"data": {
"status": "active",
"title": "New Title",
"items": [
{
Expand All @@ -68,10 +133,10 @@ Content-Type: application/json; charset=UTF-8
"locality": "м. Київ"
},
"deliveryDate": {
"startDate": "2016-04-30T17:13:58.405092+03:00",
"endDate": "2016-05-03T17:13:58.405092+03:00"
"startDate": "2016-05-08T13:05:00.557188+03:00",
"endDate": "2016-05-11T13:05:00.557188+03:00"
},
"id": "31e376b7fa5b4b94b48e434dc407b48b",
"id": "f1313c1c4d1b48e0977260ff43b180a0",
"unit": {
"code": "44617100-9",
"name": "item"
Expand Down Expand Up @@ -100,18 +165,22 @@ Content-Type: application/json; charset=UTF-8
}
}
],
"period": {
"startDate": "2016-05-06T13:05:08.093238+03:00",
"endDate": "2016-06-05T13:05:08.093324+03:00"
},
"value": {
"currency": "UAH",
"amount": 500.0,
"amount": 438.0,
"valueAddedTaxIncluded": true
},
"id": "7d43086cb00145c2a1fa686cedc49b33",
"dateSigned": "2016-04-28T17:14:02.259536+03:00",
"contractID": "UA-2016-04-28-000001-1",
"id": "6fcb4217dba94b3bb4a0be2a4f9295e8",
"dateSigned": "2016-05-06T13:05:07.386234+03:00",
"contractID": "UA-2016-05-06-000001-1",
"owner": "broker",
"awardID": "3173bad2d423406aac88db17ef83ee6d",
"dateModified": "2016-04-28T17:14:03.568306+03:00",
"tender_id": "9debb416ffc84af8a4925181b063aef6"
"awardID": "d74d7e2719c7439d9a26bef7177fac11",
"dateModified": "2016-05-06T13:05:08.183574+03:00",
"tender_id": "7bb7573b1cd04f8aa238da49ee9059cb"
}
}

16 changes: 8 additions & 8 deletions docs/source/tutorial/example_contract.http
Original file line number Diff line number Diff line change
@@ -1,4 +1,4 @@
GET /api/2.3/tenders/9debb416ffc84af8a4925181b063aef6/contracts/7d43086cb00145c2a1fa686cedc49b33 HTTP/1.0
GET /api/2.3/tenders/7bb7573b1cd04f8aa238da49ee9059cb/contracts/6fcb4217dba94b3bb4a0be2a4f9295e8 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: api-sandbox.openprocurement.org

Expand Down Expand Up @@ -30,10 +30,10 @@ Content-Type: application/json; charset=UTF-8
"locality": "м. Київ"
},
"deliveryDate": {
"startDate": "2016-04-30T17:13:58.405092+03:00",
"endDate": "2016-05-03T17:13:58.405092+03:00"
"startDate": "2016-05-08T13:05:00.557188+03:00",
"endDate": "2016-05-11T13:05:00.557188+03:00"
},
"id": "31e376b7fa5b4b94b48e434dc407b48b",
"id": "f1313c1c4d1b48e0977260ff43b180a0",
"unit": {
"code": "44617100-9",
"name": "item"
Expand Down Expand Up @@ -67,10 +67,10 @@ Content-Type: application/json; charset=UTF-8
"amount": 500.0,
"valueAddedTaxIncluded": true
},
"dateSigned": "2016-04-28T17:14:02.259536+03:00",
"awardID": "3173bad2d423406aac88db17ef83ee6d",
"id": "7d43086cb00145c2a1fa686cedc49b33",
"contractID": "UA-2016-04-28-000001-1"
"dateSigned": "2016-05-06T13:05:07.386234+03:00",
"awardID": "d74d7e2719c7439d9a26bef7177fac11",
"id": "6fcb4217dba94b3bb4a0be2a4f9295e8",
"contractID": "UA-2016-05-06-000001-1"
}
}

0 comments on commit 7ec5d01

Please sign in to comment.