Tutorial¶
Here is the list of inspections:
GET /api/2.5/inspections HTTP/1.0
Authorization: Basic dGVzdF9zYXM6dGVzdF9zYXNfdG9rZW4=
Host: audit-api-sandbox.prozorro.gov.ua
Response: 200 OK
Content-Type: application/json
{
"data": [],
"next_page": {
"offset": "",
"path": "/api/2.5/inspections?offset=",
"uri": "http://audit-api-sandbox.prozorro.gov.ua/api/2.5/inspections?offset="
}
}
There are no inspections, so let’s post one:
POST /api/2.5/inspections HTTP/1.0
Authorization: Basic dGVzdF9zYXM6dGVzdF9zYXNfdG9rZW4=
Content-Length: 291
Content-Type: application/json
Host: audit-api-sandbox.prozorro.gov.ua
DATA:
{
"data": {
"monitoring_ids": [
"a6b2b18977f24277b238c7b7a5342b1d",
"580997bb06674235801d75f2f6e6c6c6",
"2c5cc4a289d747a5b8dacd72adaea4d9"
],
"description": "Inspection is an official visit to a building or organization to check that everything is satisfactory and that rules are being obeyed"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://audit-api-sandbox.prozorro.gov.ua/api/2.5/inspections/32bd447a7a024973a7eb88b58ba5a75e
{
"data": {
"monitoring_ids": [
"a6b2b18977f24277b238c7b7a5342b1d",
"580997bb06674235801d75f2f6e6c6c6",
"2c5cc4a289d747a5b8dacd72adaea4d9"
],
"description": "Inspection is an official visit to a building or organization to check that everything is satisfactory and that rules are being obeyed",
"inspection_id": "UA-I-2018-01-01-000001",
"dateModified": "2018-01-01T02:00:00+02:00",
"dateCreated": "2018-01-01T02:00:00+02:00",
"id": "32bd447a7a024973a7eb88b58ba5a75e"
}
}
Documents can be added to the object:
POST /api/2.5/inspections/32bd447a7a024973a7eb88b58ba5a75e/documents HTTP/1.0
Authorization: Basic dGVzdF9zYXM6dGVzdF9zYXNfdG9rZW4=
Content-Length: 314
Content-Type: application/json
Host: audit-api-sandbox.prozorro.gov.ua
DATA:
{
"data": {
"title": "doc.txt",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/cb24ad29b9a2463eacf26ea75a1dcec7?Signature=oI4gndGi1vcs9AfrrpTeTDDYJYYdNI1oILD%2F76fIfuSJSwPNZDOfEIwsBdjLNEixSTn%2Fl9krnPi9SI0ksGz1Dw%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "plain/text"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://audit-api-sandbox.prozorro.gov.ua/api/2.5/inspections/32bd447a7a024973a7eb88b58ba5a75e/documents/7c73ad5badbf4288bd24bac55e3ac5e6
{
"data": {
"id": "7c73ad5badbf4288bd24bac55e3ac5e6",
"hash": "md5:00000000000000000000000000000000",
"title": "doc.txt",
"format": "plain/text",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/cb24ad29b9a2463eacf26ea75a1dcec7?Signature=j1Cv5NxBsfB3dV27nkGHdIEMnjg5V%2FuSAvWqNcSGgENCwOQR%2FFToKwGvmhDm4uSct3rGJwDQg5%2FMGpcIS2iCAQ%253D%253D&KeyID=a8968c46",
"datePublished": "2018-01-01T02:01:00+02:00",
"dateModified": "2018-01-01T02:01:00+02:00",
"author": "monitoring_owner"
}
}
Documents can be changed:
PUT /api/2.5/inspections/32bd447a7a024973a7eb88b58ba5a75e/documents/7c73ad5badbf4288bd24bac55e3ac5e6 HTTP/1.0
Authorization: Basic dGVzdF9zYXM6dGVzdF9zYXNfdG9rZW4=
Content-Length: 326
Content-Type: application/json
Host: audit-api-sandbox.prozorro.gov.ua
DATA:
{
"data": {
"title": "doc(1).json",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/b3305743561740678519d95d24bffbd2?Signature=9qiC%2B9rFYIsSmA8mDWGNdUq0Q5P5ntUKA8WrS%2Fv6fsg0AGWgoTrhVVlKV2JaVldfksh26UeCj5R%2Fa49pat59DA%3D%3D&KeyID=a8968c46",
"hash": "md5:00000000000000000000000000000000",
"format": "application/json"
}
}
Response: 200 OK
Content-Type: application/json
{
"data": {
"id": "7c73ad5badbf4288bd24bac55e3ac5e6",
"hash": "md5:00000000000000000000000000000000",
"title": "doc(1).json",
"format": "application/json",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/b3305743561740678519d95d24bffbd2?Signature=0k6hFG1yXQaRPGuG%252BHkqNX7cwClU9%2F6qDvOSfFqqyWQjtX1S476zNcFCxvC8LwS65sU7PdPYnI1cySaf8iB3AQ%253D%253D&KeyID=a8968c46",
"datePublished": "2018-01-01T02:01:00+02:00",
"dateModified": "2018-01-01T02:02:00+02:00",
"author": "monitoring_owner"
}
}
And the object itself can be changed:
PATCH /api/2.5/inspections/32bd447a7a024973a7eb88b58ba5a75e HTTP/1.0
Authorization: Basic dGVzdF9zYXM6dGVzdF9zYXNfdG9rZW4=
Content-Length: 144
Content-Type: application/json
Host: audit-api-sandbox.prozorro.gov.ua
DATA:
{
"data": {
"description": "I regretted my decision",
"monitoring_ids": [
"a6b2b18977f24277b238c7b7a5342b1d",
"580997bb06674235801d75f2f6e6c6c6"
]
}
}
Response: 200 OK
Content-Type: application/json
{
"data": {
"monitoring_ids": [
"a6b2b18977f24277b238c7b7a5342b1d",
"580997bb06674235801d75f2f6e6c6c6"
],
"description": "I regretted my decision",
"documents": [
{
"id": "7c73ad5badbf4288bd24bac55e3ac5e6",
"hash": "md5:00000000000000000000000000000000",
"title": "doc.txt",
"format": "plain/text",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/cb24ad29b9a2463eacf26ea75a1dcec7?Signature=j1Cv5NxBsfB3dV27nkGHdIEMnjg5V%2FuSAvWqNcSGgENCwOQR%2FFToKwGvmhDm4uSct3rGJwDQg5%2FMGpcIS2iCAQ%253D%253D&KeyID=a8968c46",
"datePublished": "2018-01-01T02:01:00+02:00",
"dateModified": "2018-01-01T02:01:00+02:00",
"author": "monitoring_owner"
},
{
"id": "7c73ad5badbf4288bd24bac55e3ac5e6",
"hash": "md5:00000000000000000000000000000000",
"title": "doc(1).json",
"format": "application/json",
"url": "http://public-docs-sandbox.prozorro.gov.ua/get/b3305743561740678519d95d24bffbd2?Signature=0k6hFG1yXQaRPGuG%252BHkqNX7cwClU9%2F6qDvOSfFqqyWQjtX1S476zNcFCxvC8LwS65sU7PdPYnI1cySaf8iB3AQ%253D%253D&KeyID=a8968c46",
"datePublished": "2018-01-01T02:01:00+02:00",
"dateModified": "2018-01-01T02:02:00+02:00",
"author": "monitoring_owner"
}
],
"inspection_id": "UA-I-2018-01-01-000001",
"dateModified": "2018-01-01T02:03:00+02:00",
"dateCreated": "2018-01-01T02:00:00+02:00",
"id": "32bd447a7a024973a7eb88b58ba5a75e"
}
}