Data schemas

Note

All fields are required; some objects and lists can be empty – e.g. if you have no pesticide applications, send "pesticides": [] rather than "pesticides": [{}], or skipping the pesticides key entirely.

Note

Text in (Italics) identifies where in the CFT user interface to locate each field.

The below documentation is automatically generated from JSON schema files:

If you’re having a problem with an API call, you can use these schema files to validate the data that you’re sending, e.g.

$ jsonschema api/v1/schemas/crop_product-calculate-input.json \
        -i api/v1/samples/crop_product-calculate-input.json

Crop “Calculate”

type

object

properties

  • farm

type

object

properties

  • country

Country name or ID (Farm Settings → Country)

type

integer / string

examples

Ghana

  • territory

Territory name or ID; send null if selected Country has no territories (Farm Settings → Territory)

type

integer / string / null

examples

Alabama

  • climate

Climate (Farm Settings → Climate)

type

integer / string

examples

temperate

  • average_temperature

type

object

properties

  • value

(Farm Settings → Average Annual Temperature Value)

type

number

  • unit

Temperature Unit name or ID (Farm Settings → Average Annual Temperature Unit)

type

string / number

examples

°C

type

object

  • farm_identifier

(Farm Settings → Farm Identifier)

type

string / number

type

object

  • crop

type

object

properties

  • product_fresh

type

object

properties

  • value

Fresh product yield (Crop → Gross Yield)

type

number

examples

10

minimum

0

  • unit

Weight, volume or unit Unit name or ID (Crop → Gross Yield Unit)

type

integer / string

examples

tonne

type

object

  • product_finished

type

object

properties

  • value

Fresh product yield (Crop → Net Yield)

type

number

examples

10

minimum

0

  • unit

Weight, volume or unit Unit name or ID (Crop → Net Yield Unit)*

type

integer / string

examples

tonne

type

object

  • type

Crop type (Crop → Crop Name)

type

integer / string

examples

Barley

  • field_size

type

object

properties

  • value

Growing area size (Crop → Crop Area)

Growing area size (Crop → Crop Area)

examples

1

minimum

0

  • unit

Area Unit name or ID (Crop → Crop Area Unit)

type

integer / string

examples

ha

type

object

  • soil

type

object

properties

  • texture_id

Soil texture (Soil → Soil Texture)

type

integer

examples

1

  • organic_matter_id

Soil organic matter (Soil → Soil Organic Matter)

type

integer

examples

2

  • organic_matter_custom

Custom SOM (send organic_matter_id: 5) (Soil → Soil Organic Matter)

type

number / null

examples

2

  • moisture_id

Soil moisture (Soil → Soil Moisture)

type

integer

examples

1

  • drainage_id

Soil drainage (Soil → Soil Drainage)

type

integer

examples

1

  • ph_id

Soil ph (Soil → Soil pH)

type

integer

examples

4

type

object

  • residue

Crop residue (send {} if you have no residue at all)

type

object

properties

  • value

Amount of crop residue (send null to estimate) (Crop → Residue Amount)

type

number / string / null

examples

2.5

minimum

0

  • unit

Weight-per-area Unit (Crop → Residue Unit)*

type

number / string / null

examples

tonne / ha

  • management

Residue management type (Crop → Residue Management)

type

integer / string / null

examples

4

Crop residue (send {} if you have no residue at all)

type

object

  • seed_amount

Seed quantity (potato only, send {} otherwise) (Crop → Seed Amount)

type

object

properties

  • value

type

number

examples

10

minimum

0

  • unit

Unit name or ID (Crop → Seed Amount Unit)

type

integer / string

Seed quantity (potato only, send {} otherwise) (Crop → Seed Amount)

type

object

type

object

  • pesticides

Send an empty list [] if you have no pesticides

type

array

items

type

object

properties

  • applications

Number of applications (for seed treatment & post-emergence, 0 otherwise) (Inputs → Crop Protection → Applications (doses))

type

number

examples

1

minimum

