Crop-DIG
A Crop Dig Web API
token
create
Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
email required | |
password required |
refresh > create
Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
refresh required |
v1
accounts > login > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
phone_number required | |
username | |
email | |
password required |
accounts > logout > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
accounts > password > change > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
old_password required | |
password1 required | |
password2 required |
accounts > password > reset > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
email | |
password1 required | |
password2 required | |
token required | |
phone_number |
accounts > password > reset > request > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
email | |
phone_number |
accounts > profile > update
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name required | Enter your first name. |
last_name required | Enter your last name. |
email required | Enter an email address. |
phone_number required | |
profile_photo | |
last_login |
accounts > profile > partial_update
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | Enter your first name. |
last_name | Enter your last name. |
email | Enter an email address. |
phone_number | |
profile_photo | |
last_login |
accounts > register > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name required | |
last_name required | |
phone_number required | |
email required | |
password1 required | |
password2 required |
accounts > token > create
Takes a set of user credentials and returns an access and refresh JSON web token pair to prove the authentication of those credentials.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
email required | |
password required |
accounts > token > refresh > create
Takes a refresh type JSON web token and returns an access type JSON web token if the refresh token is valid.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
refresh required |
accounts > token > verify > create
Takes a token and indicates if it is valid. This view provides no information about a token's fitness for a particular use.
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
token required |
accounts > users > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
accounts > users > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name required | Enter your first name. |
last_name required | Enter your last name. |
email required | Enter an email address. |
phone_number required | |
profile_photo | |
last_login |
accounts > users > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this User. |
accounts > users > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this User. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name required | Enter your first name. |
last_name required | Enter your last name. |
email required | Enter an email address. |
phone_number required | |
profile_photo | |
last_login |
accounts > users > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this User. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | Enter your first name. |
last_name | Enter your last name. |
email | Enter an email address. |
phone_number | |
profile_photo | |
last_login |
accounts > users > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this User. |
available > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
classify > action > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Third Diagnosis Report. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pests | |
pest_count | |
affected_part | |
nutrient_deficiency | |
growth_stage | |
action_required | |
metadata | |
owner |
classify > action > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Third Diagnosis Report. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pests | |
pest_count | |
affected_part | |
nutrient_deficiency | |
growth_stage | |
action_required | |
metadata | |
owner |
classify > image > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
classify > image > create
Request Body
The request body should be a "multipart/form-data" encoded object, containing the following items.
| Parameter | Description |
|---|---|
classified_image required | |
classification_class | |
farm required | |
metadata | |
owner |
classify > image > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Third Diagnosis Classification. |
classify > image > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Third Diagnosis Classification. |
Request Body
The request body should be a "multipart/form-data" encoded object, containing the following items.
| Parameter | Description |
|---|---|
classified_image required | |
classification_class | |
farm required | |
metadata | |
owner |
classify > image > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Third Diagnosis Classification. |
Request Body
The request body should be a "multipart/form-data" encoded object, containing the following items.
| Parameter | Description |
|---|---|
classified_image | |
classification_class | |
farm | |
metadata | |
owner |
classify > image > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Third Diagnosis Classification. |
classify > info > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
classify > info > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pests | |
pest_count | |
affected_part | |
nutrient_deficiency | |
disease | |
growth_stage | |
action_required | |
metadata | |
identified_issue required | |
owner |
classify > info > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Third Diagnosis Report. |
classify > info > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Third Diagnosis Report. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pests | |
pest_count | |
affected_part | |
nutrient_deficiency | |
disease | |
growth_stage | |
action_required | |
metadata | |
identified_issue required | |
owner |
classify > info > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Third Diagnosis Report. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
pests | |
pest_count | |
affected_part | |
nutrient_deficiency | |
disease | |
growth_stage | |
action_required | |
metadata | |
identified_issue | |
owner |
classify > info > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Third Diagnosis Report. |
classify > pest > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
pest_name | |
scientific_name | |
category | |
destructive_stage_of_pest |
classify > pest > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
is_archived | |
metadata | |
category required | |
pest_name required | |
scientific_name required | |
description required | |
pest_prevalence_climatic_conditions required | |
destructive_stage_of_pest required | |
action_threshold | |
action_threshold_unit_plant required | |
cultural_control required | |
biological_control required | |
mechanical_control required | |
chemical_control_ai required | |
crop_vulnerability_stage required |
classify > pest > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Pest. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
pest_name | |
scientific_name | |
category | |
destructive_stage_of_pest |
classify > pest > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Pest. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
pest_name | |
scientific_name | |
category | |
destructive_stage_of_pest |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
is_archived | |
metadata | |
category required | |
pest_name required | |
scientific_name required | |
description required | |
pest_prevalence_climatic_conditions required | |
destructive_stage_of_pest required | |
action_threshold | |
action_threshold_unit_plant required | |
cultural_control required | |
biological_control required | |
mechanical_control required | |
chemical_control_ai required | |
crop_vulnerability_stage required |
classify > pest > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Pest. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
pest_name | |
scientific_name | |
category | |
destructive_stage_of_pest |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
is_archived | |
metadata | |
category | |
pest_name | |
scientific_name | |
description | |
pest_prevalence_climatic_conditions | |
destructive_stage_of_pest | |
action_threshold | |
action_threshold_unit_plant | |
cultural_control | |
biological_control | |
mechanical_control | |
chemical_control_ai | |
crop_vulnerability_stage |
classify > pest > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Pest. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
pest_name | |
scientific_name | |
category | |
destructive_stage_of_pest |
classify > upload > disease > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required |
county > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
county_name | |
county_number |
county > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
county_num required |
county > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this County. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
county_name | |
county_number |
county > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this County. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
county_name | |
county_number |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
county_num required |
county > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this County. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
county_name | |
county_number |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name | |
county_num |
county > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this County. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
county_name | |
county_number |
crop > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
crop_type | |
crop_variety |
crop > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
crop_type required | |
crop_variety required | |
maturity_in_days required | |
estimated_yield_90kg_bag required | |
zone | |
suitable_region required | |
altitude_meters_above_sea_level required | |
annual_rainfall_millimeters required | |
row_spacing_cm required | |
plant_spacing_2_plants_per_hill required | |
plant_spacing_1_plant_per_hill | |
crop_drought_tolerance_temperature_degrees_celsius | |
diseases_and_pest_prevalence |
crop > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Crop Variety. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
crop_type | |
crop_variety |
crop > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Crop Variety. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
crop_type | |
crop_variety |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
crop_type required | |
crop_variety required | |
maturity_in_days required | |
estimated_yield_90kg_bag required | |
zone | |
suitable_region required | |
altitude_meters_above_sea_level required | |
annual_rainfall_millimeters required | |
row_spacing_cm required | |
plant_spacing_2_plants_per_hill required | |
plant_spacing_1_plant_per_hill | |
crop_drought_tolerance_temperature_degrees_celsius | |
diseases_and_pest_prevalence |
crop > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Crop Variety. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
crop_type | |
crop_variety |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
crop_type | |
crop_variety | |
maturity_in_days | |
estimated_yield_90kg_bag | |
zone | |
suitable_region | |
altitude_meters_above_sea_level | |
annual_rainfall_millimeters | |
row_spacing_cm | |
plant_spacing_2_plants_per_hill | |
plant_spacing_1_plant_per_hill | |
crop_drought_tolerance_temperature_degrees_celsius | |
diseases_and_pest_prevalence |
crop > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Crop Variety. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
crop_type | |
crop_variety |
diagnosis > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
farm | |
farmer_first_name | |
farmer_last_name |
diagnosis > image > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
farm |
farm > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
ward | |
subcounty | |
farmer_last_name | |
farmer_first_name | |
farmer_name | |
farmer_mobile_number |
farm > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
ward required | |
farm_boundary required | |
farm_area_acres | |
farmer required | |
owner |
farm > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Farm. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
ward | |
subcounty | |
farmer_last_name | |
farmer_first_name | |
farmer_name | |
farmer_mobile_number |
farm > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Farm. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
ward | |
subcounty | |
farmer_last_name | |
farmer_first_name | |
farmer_name | |
farmer_mobile_number |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
ward required | |
farm_boundary required | |
farm_area_acres | |
farmer required | |
owner |
farm > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Farm. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
ward | |
subcounty | |
farmer_last_name | |
farmer_first_name | |
farmer_name | |
farmer_mobile_number |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
ward | |
farm_boundary | |
farm_area_acres | |
farmer | |
owner |
farm > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Farm. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
ward | |
subcounty | |
farmer_last_name | |
farmer_first_name | |
farmer_name | |
farmer_mobile_number |
farm > summary > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
farmer > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
farmer > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name required | |
second_name | |
last_name required | |
gender required | |
mobile_number required | |
ward required | |
owner |
farmer > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Farmer. |
farmer > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Farmer. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name required | |
second_name | |
last_name required | |
gender required | |
mobile_number required | |
ward required | |
owner |
farmer > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Farmer. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
first_name | |
second_name | |
last_name | |
gender | |
mobile_number | |
ward | |
owner |
farmer > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Farmer. |
fertilizer > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
fertilizer_name | |
manufacturer |
fertilizer > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
fertilizer_name required | |
packaging_kg required | |
manufacturer required | |
use required | |
nitrogen_concetration required | |
phosphorus_concetration required | |
potassium_concetration required | |
magnesium_concetration | |
calcium_concetration | |
sulphur_concetration | |
organic_matter_concetration | |
trace_elements_concetration | |
type_one required | |
type_two required | |
target_crop required |
fertilizer > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Fertilizer. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
fertilizer_name | |
manufacturer |
fertilizer > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Fertilizer. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
fertilizer_name | |
manufacturer |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
fertilizer_name required | |
packaging_kg required | |
manufacturer required | |
use required | |
nitrogen_concetration required | |
phosphorus_concetration required | |
potassium_concetration required | |
magnesium_concetration | |
calcium_concetration | |
sulphur_concetration | |
organic_matter_concetration | |
trace_elements_concetration | |
type_one required | |
type_two required | |
target_crop required |
fertilizer > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Fertilizer. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
fertilizer_name | |
manufacturer |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
fertilizer_name | |
packaging_kg | |
manufacturer | |
use | |
nitrogen_concetration | |
phosphorus_concetration | |
potassium_concetration | |
magnesium_concetration | |
calcium_concetration | |
sulphur_concetration | |
organic_matter_concetration | |
trace_elements_concetration | |
type_one | |
type_two | |
target_crop |
fertilizer > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Fertilizer. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
fertilizer_name | |
manufacturer |
firstdiagnosis > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
fly > diagnosis > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
fly > diagnosis > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
farm required | |
start_date required | |
end_date required |
fly > diagnosis > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Second Diagnosis GeoTiff. |
fly > diagnosis > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Second Diagnosis GeoTiff. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
farm required | |
start_date required | |
end_date required |
fly > diagnosis > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Second Diagnosis GeoTiff. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
farm | |
start_date | |
end_date |
fly > diagnosis > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Second Diagnosis GeoTiff. |
nutrient > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
fertilizer_name | |
manufacturer | |
subcounty_name |
nutrient > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
subcounty required | |
fertilizer required | |
recommended_manure_per_acre_kg | |
fertilizer_application_rate_per_acre_kg required | |
dolomite_lime_kg | |
lime_application_rate_per_50_kg_bag | |
lime_application_time | |
recommended_number_of_50kg_bags_per_acre required | |
nitrogen_intake_kg_per_acre | |
phosphorus_intake_kg_per_acre | |
potassium_intake_kg_per_acre |
nutrient > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Recommmended Nutrient. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
fertilizer_name | |
manufacturer | |
subcounty_name |
nutrient > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Recommmended Nutrient. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
fertilizer_name | |
manufacturer | |
subcounty_name |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
subcounty required | |
fertilizer required | |
recommended_manure_per_acre_kg | |
fertilizer_application_rate_per_acre_kg required | |
dolomite_lime_kg | |
lime_application_rate_per_50_kg_bag | |
lime_application_time | |
recommended_number_of_50kg_bags_per_acre required | |
nitrogen_intake_kg_per_acre | |
phosphorus_intake_kg_per_acre | |
potassium_intake_kg_per_acre |
nutrient > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Recommmended Nutrient. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
fertilizer_name | |
manufacturer | |
subcounty_name |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
subcounty | |
fertilizer | |
recommended_manure_per_acre_kg | |
fertilizer_application_rate_per_acre_kg | |
dolomite_lime_kg | |
lime_application_rate_per_50_kg_bag | |
lime_application_time | |
recommended_number_of_50kg_bags_per_acre | |
nitrogen_intake_kg_per_acre | |
phosphorus_intake_kg_per_acre | |
potassium_intake_kg_per_acre |
nutrient > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Recommmended Nutrient. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
fertilizer_name | |
manufacturer | |
subcounty_name |
pest > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
pest_name | |
scientific_name | |
category | |
destructive_stage_of_pest |
pest > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
is_archived | |
metadata | |
category required | |
pest_name required | |
scientific_name required | |
description required | |
pest_prevalence_climatic_conditions required | |
destructive_stage_of_pest required | |
action_threshold | |
action_threshold_unit_plant required | |
cultural_control required | |
biological_control required | |
mechanical_control required | |
chemical_control_ai required | |
crop_vulnerability_stage required |
pest > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Pest. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
pest_name | |
scientific_name | |
category | |
destructive_stage_of_pest |
pest > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Pest. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
pest_name | |
scientific_name | |
category | |
destructive_stage_of_pest |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
is_archived | |
metadata | |
category required | |
pest_name required | |
scientific_name required | |
description required | |
pest_prevalence_climatic_conditions required | |
destructive_stage_of_pest required | |
action_threshold | |
action_threshold_unit_plant required | |
cultural_control required | |
biological_control required | |
mechanical_control required | |
chemical_control_ai required | |
crop_vulnerability_stage required |
pest > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Pest. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
pest_name | |
scientific_name | |
category | |
destructive_stage_of_pest |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
is_archived | |
metadata | |
category | |
pest_name | |
scientific_name | |
description | |
pest_prevalence_climatic_conditions | |
destructive_stage_of_pest | |
action_threshold | |
action_threshold_unit_plant | |
cultural_control | |
biological_control | |
mechanical_control | |
chemical_control_ai | |
crop_vulnerability_stage |
pest > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Pest. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
pest_name | |
scientific_name | |
category | |
destructive_stage_of_pest |
pesticide > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
pesticide > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
chemical_name required | |
formulation required | |
formulation_abbreviation required | |
pcpb_cr_pest_control_products_for_use_in_crop_production required | |
manufacturer required | |
company_source required | |
packaging required | |
ai required | |
ai_amount required | |
ai_unit required | |
application_rate_as_a_ratio_of_active_ingredients_mrl required | |
application_rate_maximum_residue_limit_mrl_units | |
target_crop required | |
farms_application_rate required | |
application_rate_units required | |
phi_preharvest_interval_waiting_period_before_harvesting_days required | |
rei_restricted_entry_interval_in_hours required | |
who_class required | |
colour_b required | |
classification_description required | |
target_disease_or_pest | |
target_pest_classification required | |
application_mode required | |
action_mode | |
chemical_class required | |
disclaimer | |
additional_information |
pesticide > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Pesticide. |
pesticide > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Pesticide. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
chemical_name required | |
formulation required | |
formulation_abbreviation required | |
pcpb_cr_pest_control_products_for_use_in_crop_production required | |
manufacturer required | |
company_source required | |
packaging required | |
ai required | |
ai_amount required | |
ai_unit required | |
application_rate_as_a_ratio_of_active_ingredients_mrl required | |
application_rate_maximum_residue_limit_mrl_units | |
target_crop required | |
farms_application_rate required | |
application_rate_units required | |
phi_preharvest_interval_waiting_period_before_harvesting_days required | |
rei_restricted_entry_interval_in_hours required | |
who_class required | |
colour_b required | |
classification_description required | |
target_disease_or_pest | |
target_pest_classification required | |
application_mode required | |
action_mode | |
chemical_class required | |
disclaimer | |
additional_information |
pesticide > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Pesticide. |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
chemical_name | |
formulation | |
formulation_abbreviation | |
pcpb_cr_pest_control_products_for_use_in_crop_production | |
manufacturer | |
company_source | |
packaging | |
ai | |
ai_amount | |
ai_unit | |
application_rate_as_a_ratio_of_active_ingredients_mrl | |
application_rate_maximum_residue_limit_mrl_units | |
target_crop | |
farms_application_rate | |
application_rate_units | |
phi_preharvest_interval_waiting_period_before_harvesting_days | |
rei_restricted_entry_interval_in_hours | |
who_class | |
colour_b | |
classification_description | |
target_disease_or_pest | |
target_pest_classification | |
application_mode | |
action_mode | |
chemical_class | |
disclaimer | |
additional_information |
pesticide > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Pesticide. |
plantinginfo > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
farm | |
crop | |
farmer_first_name | |
farmer_last_name | |
crop_variety | |
crop_type |
plantinginfo > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
farm required | |
rainfall_onset required | |
planting_date required | |
crop required | |
row_spacing required | |
hill_spacing required | |
previous_planting_info | |
planting_fertilizer_info | |
topdressing_fertilizer_info | |
previous_yield_mam required | |
previous_yield_ond required | |
previous_crop_type | |
previous_crop_variety | |
planting_fertilizer required | |
planting_fertilizer_bags required | |
top_dressing_fertilizer | |
top_dressing_fertilizer_bags | |
weeding | |
owner |
plantinginfo > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Farm Planting Info. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
farm | |
crop | |
farmer_first_name | |
farmer_last_name | |
crop_variety | |
crop_type |
plantinginfo > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Farm Planting Info. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
farm | |
crop | |
farmer_first_name | |
farmer_last_name | |
crop_variety | |
crop_type |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
farm required | |
rainfall_onset required | |
planting_date required | |
crop required | |
row_spacing required | |
hill_spacing required | |
previous_planting_info | |
planting_fertilizer_info | |
topdressing_fertilizer_info | |
previous_yield_mam required | |
previous_yield_ond required | |
previous_crop_type | |
previous_crop_variety | |
planting_fertilizer required | |
planting_fertilizer_bags required | |
top_dressing_fertilizer | |
top_dressing_fertilizer_bags | |
weeding | |
owner |
plantinginfo > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Farm Planting Info. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
farm | |
crop | |
farmer_first_name | |
farmer_last_name | |
crop_variety | |
crop_type |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
farm | |
rainfall_onset | |
planting_date | |
crop | |
row_spacing | |
hill_spacing | |
previous_planting_info | |
planting_fertilizer_info | |
topdressing_fertilizer_info | |
previous_yield_mam | |
previous_yield_ond | |
previous_crop_type | |
previous_crop_variety | |
planting_fertilizer | |
planting_fertilizer_bags | |
top_dressing_fertilizer | |
top_dressing_fertilizer_bags | |
weeding | |
owner |
plantinginfo > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Farm Planting Info. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
farm | |
crop | |
farmer_first_name | |
farmer_last_name | |
crop_variety | |
crop_type |
subcounty > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
subcounty_name | |
county_name |
subcounty > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
county required |
subcounty > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this SubCounty. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
subcounty_name | |
county_name |
subcounty > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this SubCounty. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
subcounty_name | |
county_name |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
county required |
subcounty > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this SubCounty. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
subcounty_name | |
county_name |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name | |
county |
subcounty > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this SubCounty. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
subcounty_name | |
county_name |
upload > county > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required |
upload > crop > variety > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required |
upload > diagnosis > class > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required |
upload > farm > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
import_file required |
upload > farmer > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required | |
owner_id required |
upload > fertilizer > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required |
upload > nutrient > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required |
upload > pest > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required |
upload > pesticide > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required |
upload > recommended > fert > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required |
upload > subcounty > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required |
upload > ward > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
file required |
ward > list
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
limit | Number of results to return per page. |
offset | The initial index from which to return the results. |
id | |
ward_name | |
subcounty_name | |
county_name | |
county_number |
ward > create
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
subcounty required |
ward > read
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Ward. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
ward_name | |
subcounty_name | |
county_name | |
county_number |
ward > update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Ward. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
ward_name | |
subcounty_name | |
county_name | |
county_number |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name required | |
subcounty required |
ward > partial_update
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Ward. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
ward_name | |
subcounty_name | |
county_name | |
county_number |
Request Body
The request body should be a "application/json" encoded object, containing the following items.
| Parameter | Description |
|---|---|
name | |
subcounty |
ward > delete
Path Parameters
The following parameters should be included in the URL path.
| Parameter | Description |
|---|---|
id required | A UUID string identifying this Ward. |
Query Parameters
The following parameters should be included as part of a URL query string.
| Parameter | Description |
|---|---|
id | |
ward_name | |
subcounty_name | |
county_name | |
county_number |