Skip to content

Award

Jump to bottom
Francisco Yedro edited this page Dec 2, 2020 · 15 revisions

An award is the final part of a contracting process and is the formal decision and approval to establish a contract.

From the knowledge graph a complete list, or the information of a particular award, can be obtained, including the list of amendments, documents, items or suppliers of this award. These are the six resources that have been implemented to fulfil these requirements:

GET /award: This returns the list of all the awards included in the knowledge graph. The list is displayed in JSON format and consists of the following model schema:

MODEL SCHEME FIELDS
{
"id": xsd:string,
"title": xsd:string,
"description": xsd:string,
"date": xsd:dateTime,
"status": xsd:string
}
  • “id” stands for the identifier of the award. It must be unique and must not change within the Open Contracting Process.
  • “title” stands for the title of the award.
  • “description” stands for the description of the award.
  • “date” stands for the date of the contract award. This is usually the date on which a decision to award was made.
  • “status” stands for the current status award from the closed awardStatus code list.

Example of use: http://data.tbfy.eu/kg-api/award

GET /award/{id}: This returns the whole information included in the knowledge graph of a specific award. The list is displayed in JSON format and consists of the following model schema:

MODEL SCHEME FIELDS
{
"id": xsd:string,
“title”: xsd:string,
“descrption”: xsd:string,
“date”: xsd:dateTime,
“status”: xsd:string,
“contractPeriod”:
{
“startDate”: xsd:dateTime,
“endDate”: xsd:dateTime
}
“value”:
{
“amount”: xsd:decimal,
“currency”: xsd:string
}
“tender”:
{
“id”: xsd:string,
“title”: xsd:string,
“description”: xsd:string,
“status”: xsd:string
}
}
  • “id” stands for the identifier of the award. It must be unique and must not change within the Open Contracting Process.
  • “title” stands for the title of the award.
  • “description” stands for the description of the award.
  • “date” stands for the date of the contract award. This is usually the date on which a decision to award was made

Example of use: http://data.tbfy.eu/kg-api/organisation/gb-02183240

GET /award/:id/amendment: This returns the list of amendments of a specific award included in the knowledge graph. The list is displayed in JSON format and consists of the following model schema:

MODEL SCHEME FIELDS
{
"id": xsd:string,
"description": xsd:string,
"date": xsd:dateTime
}
  • “id” stands for the identifier of the amendment, often the amendment number.
  • “description” stands for a free text, or semi-structured, description of the changes made in this amendment.
  • “date” stands for the date of the amendment.

Example of use: http://tbfy.librairy.linkeddata.es/api/award/ocds-0c46vo-0001-02f25542-7be1-42f8-a670-873fe39f2cd7_1bef4ef5-d95d-47b0-9baf-9db8564688e3/amendment

GET /award/:id/document: This returns the list of documents that can be attached related to a specific award included in the knowledge graph. The list is displayed in JSON format and consists of the following model schema:

MODEL SCHEME FIELDS
{
"id": xsd:string,
"type": xsd:string,
"language": xsd:string,
"url": xsd:string
}
  • “id” stands for the unique identifier of the document; this field is used to keep track of multiple revisions of a document.
  • “type” stands for a classification of the document described.
  • “language” stands for of the linked document using either two-letter ISO639-1, or extended BCP47 language tags. The use of lowercase two-letter codes from ISO639-1 is recommended unless there is a clear user need for distinguishing the language subtype.
  • “url” stands for A direct link to the document or attachment. The server providing access to this document ought to be configured to correctly report the document mime type.

Example of use: http://tbfy.librairy.linkeddata.es/api/award/ocds-0c46vo-0133-000022-2019_20190102000022_A1/document/

GET /award/:id/item: This returns the list of items associated to a specific award included in the knowledge graph. The list is displayed in JSON format and consists of the following model schema:

MODEL SCHEME FIELDS
{
"id": xsd:string,
"description": xsd:string,
"classificationScheme": xsd:string,
"classification": xsd:string,
"additionalItemClassificationScheme": xsd:string,
"additionalItemClassification": xsd:string
}
  • “id” stands for a local identifier to reference and merge the items by. Must be unique within a given array of items.
  • “description” stands for a description of the goods, services to be provided.
  • “classificationScheme” stands for the primary classification of the item according to the tenderStatus code list table
  • “classification” stands for the classification number according to the previous list.
  • “additionalItemClassificationScheme” stands for an array of additional classifications of the item.
  • “additionalItemClassification” stands for an array of numbers for the additional classifications.

Example of use: http://tbfy.librairy.linkeddata.es/api/award/ocds-0c46vo-0133-000022-2019_20190102000022_A1/item/

Documentation of the core-API

Resources

Return to Home

Clone this wiki locally