0

  • category_id

Pesticide category (Inputs →Crop Protection → Category)

type

integer

examples

3

  • percentage_rate

% active ingredient (for soil treatment, 0 otherwise) (Inputs → Crop Protection → Active ingredient %)

type

integer / null

examples

100

maximum

100

minimum

0

default

100

  • application_rate

type

object

properties

  • value

Application rate (Inputs → Crop Protection → Application Rate)

type

number

examples

1

minimum

0

  • unit

Weight-per-area Unit name or ID (Inputs → Crop Protection → Application Rate)

type

integer / string

examples

kg / ha

type

object

type

object

Send an empty list [] if you have no pesticides

type

array

  • machinery

Send an empty list [] if you have no machinery use

type

array

items

Machinery fuel use estimates (custom fuel use not yet supported)

type

object

properties

  • operations

(Fuel & Energy → Field Operations → Number of Operations)

type

number

examples

1

minimum

0

  • machinery

Machine (provide this or machinery) (Fuel & Energy → Field Operations → Machine)

type

integer / string

examples

24

  • fuel_type

Direct energy type (Fuel & Energy → Field Operations → Fuel use)

type

integer / string

enum

102, 103, diesel, petrol

Machinery fuel use estimates (custom fuel use not yet supported)

type

object

Send an empty list [] if you have no machinery use

type

array

  • irrigation

Send an empty list [] if you have no irrigation

type

array

items

type

object

properties

  • method

Irrigation method (Irrigation → Irrigation Events → Method)

type

integer

examples

1

  • allocation

% of area irrigated (N/A)

type

number

examples

100

maximum

100

minimum

0

default

100

  • pumping

type

object

properties

  • value

(Irrigation → Irrigation Events → Pumping Depth Value)

type

number

examples

2

minimum

0

  • unit

Distance Unit name or ID (Irrigation → Irrigation Events → Pumping Depth Unit)

type

integer / string

examples

1

type

object

  • horizontal_distance

type

object

properties

  • value

(Irrigation → Irrigation Events → Horizontal Distance Value)

type

number

examples

200

minimum

0

  • unit

Distance Unit name or ID (Irrigation → Irrigation Events → Horizontal Distance Unit)

type

integer / string

examples

km

type

object

  • water_added

type

object

properties

  • value

(Irrigation → Irrigation Events → Water Added Value)

type

number

examples

0.1

minimum

0

  • unit

Length (depth) or volume Unit (Irrigation → Irrigation Events → Water Added Unit)

type

integer / string

examples

litre

type

object

  • power_source

Irrigation power source (Irrigation → Irrigation Events → Power Source)

type

integer / string

examples

1

type

object

Send an empty list [] if you have no irrigation

type

array

  • fertilisers

Send an empty list [] if you have no fertiliser applications

type

array

items

type

object

properties

  • type

Fertiliser type name or ID (Inputs → Fertiliser → Fertiliser Type)

type

integer / string

examples

Compose your own NPK

  • production

Fertiliser production database (Inputs → Fertiliser → Manufactured In). Note, no production emissions will be calculated for all digestates, slurries, manures and litter. However for these inputs a production type is required e.g. “World” for the API to be validated correctly.

type

integer / string

examples

Europe (2011)

  • application_rate

type

object

properties

  • value

Unit name or ID (Inputs → Fertiliser → Application Rate Value)

type

number

examples

1

minimum

0

  • unit

Unit name or ID (Inputs → Fertiliser → Application Rate Unit)

type

integer / string

type

object

  • custom_ingredients

Send this data only for ‘Compose your own N/P/K’ ({} otherwise); you cannot customise the ingredients of built-in fertiliser types

type

object

properties

  • n_total_percentage

Total of ammonia, urea and nitric percentages (Inputs → Fertiliser → %N)

type

number

examples

0

maximum

100

minimum

0

  • n_ammonia_percentage

(Inputs → Fertiliser → %N (as ammonium-N))

type

number

examples

0

maximum

100

