Merge pull request #4 from VolVoz/master

Create 'Data standarts' documentation

docs/source/index.rst

@@ -20,6 +20,7 @@ Contents:
 
    overview
    tutorial
+   standard/index
    reference
 
 Indices and tables

docs/source/standard/award.rst

@@ -0,0 +1,77 @@
+.. . Kicking page rebuild 2014-10-30 17:00:08
+.. include:: defs.hrst
+
+.. index:: Award
+.. _award:
+
+Award
+=====
+
+Schema
+------
+
+:id:
+    string, autogenerated, read-only
+
+    |ocdsDescription|
+    The identifier for this award.
+
+:bid_id:
+    MD5Type, autogenerated, read-only
+
+    The Id of a bid that the award relates to.
+
+:title:
+    string, multilingual
+
+    |ocdsDescription|
+    Award title.
+
+:description:
+    string, multilingual
+
+    |ocdsDescription|
+    Award description.
+
+:status:
+    string
+
+    |ocdsDescription|
+    The current status of the award drawn from the `awardStatus` codelist.
+
+    Possible values are:
+
+    * `pending` - the award is under review of qualification committee
+    * `unsuccessful` - the award has been rejected by qualification comittee
+    * `active` - the tender is awarded to the bidder from the `bid_id`
+    * `cancelled` - the award has been cancelled by complaint review body
+
+:date:
+    string, :ref:`Date`, autogenerated, read-only
+
+    |ocdsDescription|
+    The date of the contract award.
+
+:value:
+    List of :ref:`Value` objects, autogenerated, read-only
+
+    |ocdsDescription|
+    The total value of this award.
+
+:suppliers:
+    List of :ref:`Organization` objects, autogenerated, read-only
+
+    |ocdsDescription|
+    The suppliers awarded with this award.
+
+:items:
+    List of :ref:`Item` objects, autogenerated, read-only
+
+    |ocdsDescription|
+    The goods and services awarded in this award, broken into line items wherever possible. Items should not be duplicated, but the quantity specified instead.
+
+:documents:
+    List of :ref:`Document` objects
+
+    |ocdsDescription|
+    All documents and attachments related to the award, including any notices.

docs/source/standard/bid.rst

@@ -0,0 +1,100 @@
+.. . Kicking page rebuild 2014-10-30 17:00:08
+
+.. index:: Bid, Parameter, LotValue, bidder, participant, pretendent
+
+.. _bid:
+
+Bid
+===
+
+Schema
+------
+
+:tenderers:
+    List of :ref:`Organization` objects
+
+:date:
+    string, :ref:`date`, autogenerated
+
+:id:
+    uid, autogenerated
+
+:status:
+    string
+
+    Possible values are:
+
+    * `registration`
+    * `validBid`
+    * `invalidBid`
+
+:value:
+    :ref:`Value`, required
+
+    Validation rules:
+
+    * `amount` should be less than `Tender.value.amout`
+    * `currency` should either be absent or match `Tender.value.currency`
+    * `valueAddedTaxIncluded` should either be absent or match `Tender.value.valueAddedTaxIncluded`
+
+:documents:
+    List of :ref:`Document` objects
+
+:parameters:
+    List of :ref:`Parameter` objects
+
+:lotValues:
+    List of :ref:`LotValue` objects
+
+:participationUrl:
+    url
+
+    A web address for participation in auction.
+
+.. _Parameter:
+
+Parameter
+=========
+
+Schema
+------
+
+:code:
+    string, required
+
+    Code of the feature.
+
+:value:
+    float, required
+
+    Value of the feature.
+
+.. _LotValue:
+
+LotValue
+========
+
+Schema
+------
+
+:value:
+    :ref:`Value`, required
+
+    Validation rules:
+
+    * `amount` should be less than `Lot.value.amout`
+    * `currency` should either be absent or match `Lot.value.currency`
+    * `valueAddedTaxIncluded` should either be absent or match `Lot.value.valueAddedTaxIncluded`
+
+:relatedLot:
+    string
+
+    Id of related :ref:`lot`.
+
+:date:
+    string, :ref:`date`, autogenerated
+
+:participationUrl:
+    url
+
+    A web address for participation in auction.

docs/source/standard/cancellation.rst

@@ -0,0 +1,51 @@
+.. . Kicking page rebuild 2014-10-30 17:00:08
+.. include:: defs.hrst
+
+.. index:: Cancellation
+.. _cancellation:
+
+Cancellation
+============
+
+Schema
+------
+
+:id:
+    uid, autogenerated
+
+:reason:
+    string, multilingual, required
+
+    The reason, why Tender is being cancelled.
+
+:status:
+    string
+
+    Possible values are:
+     :`pending`:
+       Default. The request is being prepared.
+     :`active`:
+       Cancellation activated.
+
+:documents:
+    List of :ref:`Document` objects
+
+    Documents accompanying the Cancellation: Protocol of Tender Committee
+    with decision to cancel the Tender.
+
+:date:
+    string, :ref:`date`
+
+    Cancellation date.
+
+:cancellationOf:
+    string, required 
+
+    Possible and default values are:
+
+    * `tender`
+
+:relatedLot:
+    string
+
+    Id of related :ref:`lot`.

docs/source/standard/contract.rst

@@ -0,0 +1,76 @@
+.. . Kicking page rebuild 2014-10-30 17:00:08
+.. include:: defs.hrst
+
+.. index:: Contract
+.. _Contract:
+
+Contract
+========
+
+Schema
+------
+
+:id:
+    uid, autogenerated
+
+    |ocdsDescription|
+    The identifier for this contract. 
+
+:awardID:
+    string, required
+
+    |ocdsDescription|
+    The `Award.id` against which this contract is being issued.
+
+:title:
+    string, required
+
+    |ocdsDescription|
+    Contract title
+
+:description:
+    string
+
+    |ocdsDescription|
+    Contract description
+
+:status:
+    string, required
+
+    |ocdsDescription|
+    The current status of the contract. 
+
+    Possible values are:
+
+    * `pending` - this contract has been proposed, but is not yet in force.
+      It may be awaiting signature.
+    * `active` - this contract has been signed by all the parties, and is
+      now legally in force.
+    * `cancelled` - this contract has been cancelled prior to being signed.
+    * `terminated` - this contract was signed and in force, and has now come
+      to a close.  This may be due to a successful completion of the contract,
+      or may be early termination due to some non-completion issue.
+
+:period:
+    :ref:`Period`
+
+    |ocdsDescription|
+    The start and end date for the contract. 
+
+:value:
+    :ref:`Value`
+
+    |ocdsDescription|
+    The total value of this contract. 
+
+:dateSigned:
+    string, :ref:`date`, autogenerated
+
+    |ocdsDescription|
+    The date the contract was signed. In the case of multiple signatures, the date of the last signature.
+
+:documents:
+    List of :ref:`Document` objects
+
+    |ocdsDescription|
+    All documents and attachments related to the contract, including any notices. 

docs/source/standard/defs.hrst

@@ -0,0 +1 @@
+.. |ocdsDescription| replace:: OpenContracting Description: