Welcome to openregistry.lots.loki’s documentation!¶
Please report any problems or suggestions for improvement either via the mailing list or the issue tracker.
Contents:
Overview¶
openregistry.lots.loki contains the description of the Lots Registry.
Features¶
- Lot represents the finalized object to be privatized within the process.
- One asset only may be included in a single lot.
- Asset which is included in lot, marked as attached to it and can’t be used for other lots formation.
- Lot can be deleted only in case of documentType: cancellationDetails has been attached.
- Time for the lot to be edited is rectificationPeriod.
Conventions¶
API accepts JSON or form-encoded content in requests. It returns JSON content in all of its responses, including errors. Only the UTF-8 character encoding is supported for both requests and responses.
All API POST and PUT requests expect a top-level object with a single element in it named data. Successful responses will mirror this format. The data element should itself be an object, containing the parameters for the request.
If the request was successful, we will get a response code of 201 indicating the object was created. That response will have a data field at its top level, which will contain complete information on the new lot, including its ID.
If something went wrong during the request, we’ll get a different status code and the JSON returned will have an errors field at the top level containing a list of problems. We look at the first one and print out its message.
Project status¶
The project has pre alpha status.
The source repository for this project is on GitHub: https://github.com/openprocurement/openregistry.lots.loki
API stability¶
API is relatively stable. The changes in the API are communicated via Open Procurement API maillist.
Data Standard¶
Data standard is modelled along the Open Contracting Standard with extensions in areas that were not covered by it.
Lot¶
Schema¶
id: | uuid, auto-generated, read-only Internal identifier for this lot. |
---|---|
lotID: | string, auto-generated, read-only The lot identifier to refer that lot to in the paper documentation. OpenContracting Description: LotID is included to make the flattened data structure more convenient. |
owner: | string, auto-generated, read-only The entity whom the lot is owned by. |
date: | string, auto-generated, read-only The date of lot creation/undoing. |
title: | string, multilingual, required
Oprionally can be mentioned in English/Russian. Initial data originates from asset.title. |
description: | string, multilingual, required OpenContracting Description: A description of the goods, services to be provided.
Initial data originates from asset.description. |
dateModified: | string, auto-generated, read-only OpenContracting Description: Date when the lot was last modified. |
status: | string, required The lot status within the Registry. |
Status | Description | ||||
---|---|---|---|---|---|
|
Lot created but not yet available | ||||
|
Attachment of the asset to the lot | ||||
|
Asset availability check | ||||
|
Editing the lot | ||||
|
If the lot is incorrectly created | ||||
|
Expecting the start of the auction | ||||
|
Separating the asset | ||||
|
Delete a lot | ||||
|
Holding an auction by lot | ||||
|
Contracting process | ||||
|
Separating the asset. Lot sold | ||||
|
Lot sold | ||||
|
Separating the asset | ||||
|
Dissolution lot |
relatedProcesses: | |
---|---|
Array of Related Processes Block containing information about the relation to objects beyond the lot. |
|
decisions: | Array of Decisions, required Also include the data from asset.decisions. |
lotCustodian: | Organization, required An entity managing the lot. Initial data originates from asset.assetCustodian. |
items: | Array of Item, required Initial data originates from asset.items. |
lotHolder: | Organization, required Initial data originates from asset.assetHolder. |
rectificationPeriod: | |
Period, auto-generated, read-only Period during which the lot’s owner can edit it. |
|
auctions: | Array of Auction, required Auction conditions due to which the lot is to be sold. |
documents: | Array of Documents objects OpenContracting Description: All documents and attachments related to the lot. |
mode: | string, optional The additional parameter with a value test. |
sandboxParameters: | |
string, optional Parameter that accelerates lot periods. Set quick, accelerator=1440 as text value for sandboxParameters for the time frames to be reduced in 1440 times. |
|
lotType: | string, auto-generated, read-only Type of the given lot. Given value:
|
Period¶
Value¶
Schema¶
amount: | float, required Should be positive. |
---|---|
currency: | string, required OpenContracting Description: The currency in 3-letter ISO 4217 format. |
valueAddedTaxIncluded: | |
bool, required Possible values are true or false. |
Decisions¶
Schema¶
title: | string, multilingual, optional
|
---|---|
decisionDate: | Date, required OpenContracting Description: The date on which the document was first published. |
decisionID: | string, required The decision identifier to refer to in the paper documentation. |
decisionOf: | string, required Possible values are:
|
relatedItem: | string, auto-generated Internal id of related asset. |
Сontracts¶
Schema¶
type: | string, auto-generated, read-only Type of the contract. The only value is yoke. |
---|---|
id: | uuid, auto-generated, read-only Internal identifier of the object within the Module of Contracting. Added as long as the contract is being created within the Module of Contracting. |
status: | string, auto-generated, read-only Status of contract within the Module of Contracting. Added as long as the contract is being created within the Module of Contracting. |
Auction¶
Schema¶
id: | string, auto-generated, read-only |
---|---|
auctionID: | string, auto-generated, read-only The auction identifier to refer auction to in “paper” documentation. OpenContracting Description: It is included to make the flattened data structure more convenient. |
procurementMethodType: | |
string, auto-generated, read-only Type that defines what type of the procedure is going to be used. Possible values:
|
|
procurementMethodDetails: | |
string, optional Parameter that accelerates auction periods. Set quick, accelerator=1440 as text value for procurementMethodDetails for the time frames to be reduced in 1440 times. |
|
submissionMethodDetails: | |
string, optional Parameter that works only with mode = “test” and speeds up auction start date. Possible value is quick. |
|
sandboxParameters: | |
string, optional Parameter that accelerates lot periods. Set quick, accelerator=1440 as text value for sandboxParameters for the time frames to be reduced in 1440 times. |
|
auctionPeriod: | Period, required Period when the first auction is conducted. Here only startDate has be provided. |
tenderingDuration: | |
Duration, required Duration of tenderPeriod for 2nd and 3rd procedures within the privatization cycle. |
|
documents: | Array of Documents objects, optional OpenContracting Description: All documents and attachments related to the auction. |
value: | Value, required Total available budget of the 1st auction. Bids lower than Auction.value for 2nd and 3rd auctions within the privatization cycle will be calculated as half of the auction.value provided. OpenContracting Description: The total estimated value of the procurement. |
guarantee: | Guarantee, required Bid guarantee. Lots.auctions.guarantee for 2nd and 3rd auctions within the privatization cycle will be calculated auctomatically. |
minimalStep: | Value, required The minimal step of the 1st auction. Lots.auctions.minimalStep for 2nd and 3rd auctions within the privatization cycle will be calculated auctomatically. |
auctionParameters: | |
Auction Parameters, optional Parameters for the auction to be held. Ogranizator can optionally set value for the 3rd auction within the lots.auctions structure. |
|
bankAccount: | Bank Account, required Details which uniquely identify a bank account, and are used when making or receiving a payment. |
tenderAttempts: | integer, auto-generated, read-only The number which represents what time (from 1 up to 3) procedure with a current lot takes place. |
status: | string, required Auction status within which the lot is being sold: |
Status | Description |
---|---|
scheduled | The process is planned, but is not yet taking place. Details of the anticipated dates may be provided further |
active | The process is currently taking place |
complete | The process is complete; |
cancelled | The process has been cancelled; |
unsuccessful | The process has been unsuccessful. |
contracts: | Array of Сontracts, auto-generated, read-only Information of the related contract. |
---|---|
relatedProcessID: | |
uuid, required Internal id of the auction. |
Auction Parameters¶
Schema¶
type: | string, auto-generated, read-only Type of the auction. |
---|---|
dutchSteps: | integer, required for the third auction Number of steps within the dutch part of the insider auction. Possible values are [1; 100]. Defaul value is 99. |
Value¶
Schema¶
amount: | float, required Should be positive. OpenContracting Description: Amount as a number. |
---|---|
currency: | string, required OpenContracting Description: The currency in 3-letter ISO 4217 format. |
valueAddedTaxIncluded: | |
bool, required Possible values are true or false. |
Guarantee¶
Schema¶
amount: | float, required Should be positive. OpenContracting Description: Amount as a number. |
---|---|
currency: | string, required OpenContracting Description: The currency in 3-letter ISO 4217 format. |
Bank Account¶
Schema¶
description: | string, multilingual, optional Additional information that has to be noted from the Organizator’s point. |
---|---|
bankName: | string, required Name of the bank. |
accountIdentification: | |
Array of Classification, required Major data on the account details of the state entity selling a lot, to facilitate payments at the end of the process. Most frequently used are:
|
Сontracts¶
Schema¶
type: | string, required, auto-generated, read-only Type of the contract. The only value is yoke. |
---|---|
contractID: | string, required, auto-generated, read-only The contract identifier to refer to in “paper” documentation. Added as long as the contract is being created within the Module of Contracting. |
relatedProcessID: | |
uuid, required, auto-generated, read-only Internal identifier of the object within the Module of Contracting. Added as long as the contract is being created within the Module of Contracting. |
Organization¶
Schema¶
name: | string, multilingual, required Name of the organization. |
---|---|
identifier: | Identifier, required The primary identifier for this organization. |
additionalIdentifiers: | |
List of Identifier, optional |
|
address: | Address, required for lotCustodian |
contactPoint: | ContactPoint, required for lotCustodian |
additionalContactPoints: | |
Array of ContactPoint, optional |
|
kind: | string, optional Type of the organizer. Available only for lotCustodian.
|
Identifier¶
Schema¶
scheme: | string, required OpenContracting Description: Organization identifiers be drawn from an existing identification scheme. This field is used to indicate the scheme or codelist in which the identifier will be found. This value should be drawn from the Organization Identifier Scheme. |
---|---|
id: | string, required OpenContracting Description: The identifier of the organization in the selected scheme. The allowed codes are the ones found in “Organisation Registration Agency” codelist of IATI Standard with addition of UA-EDR code for organizations registered in Ukraine (EDRPOU and IPN). |
legalName: | string, multilingual, optional OpenContracting Description: The legally registered name of the organization. Full legal name (e.g. Nadra Bank). |
uri: | uri, optional OpenContracting Description: A URI to identify the organization, such as those provided by Open Corporates or some other relevant URI provider. This is not for listing the website of the organization: that can be done through the url field of the Organization contact point. |
Address¶
Schema¶
streetAddress: | string, optional OpenContracting Description: The street address. For example, 1600 Amphitheatre Pkwy. |
---|---|
locality: | string, optional OpenContracting Description: The locality. For example, Mountain View. |
region: | string, optional OpenContracting Description: The region. For example, CA. |
postalCode: | string, optional OpenContracting Description: The postal code. For example, 94043. |
countryName: | string, multilingual, required OpenContracting Description: The country name. For example, United States. |
ContactPoint¶
Schema¶
name: | string, multilingual, required OpenContracting Description: The name of the contact person, department, or contact point, for correspondence relating to this contracting process. |
---|---|
email: | OpenContracting Description: The e-mail address of the contact point/person. |
telephone: | string OpenContracting Description: The telephone number of the contact point/person. This should include the international dialling code. |
faxNumber: | string, optional OpenContracting Description: The fax number of the contact point/person. This should include the international dialling code. |
url: | URL, optional OpenContracting Description: A web address for the contact point/person. |
Either email or telephone field has to be provided.
Item¶
Schema¶
id: | uuid, auto-generated, read-only Internal identifier for this item. |
||||||
---|---|---|---|---|---|---|---|
description: | string, multilingual, required OpenContracting Description: A description of the goods, services to be provided. Auction subject / asset description. |
||||||
classification: | Classification, required OpenContracting Description: The primary classification for the item. See the itemClassificationScheme to identify preferred classification lists, including CAV and GSIN. It is required for classification.scheme to be CPV or CAV-PS. The classification.id should be valid CPV or CAV-PS code. The CPV & CAV-PS codes accuracy should be equal to the class (XXXX0000-Y) at least. |
||||||
additionalClassifications: | |||||||
Array of Classification, optional OpenContracting Description: An array of additional classifications for the item. See the itemClassificationScheme codelist for common options to use in OCDS. This may also be used to present codes from an internal classification scheme. E.g.`CPVS`, DK018, cadastralNumber & UA-EDR can be chosen from the list. The codes are to be noted manually for cadastralNumber & UA-EDR. |
|||||||
unit: | Unit, required OpenContracting Description: Description of the unit which the good comes in e.g. hours, kilograms. Made up of a unit name, and the value of a single unit. |
||||||
quantity: | decimal, required OpenContracting Description: The number of units required. |
||||||
address: | Address, required Address, where the item is located. |
||||||
location: | dictionary, optional Geographical coordinates of the location. Element consists of the following items:
location usually takes precedence over address if both are present. |
||||||
registrationDetails: | |||||||
Registration Details, required |
Registration Details¶
Schema¶
status: | string, required Possible values are:
|
||||||
---|---|---|---|---|---|---|---|
registrationID: | string, optional The document identifier to refer to in the paper documentation. Available for mentioning in status: complete. |
||||||
registrationDate: | |||||||
Date, optional OpenContracting Description: The date on which the document was first published. Available for mentioning in status: complete. |
Classification¶
Schema¶
scheme: | string, required OpenContracting Description: A classification should be drawn from an existing scheme or list of codes. This field is used to indicate the scheme/codelist from which the classification is drawn. For line item classifications, this value should represent a known Item Classification Scheme wherever possible. |
---|---|
id: | string, required OpenContracting Description: The classification code drawn from the selected scheme. |
description: | string, required OpenContracting Description: A textual description or title for the code. |
uri: | uri, optional OpenContracting Description: A URI to identify the code. In the event individual URIs are not available for items in the identifier scheme this value should be left blank. |
Unit¶
Schema¶
code: | string, required UN/CEFACT Recommendation 20 unit code. |
---|---|
name: | string, optional OpenContracting Description: Name of the unit |
Lot Holder¶
Schema¶
name: | string, multilingual, required Name of the entity. |
---|---|
identifier: | Identifier, required The primary identifier for this entity. |
additionalIdentifiers: | |
Array of Identifier objects |
|
address: | Address, optional |
contactPoint: | ContactPoint, optional |
additionalContactPoints: | |
Array of ContactPoint, optional |
Documents¶
Schema¶
id: | string, auto-generated, read-only Internal identifier of the object within an array. |
---|---|
documentType: | string, required Type of the document. Possible values are:
The formal notice that gives details. This may be a link to a downloadable document, to a web page, or to an official gazette in which the notice is contained.
Detailed technical information about goods or services to be provided.
Presentation about the lot to be sold.
Auto-generated type of document that will be attached to each of the lot automatically.
Reasons why the lot has to be deleted. Note: The following are specific for Auction only:
Information about how bids will be evaluated.
Information about the auction. It is a link to the Public Asset Certificate.
Place and application forms for participation in the auction as well as bank details for transferring guarantee deposits.
Information on bidders or participants, their validation documents and any procedural exemptions for which they qualify.
A non-disclosure agreement between a participant and a bank.
Goods examination procedure rules / Asset familiarization procedure in data room. Contains information on where and when a given document can be examined offline. |
title: | string, multilingual, required OpenContracting Description: The document title. |
description: | string, multilingual, optional OpenContracting Description: A short description of the document. In the event the document is not accessible online, the description field can be used to describe arrangements for obtaining a copy of the document. |
format: | string, optional OpenContracting Description: The format of the document taken from the IANA Media Types code list, with the addition of one extra value for ‘offline/print’, used when this document entry is being used to describe the offline publication of a document. |
url: | string, auto-generated, read-only OpenContracting Description: Direct link to the document or attachment. |
datePublished: | Date, auto-generated, read-only OpenContracting Description: The date on which the document was first published. |
dateModified: | Date, auto-generated, read-only OpenContracting Description: Date that the document was last modified |
language: | string, optional OpenContracting Description: Specifies the language of the linked document using either two-digit ISO 639-1, or extended BCP47 language tags. |
documentOf: | string, required Possible values are:
|
relatedItem: | string, optional |
index: | integer, optional OpenContracting Description: Sorting (display order) parameter used for illustrations. The smaller number is, the higher illustration is in the sorting. If index is not specified, illustration will be displayed the last. If two illustrations have the same index, they will be sorted depending on their publishing date. |
accessDetails: | string, optional Required for x_dgfAssetFamiliarization document. |
Tutorial¶
Exploring basic rules¶
Let’s try exploring the /lots endpoint:
GET /api/2.5/lots?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"next_page": {
"path": "/api/2.5/lots?offset=",
"uri": "http://lb.api-sandbox.registry.ea.openprocurement.net/api/2.5/lots?offset=",
"offset": ""
},
"data": []
}
Just invoking it reveals empty set.
Now let’s attempt creating a lot:
POST /api/2.5/lots?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 4
Content-Type: application/x-www-form-urlencoded
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 415 Unsupported Media Type
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"status": "error",
"errors": [
{
"description": "Content-Type header should be one of ['application/json']",
"location": "header",
"name": "Content-Type"
}
]
}
Error states that the only accepted Content-Type is application/json.
Let’s satisfy the Content-type requirement:
POST /api/2.5/lots?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 4
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 422 Unprocessable Entity
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"status": "error",
"errors": [
{
"description": "Expecting value: line 1 column 1 (char 0)",
"location": "body",
"name": "data"
}
]
}
Error states that no data has been found in JSON body.
Creating lot¶
You can create lot with relatedProcesses at once. It`s called a batch mode.
POST /api/2.5/lots?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 415
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
DATA:
{
"data": {
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID"
}
],
"lotType": "loki",
"relatedProcesses": [
{
"type": "asset",
"relatedProcessID": "72540e20491643c2a51141f419324344"
}
],
"description": "Щось там тестове",
"title": "Тестовий лот"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://lb.api-sandbox.registry.ea.openprocurement.net/api/2.5/lots/75d059c9f53e4454b9b4f592b30ff566
X-Content-Type-Options: nosniff
{
"access": {
"transfer": "003c8dea9ada4b869786f7bd09d81387",
"token": "95d8faca662844a48591e490390ef831"
},
"data": {
"status": "draft",
"lotID": "UA-LR-DGF-2019-03-19-000001",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "f09354784c6848aaaffbd6ff38c87ef8"
}
],
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID",
"id": "8a3dde028de144789c7f928df0cc32d2",
"decisionOf": "lot"
}
],
"lotType": "loki",
"dateModified": "2019-03-19T15:23:06.291288+02:00",
"owner": "broker",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:06.281066+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:06.281086+02:00",
"id": "f71092daf0f841d0a683a123e2456e21"
}
],
"auctions": [
{
"status": "scheduled",
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "a3aabb7301d64fef85a118762a7e7a26"
},
{
"status": "scheduled",
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "ebd89717fe8c4856b2d4f322326b53af"
},
{
"status": "scheduled",
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "ed2964cad53246e6a5ffeb3609015607"
}
],
"date": "2019-03-19T15:23:06.289301+02:00",
"relatedProcesses": [
{
"type": "asset",
"id": "2a94e1ee21fd45ef9188529643c9ca23",
"relatedProcessID": "72540e20491643c2a51141f419324344"
}
],
"id": "75d059c9f53e4454b9b4f592b30ff566"
}
}
Let’s create lot with the minimal data set:
POST /api/2.5/lots?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 318
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
DATA:
{
"data": {
"lotType": "loki",
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID"
}
],
"description": "Щось там тестове",
"title": "Тестовий лот"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://lb.api-sandbox.registry.ea.openprocurement.net/api/2.5/lots/9c54261550f74c99b25b7a8ab16aa97a
X-Content-Type-Options: nosniff
{
"access": {
"transfer": "3ee8b7f4bb8647c684cf8a318332650c",
"token": "53ce42a01cb745819303b64031afbb2b"
},
"data": {
"status": "draft",
"lotID": "UA-LR-DGF-2019-03-19-000002",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "eb92ac079d3945c9ae2d6a8c31877c3f"
}
],
"lotType": "loki",
"dateModified": "2019-03-19T15:23:06.324966+02:00",
"owner": "broker",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:06.314674+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:06.314696+02:00",
"id": "b5506c8a9353481f8e6fcc964242ea79"
}
],
"auctions": [
{
"status": "scheduled",
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "cb14fea47f324446b083099e026b1de4"
},
{
"status": "scheduled",
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "5bbdebcd2d9748aa89220f01f17a18f3"
},
{
"status": "scheduled",
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "b2998f0368c340609fa56fa0a12fdcfa"
}
],
"date": "2019-03-19T15:23:06.323072+02:00",
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID",
"id": "88efebe2abf542319f0a79b3645f5d9e",
"decisionOf": "lot"
}
],
"id": "9c54261550f74c99b25b7a8ab16aa97a"
}
}
The object you’re trying to add initially receives draft status. You should manually switch this object from draft to composing (2 Phase Commit mechanism) so that to add the auction conditions (value.amount, minimalStep.amount, etc.):
PATCH /api/2.5/lots/9c54261550f74c99b25b7a8ab16aa97a?acc_token=53ce42a01cb745819303b64031afbb2b HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 33
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
DATA:
{
"data": {
"status": "composing"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "composing",
"lotID": "UA-LR-DGF-2019-03-19-000002",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "eb92ac079d3945c9ae2d6a8c31877c3f"
}
],
"lotType": "loki",
"dateModified": "2019-03-19T15:23:06.393441+02:00",
"owner": "broker",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:06.314674+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:06.314696+02:00",
"id": "b5506c8a9353481f8e6fcc964242ea79"
}
],
"auctions": [
{
"status": "scheduled",
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "cb14fea47f324446b083099e026b1de4"
},
{
"status": "scheduled",
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "5bbdebcd2d9748aa89220f01f17a18f3"
},
{
"status": "scheduled",
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "b2998f0368c340609fa56fa0a12fdcfa"
}
],
"date": "2019-03-19T15:23:06.393270+02:00",
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID",
"id": "88efebe2abf542319f0a79b3645f5d9e",
"decisionOf": "lot"
}
],
"id": "9c54261550f74c99b25b7a8ab16aa97a"
}
}
You see that lot.auctions structure has been added with the set of auto-generated data.
Now let’s add extra auction conditions. Note that the information is being added to each of three auctions one by one:
PATCH /api/2.5/lots/9c54261550f74c99b25b7a8ab16aa97a/auctions/cb14fea47f324446b083099e026b1de4 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 449
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
X-Access-Token: 53ce42a01cb745819303b64031afbb2b
DATA:
{
"data": {
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"guarantee": {
"currency": "UAH",
"amount": 700.87
},
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
}
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "cb14fea47f324446b083099e026b1de4",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
}
}
PATCH /api/2.5/lots/9c54261550f74c99b25b7a8ab16aa97a/auctions/5bbdebcd2d9748aa89220f01f17a18f3 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 43
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
X-Access-Token: 53ce42a01cb745819303b64031afbb2b
DATA:
{
"data": {
"tenderingDuration": "P25DT12H"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "5bbdebcd2d9748aa89220f01f17a18f3",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
}
Now let’s add relatedProcesses:
POST /api/2.5/lots/9c54261550f74c99b25b7a8ab16aa97a/related_processes HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 83
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
X-Access-Token: 53ce42a01cb745819303b64031afbb2b
DATA:
{
"data": {
"type": "asset",
"relatedProcessID": "9f99bebd24b54939ae1cbe4a81c1afa4"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://lb.api-sandbox.registry.ea.openprocurement.net/api/2.5/lots/9c54261550f74c99b25b7a8ab16aa97a/related_processes/1c1943ff7c4d42ee983ec84afd486313
X-Content-Type-Options: nosniff
{
"data": {
"type": "asset",
"id": "1c1943ff7c4d42ee983ec84afd486313",
"relatedProcessID": "9f99bebd24b54939ae1cbe4a81c1afa4"
}
}
To enable further manipulations with the lot, its status should be manually switched to verification.
PATCH /api/2.5/lots/9c54261550f74c99b25b7a8ab16aa97a?acc_token=53ce42a01cb745819303b64031afbb2b HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 36
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
DATA:
{
"data": {
"status": "verification"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "verification",
"lotID": "UA-LR-DGF-2019-03-19-000002",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "eb92ac079d3945c9ae2d6a8c31877c3f"
}
],
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID",
"id": "88efebe2abf542319f0a79b3645f5d9e",
"decisionOf": "lot"
}
],
"lotType": "loki",
"dateModified": "2019-03-19T15:23:06.588340+02:00",
"owner": "broker",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:06.314674+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:06.314696+02:00",
"id": "b5506c8a9353481f8e6fcc964242ea79"
}
],
"auctions": [
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "cb14fea47f324446b083099e026b1de4",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "5bbdebcd2d9748aa89220f01f17a18f3",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "b2998f0368c340609fa56fa0a12fdcfa",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:06.588172+02:00",
"relatedProcesses": [
{
"type": "asset",
"id": "1c1943ff7c4d42ee983ec84afd486313",
"relatedProcessID": "9f99bebd24b54939ae1cbe4a81c1afa4"
}
],
"id": "9c54261550f74c99b25b7a8ab16aa97a"
}
}
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 asset: its internal id (that matches the Location segment), its official assetID and dateModified datestamp stating the moment when asset was last modified. Note that lot is created with pending status.
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 lot.
POST /api/2.5/lots?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 318
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
DATA:
{
"data": {
"lotType": "loki",
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID"
}
],
"description": "Щось там тестове",
"title": "Тестовий лот"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://lb.api-sandbox.registry.ea.openprocurement.net/api/2.5/lots/9c54261550f74c99b25b7a8ab16aa97a
X-Content-Type-Options: nosniff
{
"access": {
"transfer": "3ee8b7f4bb8647c684cf8a318332650c",
"token": "53ce42a01cb745819303b64031afbb2b"
},
"data": {
"status": "draft",
"lotID": "UA-LR-DGF-2019-03-19-000002",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "eb92ac079d3945c9ae2d6a8c31877c3f"
}
],
"lotType": "loki",
"dateModified": "2019-03-19T15:23:06.324966+02:00",
"owner": "broker",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:06.314674+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:06.314696+02:00",
"id": "b5506c8a9353481f8e6fcc964242ea79"
}
],
"auctions": [
{
"status": "scheduled",
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "cb14fea47f324446b083099e026b1de4"
},
{
"status": "scheduled",
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "5bbdebcd2d9748aa89220f01f17a18f3"
},
{
"status": "scheduled",
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "b2998f0368c340609fa56fa0a12fdcfa"
}
],
"date": "2019-03-19T15:23:06.323072+02:00",
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID",
"id": "88efebe2abf542319f0a79b3645f5d9e",
"decisionOf": "lot"
}
],
"id": "9c54261550f74c99b25b7a8ab16aa97a"
}
}
Let’s see what listing of lots reveals us:
GET /api/2.5/lots?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"next_page": {
"path": "/api/2.5/lots?offset=",
"uri": "http://lb.api-sandbox.registry.ea.openprocurement.net/api/2.5/lots?offset=",
"offset": ""
},
"data": []
}
We do see the internal id of the lot (that can be used to construct full URL http://lb.api-sandbox.registry.ea2.openprocurement.net/api/2.4/lots/8286cc7863814271afe23cb2646237ed`) and its dateModified date stamp.
Let’s try creating another lot:
POST /api/2.5/lots?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 318
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
DATA:
{
"data": {
"lotType": "loki",
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID"
}
],
"description": "Щось там тестове",
"title": "Тестовий лот"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://lb.api-sandbox.registry.ea.openprocurement.net/api/2.5/lots/2f6e750402f841beb513d413240b60a0
X-Content-Type-Options: nosniff
{
"access": {
"transfer": "c78f6adea1ec45e6951ac1e2891b11fb",
"token": "be16a40e2003457aaac2d58b80cbc527"
},
"data": {
"status": "draft",
"lotID": "UA-LR-DGF-2019-03-19-000003",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "ebe5f45c1bcd40179b96db1f03754c29"
}
],
"lotType": "loki",
"dateModified": "2019-03-19T15:23:06.649265+02:00",
"owner": "broker",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:06.639379+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:06.639405+02:00",
"id": "b6e7ae98101d4a50a6f32ced0c1cf4df"
}
],
"auctions": [
{
"status": "scheduled",
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "50b55e1ba3c34779b26a22527292eb52"
},
{
"status": "scheduled",
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "1f49c1f5f38848cb807c52e191c0cde4"
},
{
"status": "scheduled",
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "c95266b3c5e64a8fa40049302b5bd499"
}
],
"date": "2019-03-19T15:23:06.647458+02:00",
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID",
"id": "ec2d6fb65a9241baab975993c550f7dd",
"decisionOf": "lot"
}
],
"id": "2f6e750402f841beb513d413240b60a0"
}
}
And again we have 201 Created response code, Location header and body with extra id, lotID, and dateModified properties.
Switch second lot to ‘composing’ status’:
PATCH /api/2.5/lots/2f6e750402f841beb513d413240b60a0?acc_token=be16a40e2003457aaac2d58b80cbc527 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 33
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
DATA:
{
"data": {
"status": "composing"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "composing",
"lotID": "UA-LR-DGF-2019-03-19-000003",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "ebe5f45c1bcd40179b96db1f03754c29"
}
],
"lotType": "loki",
"dateModified": "2019-03-19T15:23:06.701774+02:00",
"owner": "broker",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:06.639379+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:06.639405+02:00",
"id": "b6e7ae98101d4a50a6f32ced0c1cf4df"
}
],
"auctions": [
{
"status": "scheduled",
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "50b55e1ba3c34779b26a22527292eb52"
},
{
"status": "scheduled",
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "1f49c1f5f38848cb807c52e191c0cde4"
},
{
"status": "scheduled",
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "c95266b3c5e64a8fa40049302b5bd499"
}
],
"date": "2019-03-19T15:23:06.701582+02:00",
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID",
"id": "ec2d6fb65a9241baab975993c550f7dd",
"decisionOf": "lot"
}
],
"id": "2f6e750402f841beb513d413240b60a0"
}
}
Let’s check what lot registry contains:
GET /api/2.5/lots?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"next_page": {
"path": "/api/2.5/lots?offset=2019-03-19T15%3A23%3A06.588340%2B02%3A00",
"uri": "http://lb.api-sandbox.registry.ea.openprocurement.net/api/2.5/lots?offset=2019-03-19T15%3A23%3A06.588340%2B02%3A00",
"offset": "2019-03-19T15:23:06.588340+02:00"
},
"data": [
{
"id": "9c54261550f74c99b25b7a8ab16aa97a",
"dateModified": "2019-03-19T15:23:06.588340+02:00"
}
]
}
And indeed we have 2 lots now.
Modifying Lot¶
Let’s update lot description:
PATCH /api/2.5/lots/2f6e750402f841beb513d413240b60a0?acc_token=be16a40e2003457aaac2d58b80cbc527 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 53
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
DATA:
{
"data": {
"description": "Lot description modified"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "composing",
"lotID": "UA-LR-DGF-2019-03-19-000003",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "ebe5f45c1bcd40179b96db1f03754c29"
}
],
"lotType": "loki",
"dateModified": "2019-03-19T15:23:06.701774+02:00",
"owner": "broker",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:06.639379+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:06.639405+02:00",
"id": "b6e7ae98101d4a50a6f32ced0c1cf4df"
}
],
"auctions": [
{
"status": "scheduled",
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "50b55e1ba3c34779b26a22527292eb52"
},
{
"status": "scheduled",
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"auctionParameters": {
"type": "english"
},
"id": "1f49c1f5f38848cb807c52e191c0cde4"
},
{
"status": "scheduled",
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "c95266b3c5e64a8fa40049302b5bd499"
}
],
"date": "2019-03-19T15:23:06.701582+02:00",
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID",
"id": "ec2d6fb65a9241baab975993c550f7dd",
"decisionOf": "lot"
}
],
"id": "2f6e750402f841beb513d413240b60a0"
}
}
We see the added properties have merged with existing lot data. Additionally, the dateModified property was updated to reflect the last modification date stamp.
Note that lot can be modified only within the rectification period (up to rectificationPeriod.endDate).
Checking the listing again reflects the new modification date:
GET /api/2.5/lots?opt_pretty=1 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"next_page": {
"path": "/api/2.5/lots?offset=2019-03-19T15%3A23%3A06.701774%2B02%3A00",
"uri": "http://lb.api-sandbox.registry.ea.openprocurement.net/api/2.5/lots?offset=2019-03-19T15%3A23%3A06.701774%2B02%3A00",
"offset": "2019-03-19T15:23:06.701774+02:00"
},
"data": [
{
"id": "9c54261550f74c99b25b7a8ab16aa97a",
"dateModified": "2019-03-19T15:23:06.588340+02:00"
},
{
"id": "2f6e750402f841beb513d413240b60a0",
"dateModified": "2019-03-19T15:23:06.701774+02:00"
}
]
}
Deleting Lot¶
Let’s delete lot:
A document with the documentType: canellationDetails has to be added first:
POST /api/2.5/lots/9c54261550f74c99b25b7a8ab16aa97a/documents HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 348
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
X-Access-Token: 53ce42a01cb745819303b64031afbb2b
DATA:
{
"data": {
"url": "http://localhost/get/bc55defdab034421af27f4d9c439a16e?KeyID=172d32c8&Signature=VR7N0kPTzDi3PRIImIg1agVop7Layrc47TX2GzzCWTUJhA6rqhg8ta4CpoO0%2FjKcq1RVFsfsG3bngh9CxLZjDA%3D%3D",
"title": "укр.doc",
"format": "application/msword",
"hash": "md5:00000000000000000000000000000000",
"documentType": "cancellationDetails"
}
}
Response: 201 Created
Content-Type: application/json
Location: http://lb.api-sandbox.registry.ea.openprocurement.net/api/2.5/lots/9c54261550f74c99b25b7a8ab16aa97a/documents/b1d4e5b4377349a79aa8e282927a66b5
X-Content-Type-Options: nosniff
{
"data": {
"hash": "md5:00000000000000000000000000000000",
"author": "lot_owner",
"title": "укр.doc",
"url": "http://localhost/get/bc55defdab034421af27f4d9c439a16e?KeyID=172d32c8&Signature=BZJ%2FgnWnyfxmrtm6WSZ8fEmExwbvCpoOgAFOdePF9jd5%252BAakEI%252BoNz%252BHzgbLbMvAiXhcKfcGxHziCeuOLNt%252BDw%253D%253D",
"format": "application/msword",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:07.118610+02:00",
"documentType": "cancellationDetails",
"dateModified": "2019-03-19T15:23:07.118652+02:00",
"id": "b1d4e5b4377349a79aa8e282927a66b5"
}
}
So now lot can be easily deleted:
PATCH /api/2.5/lots/9c54261550f74c99b25b7a8ab16aa97a?acc_token=53ce42a01cb745819303b64031afbb2b HTTP/1.0
Authorization: Basic YnJva2VyOg==
Content-Length: 39
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
DATA:
{
"data": {
"status": "pending.deleted"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "pending.deleted",
"rectificationPeriod": {
"startDate": "2019-03-19T15:23:07.016906+02:00",
"endDate": "2019-03-21T15:23:07.016906+02:00"
},
"lotID": "UA-LR-DGF-2019-03-19-000002",
"description": "Нежитлове приміщення для збереження насіння",
"title": "Нежитлове приміщення",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "eb92ac079d3945c9ae2d6a8c31877c3f"
}
],
"items": [
{
"registrationDetails": {
"status": "unknown"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Description",
"id": "73110000-6"
},
"additionalClassifications": [
{
"scheme": "UA-EDR",
"description": "папір і картон гофровані, паперова й картонна тара",
"id": "111111-4"
}
],
"address": {
"countryName": "Ukraine"
},
"id": "0",
"unit": {
"code": "code"
},
"quantity": 5.0001
}
],
"lotType": "loki",
"lotHolder": {
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Власник лоту"
},
"decisions": [
{
"decisionDate": "2019-03-19T15:23:06.251270+02:00",
"decisionID": "initialDecisionID",
"id": "88efebe2abf542319f0a79b3645f5d9e",
"decisionOf": "lot"
},
{
"relatedItem": "dfb2e73b899b42a389af463caf930d67",
"decisionDate": "2019-03-19T15:23:06.778542+02:00",
"decisionID": "11111-4-5",
"id": "2abb8347a22b4ac2bfea4d8defccf5b6",
"decisionOf": "asset"
}
],
"dateModified": "2019-03-19T15:23:07.240534+02:00",
"owner": "broker",
"lotCustodian": {
"contactPoint": {
"name": "Сергій",
"email": "segiy@mail.com"
},
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Зберігач лоту",
"address": {
"countryName": "Україна"
}
},
"auctions": [
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "cb14fea47f324446b083099e026b1de4",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "5bbdebcd2d9748aa89220f01f17a18f3",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "b2998f0368c340609fa56fa0a12fdcfa",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:07.240327+02:00",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:06.314674+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:06.314696+02:00",
"id": "b5506c8a9353481f8e6fcc964242ea79"
},
{
"hash": "md5:00000000000000000000000000000000",
"author": "lot_owner",
"title": "укр.doc",
"url": "http://localhost/get/bc55defdab034421af27f4d9c439a16e?KeyID=172d32c8&Signature=BZJ%2FgnWnyfxmrtm6WSZ8fEmExwbvCpoOgAFOdePF9jd5%252BAakEI%252BoNz%252BHzgbLbMvAiXhcKfcGxHziCeuOLNt%252BDw%253D%253D",
"format": "application/msword",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:07.118610+02:00",
"documentType": "cancellationDetails",
"dateModified": "2019-03-19T15:23:07.118652+02:00",
"id": "b1d4e5b4377349a79aa8e282927a66b5"
}
],
"relatedProcesses": [
{
"identifier": "UA-AR-P-2018-08-17-000002-1",
"type": "asset",
"id": "1c1943ff7c4d42ee983ec84afd486313",
"relatedProcessID": "9f99bebd24b54939ae1cbe4a81c1afa4"
}
],
"id": "9c54261550f74c99b25b7a8ab16aa97a"
}
}
Integration with assets¶
Concierge operations¶
For lot to be formed, you need to specify id of the asset which is to be included in that lot. If this assets is available, it will be attached to lot and status of a lot itself will be changed to pending. The given lot becomes:
GET /api/2.5/lots/9a2c80c59e5b425795e92e80f7ad1e24 HTTP/1.0
Authorization: Basic Y29uY2llcmdlOg==
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "pending",
"rectificationPeriod": {
"startDate": "2019-03-19T15:23:08.321095+02:00",
"endDate": "2019-03-21T15:23:08.321095+02:00"
},
"lotID": "UA-LR-DGF-2019-03-19-000002",
"description": "Нежитлове приміщення для збереження насіння",
"title": "Нежитлове приміщення",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "37a7d847bcc14d60b57b1e7fb8b750cb"
}
],
"items": [
{
"registrationDetails": {
"status": "unknown"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Description",
"id": "73110000-6"
},
"additionalClassifications": [
{
"scheme": "UA-EDR",
"description": "папір і картон гофровані, паперова й картонна тара",
"id": "111111-4"
}
],
"address": {
"countryName": "Ukraine"
},
"id": "0",
"unit": {
"code": "code"
},
"quantity": 5.0001
}
],
"lotType": "loki",
"lotHolder": {
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Власник лоту"
},
"decisions": [
{
"decisionDate": "2019-03-19T15:23:07.792309+02:00",
"decisionID": "initialDecisionID",
"id": "65575976294e4c1988c42127a320ff35",
"decisionOf": "lot"
},
{
"relatedItem": "f54fde9c6c8146cc8bc1520c6429aacf",
"decisionDate": "2019-03-19T15:23:08.111917+02:00",
"decisionID": "11111-4-5",
"id": "b40e68f7f5214475acf850840f18f502",
"decisionOf": "asset"
}
],
"dateModified": "2019-03-19T15:23:08.341359+02:00",
"owner": "broker",
"lotCustodian": {
"contactPoint": {
"name": "Сергій",
"email": "segiy@mail.com"
},
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Зберігач лоту",
"address": {
"countryName": "Україна"
}
},
"next_check": "2019-03-21T15:23:08.321095+02:00",
"auctions": [
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "9d4ba7a1ceff4accafa24f39cd90592f",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "a4a8871e8960495d903da34e90bf39b6",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "fe12a7f7b2bd419ca413e358c56df4b9",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:08.340830+02:00",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:07.798300+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:07.798339+02:00",
"id": "38bbdb5c200043fe98b3cf7d10a98a8e"
}
],
"relatedProcesses": [
{
"identifier": "UA-AR-P-2018-08-17-000002-1",
"type": "asset",
"id": "1ba3d1b7fdf744899b26b938faea79b4",
"relatedProcessID": "f0fc1f1d4fd24bce9370f5f3fd9e16a5"
}
],
"id": "9a2c80c59e5b425795e92e80f7ad1e24"
}
}
In case of this assets is unavailable, status of the current lot will turn to invalid The given lot becomes:
GET /api/2.5/lots/c388bd047cb84a448395630ee4474b7a HTTP/1.0
Authorization: Basic Y29uY2llcmdlOg==
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "invalid",
"lotID": "UA-LR-DGF-2019-03-19-000001",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "a9a7c8ecd9d2419db7018de9c4acb6be"
}
],
"decisions": [
{
"decisionDate": "2019-03-19T15:23:07.304009+02:00",
"decisionID": "initialDecisionID",
"id": "eb840f04e0f949548bd88357c68547bf",
"decisionOf": "lot"
},
{
"relatedItem": "11111111111111111111111111111111",
"decisionDate": "2019-03-19T15:23:07.596709+02:00",
"decisionID": "decisionAssetID",
"id": "267cc390b8ef45378f2c38f09569296c",
"decisionOf": "asset"
}
],
"lotType": "loki",
"dateModified": "2019-03-19T15:23:07.742936+02:00",
"owner": "broker",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:07.313166+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:07.313199+02:00",
"id": "b75c4c3306b94f6b9e9277612e2a3224"
}
],
"auctions": [
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "a3568f1cef0b463685caa76a28da0ad9",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "a44d3c074c144772b6750d9e930569f0",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "8947ade7f6144d4bb0eabeaf5a742885",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:07.742763+02:00",
"relatedProcesses": [
{
"type": "asset",
"id": "f8e798b3883f43fd803a555f3e677e50",
"relatedProcessID": "548ddf2bfca74136ba83cb6339ad3ca8"
}
],
"id": "c388bd047cb84a448395630ee4474b7a"
}
}
When bot finds that status of lot is pending.deleted, it turns status of the asset being attached to that lot to pending. Status of the lot itself will become deleted. The given lot becomes:
GET /api/2.5/lots/9a2c80c59e5b425795e92e80f7ad1e24 HTTP/1.0
Authorization: Basic YnJva2VyOg==
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "deleted",
"rectificationPeriod": {
"startDate": "2019-03-19T15:23:08.321095+02:00",
"endDate": "2019-03-21T15:23:08.321095+02:00"
},
"lotID": "UA-LR-DGF-2019-03-19-000002",
"description": "Нежитлове приміщення для збереження насіння",
"title": "Нежитлове приміщення",
"contracts": [
{
"status": "cancelled",
"type": "yoke",
"id": "37a7d847bcc14d60b57b1e7fb8b750cb"
}
],
"items": [
{
"registrationDetails": {
"status": "unknown"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Description",
"id": "73110000-6"
},
"additionalClassifications": [
{
"scheme": "UA-EDR",
"description": "папір і картон гофровані, паперова й картонна тара",
"id": "111111-4"
}
],
"address": {
"countryName": "Ukraine"
},
"id": "0",
"unit": {
"code": "code"
},
"quantity": 5.0001
}
],
"lotType": "loki",
"lotHolder": {
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Власник лоту"
},
"decisions": [
{
"decisionDate": "2019-03-19T15:23:07.792309+02:00",
"decisionID": "initialDecisionID",
"id": "65575976294e4c1988c42127a320ff35",
"decisionOf": "lot"
},
{
"relatedItem": "f54fde9c6c8146cc8bc1520c6429aacf",
"decisionDate": "2019-03-19T15:23:08.111917+02:00",
"decisionID": "11111-4-5",
"id": "b40e68f7f5214475acf850840f18f502",
"decisionOf": "asset"
}
],
"dateModified": "2019-03-19T15:23:08.804705+02:00",
"owner": "broker",
"lotCustodian": {
"contactPoint": {
"name": "Сергій",
"email": "segiy@mail.com"
},
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Зберігач лоту",
"address": {
"countryName": "Україна"
}
},
"auctions": [
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "9d4ba7a1ceff4accafa24f39cd90592f",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "a4a8871e8960495d903da34e90bf39b6",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "fe12a7f7b2bd419ca413e358c56df4b9",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:08.804288+02:00",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:07.798300+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:07.798339+02:00",
"id": "38bbdb5c200043fe98b3cf7d10a98a8e"
},
{
"hash": "md5:00000000000000000000000000000000",
"author": "lot_owner",
"title": "укр.doc",
"url": "http://localhost/get/3288a31a007f468889d1eb1ac163a58b?KeyID=172d32c8&Signature=tkD1JNZhzfpuSZPBgZjoxZoY6LNiNX5ZCWKTAh7M2ly1repQUO133K9NoaRr3dzMxmsdTzgz0akEm9XhOdobDQ%253D%253D",
"format": "application/msword",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:08.444246+02:00",
"documentType": "cancellationDetails",
"dateModified": "2019-03-19T15:23:08.444269+02:00",
"id": "57fbd13a43124bc88ab185786ecbb52e"
}
],
"relatedProcesses": [
{
"identifier": "UA-AR-P-2018-08-17-000002-1",
"type": "asset",
"id": "1ba3d1b7fdf744899b26b938faea79b4",
"relatedProcessID": "f0fc1f1d4fd24bce9370f5f3fd9e16a5"
}
],
"id": "9a2c80c59e5b425795e92e80f7ad1e24"
}
}
When bot finds that status of lot is pending.dissolution, it turns status of the asset being attached to that lot to pending. Status of the lot itself will become dissolved. The given lot becomes:
GET /api/2.5/lots/1970fefc39a3425a9c892a22ce346a8e HTTP/1.0
Authorization: Basic Y29uY2llcmdlOg==
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "dissolved",
"rectificationPeriod": {
"startDate": "2019-03-16T15:23:09.482898+02:00",
"endDate": "2019-03-17T15:23:09.482898+02:00"
},
"lotID": "UA-LR-DGF-2019-03-19-000003",
"description": "Нежитлове приміщення для збереження насіння",
"title": "title",
"contracts": [
{
"status": "cancelled",
"type": "yoke",
"id": "2371f3d858834f95a5b9b2fb90be0e29"
}
],
"items": [
{
"registrationDetails": {
"status": "unknown"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Description",
"id": "73110000-6"
},
"additionalClassifications": [
{
"scheme": "UA-EDR",
"description": "папір і картон гофровані, паперова й картонна тара",
"id": "111111-4"
}
],
"address": {
"countryName": "Ukraine"
},
"id": "0",
"unit": {
"code": "code"
},
"quantity": 5.0001
}
],
"lotType": "loki",
"lotHolder": {
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Власник лоту"
},
"decisions": [
{
"decisionDate": "2019-03-19T15:23:09.500637+02:00",
"decisionID": "decisionAssetID",
"id": "649144da1b6542afa428e94748af612d",
"decisionOf": "lot"
},
{
"decisionDate": "2019-03-19T15:23:09.500667+02:00",
"decisionID": "decisionAssetID",
"id": "ba5bad0413dc4d57ada80ea763e7ac14",
"decisionOf": "lot"
}
],
"dateModified": "2019-03-19T15:23:10.233010+02:00",
"owner": "broker",
"lotCustodian": {
"contactPoint": {
"name": "Сергій",
"email": "segiy@mail.com"
},
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Зберігач лоту",
"address": {
"countryName": "Україна"
}
},
"auctions": [
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "e897b7f2f35846e58887d74373181f4d",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "694f7073643247a69b6eea04ba246802",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "ae20e7f4b061435197a9338fe057202c",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:10.232827+02:00",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:08.911837+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:08.911857+02:00",
"id": "c836938c84224f9e92453837c80d238c"
}
],
"relatedProcesses": [
{
"identifier": "UA-AR-P-2018-08-17-000002-1",
"type": "asset",
"id": "9041e14bec364ea0883346927b67cc1f",
"relatedProcessID": "a299abda28e64088bd6d37ee5594c213"
}
],
"id": "1970fefc39a3425a9c892a22ce346a8e"
}
}
When bot finds that status of lot is pending.sold, it turns status of the asset being attached to that lot to complete. Status of the lot itself turns to sold. The given lot becomes:
GET /api/2.5/lots/78847efb7a4544b288a101c50282b32f HTTP/1.0
Authorization: Basic Y29uY2llcmdlOg==
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "sold",
"rectificationPeriod": {
"startDate": "2019-03-16T15:23:10.808388+02:00",
"endDate": "2019-03-17T15:23:10.808388+02:00"
},
"lotID": "UA-LR-DGF-2019-03-19-000004",
"title": "title",
"contracts": [
{
"status": "complete",
"type": "yoke",
"id": "eb7f4846ce0649eb80f7ddc9b409c159"
}
],
"items": [
{
"registrationDetails": {
"status": "unknown"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Description",
"id": "73110000-6"
},
"additionalClassifications": [
{
"scheme": "UA-EDR",
"description": "папір і картон гофровані, паперова й картонна тара",
"id": "111111-4"
}
],
"address": {
"countryName": "Ukraine"
},
"id": "0",
"unit": {
"code": "code"
},
"quantity": 5.0001
}
],
"lotType": "loki",
"decisions": [
{
"decisionDate": "2019-03-19T15:23:10.834866+02:00",
"decisionID": "decisionAssetID",
"id": "cc73e0efa39e442194fe22b933aa49ff",
"decisionOf": "lot"
},
{
"decisionDate": "2019-03-19T15:23:10.834916+02:00",
"decisionID": "decisionAssetID",
"id": "ae5f51ffd3524b5783acaa8825d91977",
"decisionOf": "lot"
}
],
"dateModified": "2019-03-19T15:23:11.384119+02:00",
"owner": "broker",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:10.301240+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:10.301269+02:00",
"id": "919434ff06d240f5b93621bb95943198"
}
],
"auctions": [
{
"status": "complete",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "a301bd1cc7f44a8db01d91b52d718e1d",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "8bb8705d77544107be729fc9fceb69b8",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "edf5fa678a554a6093474574bedec1e0",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:11.383758+02:00",
"relatedProcesses": [
{
"type": "asset",
"id": "581fa2649b454b40b9f81c9bb39cb7d7",
"relatedProcessID": "93cc092b92fb4f30898ffe69ca617e17"
}
],
"id": "78847efb7a4544b288a101c50282b32f"
}
}
Convoy operations¶
The procedure will be formed automatically after rectificationPeriod.endDate. For this to be done, lot status automatically receives active.salable at first:
GET /api/2.5/lots/1970fefc39a3425a9c892a22ce346a8e HTTP/1.0
Authorization: Basic Y2hyb25vZ3JhcGg6
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "active.salable",
"rectificationPeriod": {
"startDate": "2019-03-16T15:23:09.482898+02:00",
"endDate": "2019-03-17T15:23:09.482898+02:00"
},
"lotID": "UA-LR-DGF-2019-03-19-000003",
"description": "Нежитлове приміщення для збереження насіння",
"title": "title",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "2371f3d858834f95a5b9b2fb90be0e29"
}
],
"items": [
{
"registrationDetails": {
"status": "unknown"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Description",
"id": "73110000-6"
},
"additionalClassifications": [
{
"scheme": "UA-EDR",
"description": "папір і картон гофровані, паперова й картонна тара",
"id": "111111-4"
}
],
"address": {
"countryName": "Ukraine"
},
"id": "0",
"unit": {
"code": "code"
},
"quantity": 5.0001
}
],
"lotType": "loki",
"lotHolder": {
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Власник лоту"
},
"decisions": [
{
"decisionDate": "2019-03-19T15:23:09.500637+02:00",
"decisionID": "decisionAssetID",
"id": "649144da1b6542afa428e94748af612d",
"decisionOf": "lot"
},
{
"decisionDate": "2019-03-19T15:23:09.500667+02:00",
"decisionID": "decisionAssetID",
"id": "ba5bad0413dc4d57ada80ea763e7ac14",
"decisionOf": "lot"
}
],
"dateModified": "2019-03-19T15:23:09.658889+02:00",
"owner": "broker",
"lotCustodian": {
"contactPoint": {
"name": "Сергій",
"email": "segiy@mail.com"
},
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Зберігач лоту",
"address": {
"countryName": "Україна"
}
},
"auctions": [
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "e897b7f2f35846e58887d74373181f4d",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "694f7073643247a69b6eea04ba246802",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "ae20e7f4b061435197a9338fe057202c",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:09.658703+02:00",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:08.911837+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:08.911857+02:00",
"id": "c836938c84224f9e92453837c80d238c"
}
],
"relatedProcesses": [
{
"identifier": "UA-AR-P-2018-08-17-000002-1",
"type": "asset",
"id": "9041e14bec364ea0883346927b67cc1f",
"relatedProcessID": "a299abda28e64088bd6d37ee5594c213"
}
],
"id": "1970fefc39a3425a9c892a22ce346a8e"
}
}
When the procedure is successfully created, lot status changes to active.auction:
PATCH /api/2.5/lots/1970fefc39a3425a9c892a22ce346a8e HTTP/1.0
Authorization: Basic Y29uY2llcmdlOg==
Content-Length: 38
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
DATA:
{
"data": {
"status": "active.auction"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "active.auction",
"rectificationPeriod": {
"startDate": "2019-03-16T15:23:09.482898+02:00",
"endDate": "2019-03-17T15:23:09.482898+02:00"
},
"lotID": "UA-LR-DGF-2019-03-19-000003",
"description": "Нежитлове приміщення для збереження насіння",
"title": "title",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "2371f3d858834f95a5b9b2fb90be0e29"
}
],
"items": [
{
"registrationDetails": {
"status": "unknown"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Description",
"id": "73110000-6"
},
"additionalClassifications": [
{
"scheme": "UA-EDR",
"description": "папір і картон гофровані, паперова й картонна тара",
"id": "111111-4"
}
],
"address": {
"countryName": "Ukraine"
},
"id": "0",
"unit": {
"code": "code"
},
"quantity": 5.0001
}
],
"lotType": "loki",
"lotHolder": {
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Власник лоту"
},
"decisions": [
{
"decisionDate": "2019-03-19T15:23:09.500637+02:00",
"decisionID": "decisionAssetID",
"id": "649144da1b6542afa428e94748af612d",
"decisionOf": "lot"
},
{
"decisionDate": "2019-03-19T15:23:09.500667+02:00",
"decisionID": "decisionAssetID",
"id": "ba5bad0413dc4d57ada80ea763e7ac14",
"decisionOf": "lot"
}
],
"dateModified": "2019-03-19T15:23:09.838147+02:00",
"owner": "broker",
"lotCustodian": {
"contactPoint": {
"name": "Сергій",
"email": "segiy@mail.com"
},
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Зберігач лоту",
"address": {
"countryName": "Україна"
}
},
"auctions": [
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "e897b7f2f35846e58887d74373181f4d",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "694f7073643247a69b6eea04ba246802",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "ae20e7f4b061435197a9338fe057202c",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:09.837931+02:00",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:08.911837+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:08.911857+02:00",
"id": "c836938c84224f9e92453837c80d238c"
}
],
"relatedProcesses": [
{
"identifier": "UA-AR-P-2018-08-17-000002-1",
"type": "asset",
"id": "9041e14bec364ea0883346927b67cc1f",
"relatedProcessID": "a299abda28e64088bd6d37ee5594c213"
}
],
"id": "1970fefc39a3425a9c892a22ce346a8e"
}
}
If the procedure (procurementMethodType: sellout.english) becomes unsuccessful, lot status turns to active.salable:
GET /api/2.5/lots/1970fefc39a3425a9c892a22ce346a8e HTTP/1.0
Authorization: Basic Y2hyb25vZ3JhcGg6
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "active.salable",
"rectificationPeriod": {
"startDate": "2019-03-16T15:23:09.482898+02:00",
"endDate": "2019-03-17T15:23:09.482898+02:00"
},
"lotID": "UA-LR-DGF-2019-03-19-000003",
"description": "Нежитлове приміщення для збереження насіння",
"title": "title",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "2371f3d858834f95a5b9b2fb90be0e29"
}
],
"items": [
{
"registrationDetails": {
"status": "unknown"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Description",
"id": "73110000-6"
},
"additionalClassifications": [
{
"scheme": "UA-EDR",
"description": "папір і картон гофровані, паперова й картонна тара",
"id": "111111-4"
}
],
"address": {
"countryName": "Ukraine"
},
"id": "0",
"unit": {
"code": "code"
},
"quantity": 5.0001
}
],
"lotType": "loki",
"lotHolder": {
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Власник лоту"
},
"decisions": [
{
"decisionDate": "2019-03-19T15:23:09.500637+02:00",
"decisionID": "decisionAssetID",
"id": "649144da1b6542afa428e94748af612d",
"decisionOf": "lot"
},
{
"decisionDate": "2019-03-19T15:23:09.500667+02:00",
"decisionID": "decisionAssetID",
"id": "ba5bad0413dc4d57ada80ea763e7ac14",
"decisionOf": "lot"
}
],
"dateModified": "2019-03-19T15:23:09.658889+02:00",
"owner": "broker",
"lotCustodian": {
"contactPoint": {
"name": "Сергій",
"email": "segiy@mail.com"
},
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Зберігач лоту",
"address": {
"countryName": "Україна"
}
},
"auctions": [
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "e897b7f2f35846e58887d74373181f4d",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "694f7073643247a69b6eea04ba246802",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "ae20e7f4b061435197a9338fe057202c",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:09.658703+02:00",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:08.911837+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:08.911857+02:00",
"id": "c836938c84224f9e92453837c80d238c"
}
],
"relatedProcesses": [
{
"identifier": "UA-AR-P-2018-08-17-000002-1",
"type": "asset",
"id": "9041e14bec364ea0883346927b67cc1f",
"relatedProcessID": "a299abda28e64088bd6d37ee5594c213"
}
],
"id": "1970fefc39a3425a9c892a22ce346a8e"
}
}
As long as a new procedure is being automatically created, the lot will be given active.auction status:
PATCH /api/2.5/lots/1970fefc39a3425a9c892a22ce346a8e HTTP/1.0
Authorization: Basic Y29uY2llcmdlOg==
Content-Length: 38
Content-Type: application/json
Host: lb.api-sandbox.registry.ea.openprocurement.net
DATA:
{
"data": {
"status": "active.auction"
}
}
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "active.auction",
"rectificationPeriod": {
"startDate": "2019-03-16T15:23:09.482898+02:00",
"endDate": "2019-03-17T15:23:09.482898+02:00"
},
"lotID": "UA-LR-DGF-2019-03-19-000003",
"description": "Нежитлове приміщення для збереження насіння",
"title": "title",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "2371f3d858834f95a5b9b2fb90be0e29"
}
],
"items": [
{
"registrationDetails": {
"status": "unknown"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Description",
"id": "73110000-6"
},
"additionalClassifications": [
{
"scheme": "UA-EDR",
"description": "папір і картон гофровані, паперова й картонна тара",
"id": "111111-4"
}
],
"address": {
"countryName": "Ukraine"
},
"id": "0",
"unit": {
"code": "code"
},
"quantity": 5.0001
}
],
"lotType": "loki",
"lotHolder": {
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Власник лоту"
},
"decisions": [
{
"decisionDate": "2019-03-19T15:23:09.500637+02:00",
"decisionID": "decisionAssetID",
"id": "649144da1b6542afa428e94748af612d",
"decisionOf": "lot"
},
{
"decisionDate": "2019-03-19T15:23:09.500667+02:00",
"decisionID": "decisionAssetID",
"id": "ba5bad0413dc4d57ada80ea763e7ac14",
"decisionOf": "lot"
}
],
"dateModified": "2019-03-19T15:23:09.838147+02:00",
"owner": "broker",
"lotCustodian": {
"contactPoint": {
"name": "Сергій",
"email": "segiy@mail.com"
},
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Зберігач лоту",
"address": {
"countryName": "Україна"
}
},
"auctions": [
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "e897b7f2f35846e58887d74373181f4d",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "694f7073643247a69b6eea04ba246802",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "scheduled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "ae20e7f4b061435197a9338fe057202c",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:09.837931+02:00",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:08.911837+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:08.911857+02:00",
"id": "c836938c84224f9e92453837c80d238c"
}
],
"relatedProcesses": [
{
"identifier": "UA-AR-P-2018-08-17-000002-1",
"type": "asset",
"id": "9041e14bec364ea0883346927b67cc1f",
"relatedProcessID": "a299abda28e64088bd6d37ee5594c213"
}
],
"id": "1970fefc39a3425a9c892a22ce346a8e"
}
}
In case of that lot has not been sold (either contract has become unsuccessful or a procedure has received cancelled status or third procedure (procurementMethodType: sellout.insider) has turned to unsuccessful) , its status becomes pending.dissolution. This happens if all three auctions are in unsuccessful status or one has been given cancelled. The given lot becomes:
GET /api/2.5/lots/1970fefc39a3425a9c892a22ce346a8e HTTP/1.0
Authorization: Basic Y29udm95Og==
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "pending.dissolution",
"rectificationPeriod": {
"startDate": "2019-03-16T15:23:09.482898+02:00",
"endDate": "2019-03-17T15:23:09.482898+02:00"
},
"lotID": "UA-LR-DGF-2019-03-19-000003",
"description": "Нежитлове приміщення для збереження насіння",
"title": "title",
"contracts": [
{
"status": "cancelled",
"type": "yoke",
"id": "2371f3d858834f95a5b9b2fb90be0e29"
}
],
"items": [
{
"registrationDetails": {
"status": "unknown"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Description",
"id": "73110000-6"
},
"additionalClassifications": [
{
"scheme": "UA-EDR",
"description": "папір і картон гофровані, паперова й картонна тара",
"id": "111111-4"
}
],
"address": {
"countryName": "Ukraine"
},
"id": "0",
"unit": {
"code": "code"
},
"quantity": 5.0001
}
],
"lotType": "loki",
"lotHolder": {
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Власник лоту"
},
"decisions": [
{
"decisionDate": "2019-03-19T15:23:09.500637+02:00",
"decisionID": "decisionAssetID",
"id": "649144da1b6542afa428e94748af612d",
"decisionOf": "lot"
},
{
"decisionDate": "2019-03-19T15:23:09.500667+02:00",
"decisionID": "decisionAssetID",
"id": "ba5bad0413dc4d57ada80ea763e7ac14",
"decisionOf": "lot"
}
],
"dateModified": "2019-03-19T15:23:10.055313+02:00",
"owner": "broker",
"lotCustodian": {
"contactPoint": {
"name": "Сергій",
"email": "segiy@mail.com"
},
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Зберігач лоту",
"address": {
"countryName": "Україна"
}
},
"auctions": [
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "e897b7f2f35846e58887d74373181f4d",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "694f7073643247a69b6eea04ba246802",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "ae20e7f4b061435197a9338fe057202c",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:10.055005+02:00",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:08.911837+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:08.911857+02:00",
"id": "c836938c84224f9e92453837c80d238c"
}
],
"relatedProcesses": [
{
"identifier": "UA-AR-P-2018-08-17-000002-1",
"type": "asset",
"id": "9041e14bec364ea0883346927b67cc1f",
"relatedProcessID": "a299abda28e64088bd6d37ee5594c213"
}
],
"id": "1970fefc39a3425a9c892a22ce346a8e"
}
}
When contract has been successfully created within the Module of Contracting, lot’s status turns to active.contracting, after what lot becomes complete:
GET /api/2.5/lots/1970fefc39a3425a9c892a22ce346a8e HTTP/1.0
Authorization: Basic Y29udm95Og==
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "active.contracting",
"rectificationPeriod": {
"startDate": "2019-03-16T15:23:09.482898+02:00",
"endDate": "2019-03-17T15:23:09.482898+02:00"
},
"lotID": "UA-LR-DGF-2019-03-19-000003",
"description": "Нежитлове приміщення для збереження насіння",
"title": "title",
"contracts": [
{
"status": "scheduled",
"type": "yoke",
"id": "2371f3d858834f95a5b9b2fb90be0e29"
}
],
"items": [
{
"registrationDetails": {
"status": "unknown"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Description",
"id": "73110000-6"
},
"additionalClassifications": [
{
"scheme": "UA-EDR",
"description": "папір і картон гофровані, паперова й картонна тара",
"id": "111111-4"
}
],
"address": {
"countryName": "Ukraine"
},
"id": "0",
"unit": {
"code": "code"
},
"quantity": 5.0001
}
],
"lotType": "loki",
"lotHolder": {
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Власник лоту"
},
"decisions": [
{
"decisionDate": "2019-03-19T15:23:09.500637+02:00",
"decisionID": "decisionAssetID",
"id": "649144da1b6542afa428e94748af612d",
"decisionOf": "lot"
},
{
"decisionDate": "2019-03-19T15:23:09.500667+02:00",
"decisionID": "decisionAssetID",
"id": "ba5bad0413dc4d57ada80ea763e7ac14",
"decisionOf": "lot"
}
],
"dateModified": "2019-03-19T15:23:09.921218+02:00",
"owner": "broker",
"lotCustodian": {
"contactPoint": {
"name": "Сергій",
"email": "segiy@mail.com"
},
"identifier": {
"scheme": "AE-ADCD",
"id": "11111-4"
},
"name": "Зберігач лоту",
"address": {
"countryName": "Україна"
}
},
"auctions": [
{
"status": "complete",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "e897b7f2f35846e58887d74373181f4d",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "694f7073643247a69b6eea04ba246802",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "ae20e7f4b061435197a9338fe057202c",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:09.920531+02:00",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:08.911837+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:08.911857+02:00",
"id": "c836938c84224f9e92453837c80d238c"
}
],
"relatedProcesses": [
{
"identifier": "UA-AR-P-2018-08-17-000002-1",
"type": "asset",
"id": "9041e14bec364ea0883346927b67cc1f",
"relatedProcessID": "a299abda28e64088bd6d37ee5594c213"
}
],
"id": "1970fefc39a3425a9c892a22ce346a8e"
}
}
When contract reaches terminated status, lot automatically becomes pending.sold, after what lot becomes complete:
GET /api/2.5/lots/78847efb7a4544b288a101c50282b32f HTTP/1.0
Authorization: Basic Y2FyYXZhbjo=
Host: lb.api-sandbox.registry.ea.openprocurement.net
Response: 200 OK
Content-Type: application/json
X-Content-Type-Options: nosniff
{
"data": {
"status": "pending.sold",
"rectificationPeriod": {
"startDate": "2019-03-16T15:23:10.808388+02:00",
"endDate": "2019-03-17T15:23:10.808388+02:00"
},
"lotID": "UA-LR-DGF-2019-03-19-000004",
"title": "title",
"contracts": [
{
"status": "complete",
"type": "yoke",
"id": "eb7f4846ce0649eb80f7ddc9b409c159"
}
],
"items": [
{
"registrationDetails": {
"status": "unknown"
},
"description": "футляри до державних нагород",
"classification": {
"scheme": "CPV",
"description": "Description",
"id": "73110000-6"
},
"additionalClassifications": [
{
"scheme": "UA-EDR",
"description": "папір і картон гофровані, паперова й картонна тара",
"id": "111111-4"
}
],
"address": {
"countryName": "Ukraine"
},
"id": "0",
"unit": {
"code": "code"
},
"quantity": 5.0001
}
],
"lotType": "loki",
"decisions": [
{
"decisionDate": "2019-03-19T15:23:10.834866+02:00",
"decisionID": "decisionAssetID",
"id": "cc73e0efa39e442194fe22b933aa49ff",
"decisionOf": "lot"
},
{
"decisionDate": "2019-03-19T15:23:10.834916+02:00",
"decisionID": "decisionAssetID",
"id": "ae5f51ffd3524b5783acaa8825d91977",
"decisionOf": "lot"
}
],
"dateModified": "2019-03-19T15:23:11.249673+02:00",
"owner": "broker",
"documents": [
{
"description": "Перелік та реквізити авторизованих електронних майданчиків (найменування установи банку, її адреса та номери рахунків, відкритих для внесення гарантійного внеску, реєстраційного внеску)",
"title": "Перелік та реквізити авторизованих електронних майданчиків",
"url": "https://prozorro.sale/info/elektronni-majdanchiki-ets-prozorroprodazhi-cbd2",
"documentOf": "lot",
"datePublished": "2019-03-19T15:23:10.301240+02:00",
"documentType": "x_PlatformLegalDetails",
"dateModified": "2019-03-19T15:23:10.301269+02:00",
"id": "919434ff06d240f5b93621bb95943198"
}
],
"auctions": [
{
"status": "complete",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 300.87,
"valueAddedTaxIncluded": true
},
"auctionPeriod": {
"startDate": "2019-03-25T15:28:05.257425+02:00"
},
"tenderAttempts": 1,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 3000.87,
"valueAddedTaxIncluded": true
},
"auctionParameters": {
"type": "english"
},
"id": "a301bd1cc7f44a8db01d91b52d718e1d",
"guarantee": {
"currency": "UAH",
"amount": 700.87
}
},
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 150.44,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 2,
"procurementMethodType": "sellout.english",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "english"
},
"id": "8bb8705d77544107be729fc9fceb69b8",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
},
{
"status": "cancelled",
"bankAccount": {
"accountIdentification": [
{
"scheme": "accountNumber",
"id": "111111-8",
"description": "some description"
}
],
"bankName": "name of bank"
},
"minimalStep": {
"currency": "UAH",
"amount": 0,
"valueAddedTaxIncluded": true
},
"tenderAttempts": 3,
"procurementMethodType": "sellout.insider",
"value": {
"currency": "UAH",
"amount": 1500.44,
"valueAddedTaxIncluded": true
},
"tenderingDuration": "P25DT12H",
"auctionParameters": {
"type": "insider",
"dutchSteps": 99
},
"id": "edf5fa678a554a6093474574bedec1e0",
"guarantee": {
"currency": "UAH",
"amount": 350.44
}
}
],
"date": "2019-03-19T15:23:11.249411+02:00",
"relatedProcesses": [
{
"type": "asset",
"id": "581fa2649b454b40b9f81c9bb39cb7d7",
"relatedProcessID": "93cc092b92fb4f30898ffe69ca617e17"
}
],
"id": "78847efb7a4544b288a101c50282b32f"
}
}
Retrieving Lot Information¶
Getting list of all lots¶
Getting list of all lots.
Example request:
Example response:
query offset: offset number query limit: limit number. default is 100 reqheader Authorization: optional OAuth token to authenticate statuscode 200: no error statuscode 404: endpoint not found
Sorting¶
Lots returned are sorted by modification time.
Limiting number of Lots returned¶
You can control the number of data entries in the lots feed (batch size) with limit parameter. If not specified, data is being returned in batches of 100 elements.
Batching¶
The response contains next_page element with the following properties:
offset: | This is the parameter you have to add to the original request you made to get next page. |
---|---|
path: | This is path section of URL with original parameters and offset parameter added/replaced above. |
uri: | The full version of URL for next page. |
If next page request returns no data (i.e. empty array) then there is little sense in fetching further pages.
Synchronizing¶
It is often necessary to be able to syncronize central database changes with other database (we’ll call it “local”). The default sorting “by modification date” together with Batching mechanism allows one to implement synchronization effectively. The synchronization process can go page by page until there is no new data returned. Then the synchronizer has to pause for a while to let central database register some changes and attempt fetching subsequent page. The next_page guarantees that all changes from the last request are included in the new batch.
The safe frequency of synchronization requests is once per 5 minutes.
Reading the individual lot information¶
Getting lot details.
Example request:
Example response:
reqheader Authorization: optional OAuth token to authenticate statuscode 200: no error statuscode 404: lot not found
Authentication¶
Some of the API requests (especially the ones that are read-only GET requests) do not require any authenication. The other ones, that modify data into the database, require broker authentication via API key. Additionally, owner tokens are issued to facilitate multiple actor roles upon object creation.
API keys¶
API key is username to use with Basic Authenication scheme.
Owner tokens¶
Getting token¶
The token is issued when object is created in the database:
You can see the access with token in response. Its value can be used to modify objects further under “Owner role”.
Using token¶
You can pass access token in the following ways:
- acc_token URL query string parameter
- X-Access-Token HTTP request header
- access.token in the body of POST/PUT/PATCH request
See the example of the action with token passed as URL query string:
API in cluster mode¶
There is a cluster of several servers that synchronize data between each other. Client should always work with the same server to ensure consistency between separate requests to the RDB. That is why cookie is required while sending POST/PUT/PATCH/DELETE requests. Cookies provide server stickiness. You can get such cookie via GET request and then use it for POST/PUT/PATCH/DELETE.
If during operations the server requested by cookie went down or is unavailable, client will receive status code 412 of request and new cookie to use. Request should be repeated with new cookie.
Options¶
In addition to providing fields and their values in a request, you may also specify options to control how your request is interpreted and how the response is generated. For GET requests, options are specified as URL parameters prefixed with opt_. For POST or PUT requests, options are specified in the body, inside the top-level options object (a sibling of the data object). The option specified in the body overrides the opt_ one from URL parameter.
These options can be used in different combinations in a single request, though some of them may conflict in their impact on the response.
pretty: | ?opt_pretty options: { pretty: true } Provides the response in “pretty” output. In case of JSON this means doing proper line breaking and indentation to make it readable. This will take extra time and increase the response size so it is advisable to use this only during debugging. |
---|---|
jsonp: | ?opt_jsonp=myCallback Returns the output in JSON-P format instead of plain JSON. This allows requests to come from within browsers and work around the “same origin policy.” The function named as the value of the opt_jsonp parameter will be called with a single argument, a JavaScript object representing the response. |
fields: | ?opt_fields=comma,separated,field,list List of extra fields to include in response. |
Performance recommendations¶
Rate Control¶
“Aggressive” IP addresses can be restricted in the speed with which servers are processing RDB requests. In this case RDB will respond with status code 429 to the requests that returned faster than allowed.
Expected client response to such restriction is to repeat requests returned with 429 status code increasing the delay between individual requests sent to the RDB until requests become successful (2xx / 3xx responses).
Such RDB servers behavior is required in order to distribute server resources evenly between clients.
Responses¶
After processing API always provides response, reporting either success or failure.
Status Codes¶
In all cases, the API should return an HTTP Status Code that indicates the nature of the failure (see below), with a response body in JSON format containing additional information.
- 200
- Success. If data was requested, it will be available in the data field at the top level of the response body.
- 201
- Success (for object creation). Its information is available in the data field at the top level of the response body. The API URL where the object can be retrieved is also returned in the Location header of the response.
- 400
- Invalid request. This usually occurs because of a missing or malformed parameter. Check the documentation and the syntax of your request and try again.
- 401
- No authorization. A valid API key was not provided with the request, so the API could not associate a user with the request.
- 403
- Forbidden. The API key and request syntax was valid but the server is refusing to complete the request. This can happen if you are trying to read or write to objects or properties that you do not have access to.
- 404
- Not found. Either the request method and path supplied do not specify a known action in the API, or the object specified by the request does not exist.
- 412
- Precondition Failed. See API in cluster mode.
- 429
- Rate Limit Enforced. See Rate control.
- 500
- Server error. There was a problem on OpenProcurement’s end.
Success Response¶
Every successful get, create, update, replace request results in response that contains data attribute. That data attribute contains full JSON object representation after the operation. If some data were generated in the result of processing (like new object IDs, or modified date) they are present in the respose.
The listing requests result in similar responses, but instead of single object in data attribute, the JSON response contains collection of objects.
Example Success Response¶
Here is a response that describes lot
Error Response¶
In the event of an error, the response body will contain an errors field at the top level. It contains an array of at least one error object, described below:
location: | Part of the request causing the error. Possible values are header and body. |
---|---|
name: |
|
description: | Verbose (human readable) description of the error. |
Example Error Response¶
Sample below indicates incomplete request.
Acceleration mode for sandbox¶
If you want to experiment with lot, you can use acceleration mode and start your lot name with “TESTING”.
Acceleration mode was developed to enable procedure testing in the sandbox and to reduce periods of this procedure.
- To enable acceleration mode you will need to:
- add additional parameter mode with a value
test
; - set
quick, accelerator=1440
as text value for procurementMethodDetails. This parameter will accelerate auction periods. The number 1440 shows that restrictions and time frames will be reduced in 1440 times. - set
quick, accelerator=1440
as text value for sandboxParameters. This parameter will accelerate lot fnd asset periods. The number 1440 shows that restrictions and time frames will be reduced in 1440 times. - set
quick
as a value for submissionMethodDetails. This parameter works only withmode = "test"
and will speed up auction start date.
- add additional parameter mode with a value
This mode will work only in the sandbox.
Synchronization¶
- During normal auction synchronization via
/auctions
test auctions are not visible. - To get test auctions synchronize via
/auctions?mode=test
. - If you synchronize via
/auctions?mode=all
, then you will get all auctions. - Auction mode can be set only on lot creation (lots.auctions) phase, it can not be set later.
Note
Can not be used for assets.