Guidance to support users of the Integration API, to access Soil Sampling data. For a broader overview of how to unlock and access the Integration API, please see this guidance here.
For technical guidance for using the API (including authentication, pagination, and endpoints), see here.
When calling the soil sampling data from your Land App organisation, you with need a Land App API Key "$(API)", and to use the Plan template key SOIL_SURVEY "$(Plan_type)".
Example Requests
Request 1: Example request for Plans:
(call all plans that are Soil Sampling within your organisation)
https://integration-api.thelandapp.com/projects?apiKey=$(API)&page=0&size=1000&type=$(Plan_type)&from=2020-01-01T06:00:00.000Z&excludeArchived=true
Example response:
{
"updatedAt": "2024-09-27T12:00:07.607Z",
"id": "66f69123456789ccf851b23c",
"name": "Soil test - sep 2024",
"map": "63469a1d765ffc0017a6abc3",
"mapName": "Test - Tim Soil Data",
"createdBy": "Dan Geerah",
"createdAt": "2024-09-27T11:59:17.367Z",
"updatedBy": "Dan Geerah"
}
Request 2: Example request for Feature, using Plan ID from above:
(call all features within the identified plans that are Soil Sampling within your organisation)
PROJECT_ID = "66f69123456789ccf851b23c" & "66f9876543217015a0536a44"
http://integration-api.thelandapp.com/projects/66f69123456789ccf851b23c/features
Example responses from Soil Sample Template.
Lab Samples (laFeatureType = "LS")
{
"id": "66f69123456789ccf851b23c",
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
357525.70998991356,
173016.8092649852
]
},
"properties": {
"laFeatureType": "LS",
"name": "1",
"description": "2",
"laSoil10": 54,
"laSoil30": 2,
"laSoil50": 45,
"laBulk10": 2,
"laBulk30": 5,
"laBulk50": 3,
"laSoilCarb10": 54,
"laSoilCarb30": 8,
"laPhosConc": 2,
"laSoilCarb50": 5,
"laPotasConc": 2,
"laPhosIndex": "3",
"laMagnesIndex": "2",
"laPH": 7.4
}
}
Field Samples (laFeatureType = "FS")
{
"id": "66f9876543217015a0536a44",
"type": "Feature",
"geometry": {
"type": "Point",
"coordinates": [
357526.6210033405,
173044.94132452563
]
},
"properties": {
"laFeatureType": "FS",
"laVisualTop": "3 - Firm",
"laVisualBot": "2 - Intact",
"laWormsNo": 2,
"laStab5min": "2 - soil breaks up into angular pieces",
"laStab120min": "1 - soil crumbles around the edges"
}
}
Feature descriptions within the response body
Data Structure on Soil Sampling Template:
Feature type | Description |
Lab sample | Record lab results for a soil sample. At least 1 sample recommended per field. Available measurements include soil organic matter, bulk density, soil organic carbon, pH, and phosphorus, potassium & magnesium content. |
In-field sample | Record measurements taken in the field for a soil sample. 3 samples recommended per field. Available measurements include visual evaluation of soil structure top & bottom (VESS), number of worms, and aggregate stability after 5 & 120 mins. |
Lab Sample Attributes:
Attribute | Attribute description | Type |
"laSoil10" | Soil organic matter for 0-10cm depth (%) | Decimal |
"laSoil30" | Soil organic matter for 10-30cm depth (%) | Decimal |
"laSoil50" | Soil organic matter for 30-50cm depth (%) | Decimal |
"laBulk10" | Bulk density for 0-10cm depth (g/cm³) | Decimal |
"laBulk30" | Bulk density for 10-30cm depth (g/cm³) | Decimal |
"laBulk50" | Bulk density for 30-50cm depth (g/cm³) | Decimal |
"laSoilCarb10" | Soil organic carbon for 0-10cm depth (tonnes/ha) | Decimal |
"laSoilCarb30" | Soil organic carbon for 10-30cm depth (tonnes/ha) | Decimal |
"laSoilCarb50" | Soil organic carbon for 30-50cm depth (tonnes/ha) | Decimal |
"laPhosConc" | Phosphorus concentration (mg/l) | Integer |
"laPotasConc" | Potassium concentration (mg/l) | Integer |
"laMagnesConc" | Magnesium concentration (mg/l) | Integer |
"laPhosIndex" | Phosphorus index | Single-select: 0, 1, 2, 3, 4, 5 |
"laPotasIndex" | Potassium index | Text |
"laMagnesIndex" | Magnesium index | Single-select: 0, 1, 2, 3, 4, 5 |
"laPH": 7.4 | pH | Decimal |
Field Sample Attributes:
Attribute | Attribute description | Type |
"laVisualTop" | Visual inspection of soil structure top | Single-select: |
"laVisualBot" | Visual inspection of soil structure bottom | Single-select: |
"laWormsNo" | Number of worms | Integer |
"laStab5min" | Aggregate stability after 5 minutes | Single-select: |
"laStab120min" | Aggregate stability after 120 minutes | Single-select: |
Acknowledgements
We are grateful for the partnership work with Farm Carbon Toolkit in supporting this development.
