Schema reference¶
The tables below describe each of the fields and objects in OC4IDS. To see how they fit together, consult the schema browser.
Project¶
ContractingProcess¶
ContractingProcessSummary¶
LinkedRelease¶
Components¶
Address¶
We use properties from schema.org and vCard for address components. In the event source data cannot be broken down into these parts, data SHOULD contain at least a streetAddress value and postal code.
When working with data, users should be aware that addresses may not always be broken down using all the properties the specification provides.
BudgetBreakdown¶
A budget breakdown is provided through an array of BudgetBreakdown objects, each of which represents budget for a particular period, from a particular source, or a combination of the two.
See the documentation of the OCDS Budget Breakdown extension for more details of this data model. BudgetBreakdown can also be extended further to include budget classifications data following the pattern described in the OCDS Budgets and Spend extension.
Classification¶
A classification consists of an identifier for the codelist (the scheme) and a code from that codelist (the id), and then a human-readable label for the classification (the description).
For example:
{
"scheme":"COFOG",
"id":"05.2",
"description":"Waste water management"
}
ContactPoint¶
Document¶
For each document the following structured information may be provided.
Identifier¶
Use of stable official organization identifiers can help join up data between systems.
Organization identifiers should be constructed by collecting an official company (or government body) registration number for the organization, and then finding the org-id.guide list code for the list this identifier is taken from to use in the scheme field.
For example, if identifying a company in Colombia, look up its identifier in the Unified Commercial and Social Registry and use the list code CO-RUE.
Location¶
A project may have one or more locations. Locations may be expressed in a number of different ways, using one or more of:
A point location or geometry (e.g. trace of a road, or polygon giving the boundary of a site);
A gazetteer entry (e.g. town name);
An address.
Modification¶
For each modification, the following structured information may be provided.
Organization¶
For each organization, provide as much structured data as you can.
OrganizationReference¶
Period¶
Dates MUST be expressed using a full ISO 8601 date-time including a timezone. E.g.:
2018-09-18T11:26:04+01:00
Where the source system does not contain time information, a judgment should be made as to the relevant time to attach (e.g. start of the day; end of the working day etc.).
Person¶
Use this object when you need to disclose the details of people associated with, representing or working on behalf of an organization involved in the project.
Transaction¶
A spending transaction related to a contracting process.
Value¶
All values should be published along with their currency using the following structure.