minimum

0

  • n_nitric_percentage

(Inputs → Fertiliser → %N (as nitrate-N)

type

number

examples

0

maximum

100

minimum

0

  • n_urea_percentage

(Inputs → Fertiliser → %N (as Urea-N))

type

number

examples

0

maximum

100

minimum

0

  • p2o5_percentage

(Inputs → Fertiliser → %P2O5 or %P)

type

number

examples

0

maximum

100

minimum

0

  • p2o5_percentage_type_id

Fertiliser nutrient (Inputs → Fertiliser → %P2O5 or %P)

type

number

enum

4, 2

  • k2o_percentage

(Inputs → Fertiliser → %K2O or %K)

type

number

examples

0

maximum

100

minimum

0

  • k2o_percentage_type_id

Fertiliser nutrient (Inputs → Fertiliser → %K2O or %K)

type

number

enum

3, 5

examples

5

Send this data only for ‘Compose your own N/P/K’ ({} otherwise); you cannot customise the ingredients of built-in fertiliser types

type

object

  • rate_measure

A Fertiliser nutrient ingredient, or ‘’ / ‘product’ (Inputs → Fertiliser → Fertiliser Weight or Unit)

type

string

examples

product

  • method

Fertiliser method name or ID (Inputs → Fertiliser → Application Method)

type

integer / string

examples

2

  • inhibition_id

Fertiliser inhibition (Inputs → Fertiliser → Emissions Inhibitors)

type

integer

examples

1

type

object

Send an empty list [] if you have no fertiliser applications

type

array

  • direct_energy

Send an empty list [] if you have no direct energy use

type

array

items

type

object

properties

  • usage

type

object

properties

  • source

Direct energy type (Fuel & Energy → Direct Energy → Source)

type

integer / string

  • value

(Fuel & Energy → Direct Energy → Energy Used)

type

number

examples

4

minimum

0

  • category

Energy category ID (Fuel & Energy → Direct Energy → Category)

type

integer

  • unit

Unit name or ID (Fuel & Energy → Direct Energy → Energy Used Unit)

type

string / integer

type

object

type

object

Send an empty list [] if you have no direct energy use

type

array

  • land_management

Send an empty list [] if you have no management changes

type

array

items

type

object

properties

  • change_id

Management practice change (must be valid for current climate & soil moisture) (Carbon → (drop-downs))

type

integer

examples

13

  • years_ago

(Carbon → Years Ago) updated to accept changes considered at equilibrium

type

number

examples

1

maximum

99

minimum

0

  • allocation

% of field changed (Carbon → Percentage of Field)

type

number

examples

100

maximum

100

minimum

0

default

100

  • forest

forest data (only provide if your change is to or from forest, otherwise {})

type

object

properties

  • type

Forest type (Carbon → Forest Type)

type

integer / string

  • age_years

Forest age, in years (Carbon → Forest Age)

type

number

forest data (only provide if your change is to or from forest, otherwise {})

type

object

type

object

Send an empty list [] if you have no management changes

type

array

  • transport

Send an empty list [] if you have no transport

type

array

items

type

object

properties

  • mode

Transport type (Transport → Mode)

type

string / integer

examples

road LGV diesel (light goods vehicle <3.5t)

  • weight

type

object

properties

  • value

(Transport → Weight Value)

type

number

examples

4

minimum

0

  • unit

Unit name or ID (Transport → Weight Value)

type

string / number

examples

tonne

type

object

  • distance

type

object

properties

  • value

(Transport → Distance Value)

type

number

examples

2000

minimum

0

  • unit

Unit name or ID (Transport → Distance Value)

type

string / integer

examples

km

type

object

type

object

Send an empty list [] if you have no transport

type

array

  • tree_biomass

Send an empty list [] if you have no tree biomass

type

array

items

type

object

properties

  • tree_type

Tree type (Carbon → Out of Crop .. → Choose Tree Species)

type

integer / string

examples

5

  • density_last_year

type

object

properties

  • value

Unit name or ID (Carbon → Out of Crop .. → Density Last Year Value)

type

number

examples

100

minimum

0

  • unit

Unit name or ID (Carbon → Out of Crop .. → Density Last Year Unit)

type

string / number

examples

trees / hectare

type

object

  • size_last_year

type

object

properties

  • value

(Carbon → Out of Crop .. → Size Last Year Value)

type

number

examples

2000

minimum

0

  • unit

Unit name or ID (Carbon → Out of Crop .. → Size Last Year Unit)

type

string / integer

examples

cm

type

object

  • size_this_year

type

object

properties

  • value

(Carbon → Out of Crop .. → Size This Year Value)

type

number

examples

2000

minimum

0

  • unit

Unit name or ID (Carbon → Out of Crop .. → Size This Year Unit)

type

string / integer

examples

cm

type

object

  • num_trees_delta

type

object

properties

  • value

(Carbon → Out of Crop .. → Trees Planted / Lost Value)

type

number

examples

2000

-3

  • unit

Unit name or ID (Carbon → Out of Crop .. → Trees Planted / Lost Unit)

type

string / number

examples

trees / hectare

type

object

type

object

Send an empty list [] if you have no tree biomass

type

array

  • co_products

Send an empty list [] if you have no co-products

type

array

items

type

object

properties

  • name

string name (Product → CoProduct → name)

type

string

examples

test_co_product

  • percentage_main_value

int or float value (Product → CoProduct → percentage main value)

type

number

examples

50

minimum

0

type

object

Send an empty list [] if you have no co-products

type

array

  • processing

Send an empty list [] if you have no processing

type

array

items

type

object

properties

  • _type

Processing type name or ID (Processing → Type)

type

integer / string

examples

1

washing

  • allocation

int or float (Processing → Allocation .. → Number)

type

number

examples

100

  • power_source

Factor name or ID (Processing → Power Source .. → Selection of relevant power sources)

type

string / integer

examples

102

type

object

Send an empty list [] if you have no processing

type

array

  • storage

Send an empty list [] if you have no storage

type

array

items

type

object

properties

  • cipc_application

type

number

examples

1

  • cipc_dose

type

number

examples

1

  • storage_power_source

Factor name or ID (Storage → Power Source .. → Selection of relevant power sources)

type

integer / string

examples

106

  • store_loading_power_source

Factor name or ID (Storage → Power Source .. → Selection of relevant power sources)

type

integer / string

examples

102

  • unloading_power_source

Factor name or ID (Storage → Power Source .. → Selection of relevant power sources)

type

integer / string

examples

102

  • stored_allocation

int or float (Storage → Stored Allocation .. → Number)

type

number

examples

100

  • temperature

type

object

properties

  • unit

Unit name or ID (Temperature)

type

integer / string

examples

°C

  • value

type

number

examples

5

type

object

  • time

type

object

properties

  • unit

Unit name or ID (Storage time unit of measurement)

type

string / number

examples

second

  • value

type

number

examples

1

type

object

type

object

Send an empty list [] if you have no storage

type

array

type

object

definitions

$ jsonschema api/v1/schemas/dairy_product-calculate-input.json \
        -i api/v1/samples/dairy_product-calculate-input.json

Dairy “Calculate”

type

object

properties

  • farm

type

object

properties

  • country

Country name or ID (Farm Settings → Country)

type

integer / string

examples

Ghana

  • territory

Territory name or ID; send null if selected Country has no territories (Farm Settings → Territory)

type

integer / string / null

examples

Alabama

  • climate

Climate (Farm Settings → Climate)

type

integer / string

examples

temperate

  • average_temperature

type

object

properties

  • value

(Farm Settings → Average Annual Temperature Value)

type

number

  • unit

Temperature Unit name or ID (Farm Settings → Average Annual Temperature Unit)

type

string / number

examples

°C

type

object

  • farm_identifier

(Farm Settings → Farm Identifier)

type

string / number

type

object

  • general

type

object

properties

  • grazing_area

type

object

properties

  • value

(Grazing → Grassland Fertilisation → Grassland Area Value)

type

number

examples

12

  • unit

(Grazing → Grassland Fertilisation → Grassland Area Unit)

type

string / integer

examples

ha

type

object

  • feed_approach

(Feed)

type

string / integer

examples

average

type

object

  • milk_production

Basic information about your herd’s milk production.

type

object

properties

  • variety

Main breed. Note that if you have more than one breed you will need to select the most representative breed and adjust the default live weights to reflect your herd averages.

type

string

examples

Brown Swiss

  • reporting_year

Choose a relevant start year for your 12 month reference period (the end year will be set automatically).

type

integer

examples

2015

  • date_time

Choose the relevant start time for your start month (the end time will be set automatically).

type

string

examples

start

middle

end

  • date_month

Choose a relevant start month for your 12 month reference period (the end month will be set automatically).

type

integer

examples

1

2

12

  • name

Name of your assessment.

type

string

examples

test_api

  • product_dry

type

object

properties

  • value

type

number

examples

10

minimum

0

  • unit

type

integer / string

examples

tonne

type

object

  • fat_content

type

number

examples

3.9

  • protein_content

type

number

examples

3.8

  • protein_measure

True Protein Content or Crude Protein Content

type

integer

examples

1

2

Basic information about your herd’s milk production.

type

object

  • herd_sections

Send an empty list [] if you have no herd sections

type

array

items

anyOf

type

object

properties

  • phase

phase name (Inputs → Herd → Category)

type

string / integer

examples

Dairy calves

  • animals

animals count (Inputs → Herd → On-farm animals → Number)

type

integer

examples

33

  • live_weight

live_weight (Inputs → Herd → On-farm animals → Live Weight)

type

object

properties

  • value

type

integer

examples

152

  • unit

type

string / integer

examples

kg

live_weight (Inputs → Herd → On-farm animals → Live Weight)

type

object

  • sold_animals

sold_animals count (Inputs → Herd → Sold animals → Number)

type

integer

examples

0

  • sold_weight

sold_weight (Inputs → Herd → Sold animals → Live Weight)

type

object

properties

  • value

type

integer

examples

220

  • unit

type

string / integer

examples

kg

sold_weight (Inputs → Herd → Sold animals → Live Weight)

type

object

  • purchased_animals

purchased_animals count (Inputs → Herd → Purchased animals → Number)

type

integer

examples

0

  • purchased_weight

type

object

properties

  • value

purchased_weight_value count (Inputs → Herd → Purchased animals → Live Weight)

type

integer

examples

220

  • unit

Unit unit (Inputs → Herd → Live weight unit)

type

string / integer

examples

kg

type

object

type

object

Send an empty list [] if you have no herd sections

type

array

  • grazing

Send an empty list [] if you have no grazing sections

type

array

items

anyOf

type

object

properties

  • herd_section

herd_section name (Inputs → Grazing → Category)

type

string / integer

examples

Dairy calves

  • days

days number (Inputs → Grazing → Days)

type

integer

examples

208

  • hours

hours number (Inputs → Grazing → Hours/day)

type

integer

examples

12

  • category

category ID (Inputs → Grazing → Grazing type)

type

integer

examples

2

  • quality

quality ID (Inputs → Grazing → Grazing quality)

type

integer

examples

1

type

object

Send an empty list [] if you have no grazing sections

type

array

  • fertilisers

Send an empty list [] if you have no fertiliser applications

type

array

items

type

object

properties

  • type

Fertiliser type name or ID (Inputs → Fertiliser → Fertiliser Type)

type

integer / string

examples

Compose your own NPK

  • production

Fertiliser production database (Inputs → Fertiliser → Manufactured In). Note, no production emissions will be calculated for all digestates, slurries, manures and litter. However for these inputs a production type is required e.g. “World” for the API to be validated correctly.

type

integer / string

examples

Europe (2011)

  • application_rate

type

object

properties

  • value

Unit name or ID (Inputs → Fertiliser → Application Rate Value)

type

number

examples

1

minimum

0

  • unit

Unit name or ID (Inputs → Fertiliser → Application Rate Unit)

type

integer / string

type

object

  • custom_ingredients

Send this data only for ‘Compose your own N/P/K’ ({} otherwise); you cannot customise the ingredients of built-in fertiliser types

type

object

properties

  • n_total_percentage

Total of ammonia, urea and nitric percentages (Inputs → Fertiliser → %N)

type

number

examples

0

maximum

100

minimum

0

  • n_ammonia_percentage

(Inputs → Fertiliser → %N (as ammonium-N))

type

number

examples

0

maximum

100

minimum

0

  • n_nitric_percentage

(Inputs → Fertiliser → %N (as nitrate-N)

type

number

examples

0

maximum

100

minimum

0

  • n_urea_percentage

(Inputs → Fertiliser → %N (as Urea-N))

type

number

examples

0

maximum

100

minimum

0

  • p2o5_percentage

(Inputs → Fertiliser → %P2O5 or %P)

type

number

examples

0

maximum

100

minimum

0

  • p2o5_percentage_type_id

Fertiliser nutrient (Inputs → Fertiliser → %P2O5 or %P)

type

number

enum

4, 2

  • k2o_percentage

(Inputs → Fertiliser → %K2O or %K)

type

number

examples

0

maximum

100

minimum

0

  • k2o_percentage_type_id

Fertiliser nutrient (Inputs → Fertiliser → %K2O or %K)

type

number

enum

3, 5

examples

5

Send this data only for ‘Compose your own N/P/K’ ({} otherwise); you cannot customise the ingredients of built-in fertiliser types

type

object

  • rate_measure

A Fertiliser nutrient ingredient, or ‘’ / ‘product’ (Inputs → Fertiliser → Fertiliser Weight or Unit)

type

string

examples

product

type

object

Send an empty list [] if you have no fertiliser applications

type

array

  • feed_components

Send an empty list [] if you have no feed components sections

type

array

items

anyOf

type

object

properties

  • item

item name (Inputs → Feed → Feed component)

type

integer / string

examples

Straw

  • percentage

percentage name (Inputs → Feed → Percentage)

type

integer

examples

50

type

object

type

object

properties

  • type

Crop type (Crop → Crop Name)

type

integer / string

examples

Barley

  • product_dry

type

object

properties

  • value

Net product yield (Crop → Net Yield)

type

number

examples

10

minimum

0

  • unit

Weight Unit name or ID (Crop → Net Yield Unit)*

type

integer / string

examples

tonne

type

object

  • feed_type

Feed_components item type

type

integer / string

examples

Barley

  • emissions_total

type

object

properties

  • value

Emissions total calulated from crop_product/calculate endpoint

type

number

examples

10

minimum

0

  • unit

Emissions in kg CO2e Unit name or ID

type

integer / string

examples

kg CO2e

type

object

  • percentage

percentage name (Inputs → Feed → Percentage)

type

integer

examples

50

type

object

type

object

properties

  • item

item name (Inputs → Feed → Feed component)

type

integer / string

examples

Straw

  • herd_section

herd_section name (Inputs → Feed → Animal category)

type

integer / string

examples

Dairy calves

  • dry_matter

type

object

properties

  • value

(Feed → Dry Matter Value)

type

number

examples

4

minimum

0

  • unit

Unit name or ID (Feed → Dry Matter Value)

type

string / number

examples

tonne

type

object

type

object

type

object

properties

  • type

Crop type (Crop → Crop Name)

type

integer / string

examples

Barley

  • product_dry

type

object

properties

  • value

Net product yield (Crop → Net Yield)

type

number

examples

10

minimum

0

  • unit

Weight Unit name or ID (Crop → Net Yield Unit)*

type

integer / string

examples

tonne

type

object

  • feed_type

Feed_components item type

type

integer / string

examples

Barley

  • emissions_total

type

object

properties

  • value

Emissions total calulated from crop_product/calculate endpoint

type

number

examples

10

minimum

0

  • unit

Emissions in kg CO2e Unit name or ID

type

integer / string

examples

kg CO2e

type

object

  • herd_section

herd_section name (Inputs → Feed → Animal category)

type

integer / string

examples

Dairy calves

  • dry_matter

type

object

properties

  • value

(Feed → Dry Matter Value)

type

number

examples

4

minimum

0

  • unit

Unit name or ID (Feed → Dry Matter Value)

type

string / number

examples

tonne

type

object

type

object

Send an empty list [] if you have no feed components sections

type

array

  • manure

Send an empty list [] if you have no manure section

type

array

items

anyOf

type

object

properties

  • herd_section

herd_section name (Inputs → Manure → Animal category)

type

integer / string

examples

Dairy calves

  • type

type name (Inputs → Manure → Type)

type

integer / string

examples

Deep bedding - no mixing

  • allocation

allocation value (Inputs → Manure → Percentage)

type

integer

examples

70

type

object

Send an empty list [] if you have no manure section

type

array

  • direct_energy

Send an empty list [] if you have no direct energy use

type

array

items

type

object

properties

  • usage

type

object

properties

  • source

Direct energy type (Fuel & Energy → Direct Energy → Source)

type

integer / string

  • value

(Fuel & Energy → Direct Energy → Energy Used)

type

number

examples

4

minimum

0

  • category

Energy category ID (Fuel & Energy → Direct Energy → Category)

type

integer

  • unit

Unit name or ID (Fuel & Energy → Direct Energy → Energy Used Unit)

type

string / integer

type

object

type

object

Send an empty list [] if you have no direct energy use

type

array

  • transport

Send an empty list [] if you have no transport

type

array

items

type

object

properties

  • mode

Transport type (Transport → Mode)

type

string / integer

examples

road LGV diesel (light goods vehicle <3.5t)

  • weight

type

object

properties

  • value

(Transport → Weight Value)

type

number

examples

4

minimum

0

  • unit

Unit name or ID (Transport → Weight Value)

type

string / number

examples

tonne

type

object

  • distance

type

object

properties

  • value

(Transport → Distance Value)

type

number

examples

2000

minimum

0

  • unit

Unit name or ID (Transport → Distance Value)

type

string / integer

examples

km

type

object

type

object

Send an empty list [] if you have no transport

type

array

type

object

$ jsonschema api/v1/schemas/water_product-calculate-input.json \
        -i api/v1/samples/water_product-calculate-input.json

Water “Calculate”

type

object

properties

  • farm

type

object

properties

  • latitude

Farm’s latitude (Farm settings → Lat/lon)

type

number

  • longitude

Farm’s longitude (Farm settings → Lat/lon)

type

number

  • country

Country name or ID (Farm Settings → Country)

type

integer / string

examples

Ghana

  • territory

Territory name or ID; send null if selected Country has no territories (Farm Settings → Territory)

type

integer / string / null

examples

Alabama

  • climate

Climate (Farm Settings → Climate)

type

integer / string

examples

temperate

  • average_temperature

type

object

properties

  • value

(Farm Settings → Average Annual Temperature Value)

type

number

  • unit

Temperature Unit name or ID (Farm Settings → Average Annual Temperature Unit)

type

string / integer

examples

°C

type

object

  • farm_identifier

(Farm Settings → Farm Identifier)

type

string / number

type

object

  • crop

type

object

properties

  • type

Crop type (Crop → Crop Name)

type

integer / string

examples

Barley

  • field_size

type

object

properties

  • value

Growing area size value (Crop → Crop Area)

type

number

examples

100.35

minimum

0

  • unit

Growing area Unit name or ID (Crop → Crop Area Unit)

type

integer / string

examples

ha

type

object

  • product_fresh

type

object

properties

  • value

Fresh product yield (Crop → Harvested amount (total))

type

number

examples

10

minimum

0

  • unit

Weight, volume or unit Unit name or ID (Crop → Harvested amount(total) Unit)

type

integer / string

examples

tonne

type

object

  • product_dry

type

object

properties

  • value

Fresh product yield (Crop → Farm-gate ready amount)

type

number

examples

10

minimum

0

  • unit

Weight, volume or unit Unit name or ID (Crop → Farm/gate ready amount Unit)

type

integer / string

examples

tonne

type

object

  • reporting_year

Choose a relevant reporting year (Crop → Reporting year)

type

integer

minimum

1988

  • harvest_date

Choose a relevant harvest date (Crop → Harvest date)

type

object

properties

  • time

Choose the relevant start Month periods name or ID for the harvest date

type

string

examples

start

middle

end

  • month

Choose a relevant month for your harvest date

type

integer

examples

1

4

12

maximum

12

minimum

1

Choose a relevant harvest date (Crop → Harvest date)

type

object

  • planting_date

Choose a relevant planting date (Crop → Planting/sowing date)

type

object

properties

  • time

Choose the relevant start Month periods name or ID for the planting date

type

string

examples

start

middle

end

  • month

Choose a relevant month for your planting date

type

integer

examples

1

4

12

maximum

12

minimum

1

  • year

Choose a relevant year for your planting date

type

integer

examples

2015

Choose a relevant planting date (Crop → Planting/sowing date)

type

object

  • name

Name of your water assessment

type

string / number

examples

test_water_API

  • soil

type

object

properties

  • label

Fill in the name of the growing area

type

number / string

examples

Home parcel

  • type

Soil type name or ID (Soil → Soil type)

type

integer / string

examples

Barley

  • moisture_at_sowing

Soil moisture at sowing (Soil → Soil moisture at sowing)

type

string / integer

examples

dry

1

type

object

type

object

  • irrigation

Add irrigation information to your water assessments

type

object

properties

  • irri_start_date

Choose a relevant irrigation start date (Irrigation → Irrigation start)

type

object

properties

  • time

Choose the relevant start Month periods name or ID for the irrigation start date

type

string / integer

examples

start

middle

end

  • month

Choose a relevant month for your irrigation start date

type

integer

examples

1

4

12

maximum

12

minimum

1

  • year

Choose a relevant year for your irrigation start date

type

integer

examples

2015

Choose a relevant irrigation start date (Irrigation → Irrigation start)

type

object

  • irri_end_date

Choose a relevant irrigation end date (Irrigation → Irrigation end)

type

object

properties

  • time

Choose the relevant start Month periods name or ID for the irrigation end date

type

string / integer

examples

start

middle

end

  • month

Choose a relevant month for your irrigation end date

type

integer

examples

1

4

12

maximum

12

minimum

1

  • year

Choose a relevant year for your irrigation end date

type

integer

examples

2015

Choose a relevant irrigation end date (Irrigation → Irrigation end)

type

object

  • method

Irrigation method name or ID (Irrigation → Method)

type

integer / string

  • water_source

Irrigation water source name or ID (Irrigation → Water source)

type

string / integer

examples

1

on_farm

  • irrigation_events

Send empty [] if no irrigation events

type

array

items

anyOf

type

object

properties

  • water_added

type

object

properties

  • value

Total water added per irrigation event (Irrigation → Total water added)

type

number

examples

13600

minimum

0

  • unit

Water added Unit name or ID (Irrigation → Total water added Unit)

type

integer / string

examples

litre

type

object

  • water_source

Irrigation water source name or ID (Irrigation events → If ‘has_source_pump’ is false set a custom water source for each irrigation events item)

type

string / integer

examples

1

on_farm

  • allocation

Percentage of area irrigated (Irrigation → Area irrigated)

type

number

examples

100

65.5

  • has_source_pump

Use source and pump defaults

type

boolean

type

object

Send empty [] if no irrigation events

type

array

Add irrigation information to your water assessments

type

object

type

object