Permalink
Branch: master
Find file Copy path
Fetching contributors…
Cannot retrieve contributors at this time
73 lines (51 sloc) 2.05 KB

Overview

openregistry.assets.basic contains the description of the Registry Data Base.

Features

  • Basic asset is a representation of an item.
  • Procedure can be switched from draft status to pending.
  • Basic assets are combined in lot, being marked as attached to that lot.
  • The only currency (Value.currency) to be used is hryvnia (UAH).

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 auction, 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.api

Documentation of related packages

API stability

API is relatively stable. The changes in the API are communicated via Open Procurement API maillist.

Change log

0.1

Not Released

  • Set up general build, testing, deployment, and ci framework.
  • Creating/modifying asset

Next steps

You might find it helpful to look at the :ref:`tutorial`, or the :ref:`reference`.