Skip to content

Farm Data

The following data structures are published by the platform. If you want to learn how to retrieve entities published by the platform, please refer section "Accessing Platform Data" in our introduction to the topic.

Entity Farm

 `/api/v1.0/{orgId}/FarmOrgEntities/{moduleId}/{dataAreaEntityId}`
  • orgId represents the organization you want data from; in most cases it's the current organization
  • moduleId represents the ID of the module requesting the data; in most cases it's your module ID
  • dataAreaEntityId represent the ID of the entity you want to access; the user must have given consent ot the data area "Farm Organization Definition" for this call to be successful. (See Data Areas and Entities for details)
const { data: farms } = useEntity("FarmOrganization", "farms");

useEffect(() => {
    if(farms) console.log("farms", farms);
}, [farms]);

JSON Format

{
    "organizationId": "606e598c-a6d8-4904-8536-03f10c646cd1",
    "farmName": "Tomatofarm",
    "description": null,
    "location": null,
    "latitude": 0,
    "longitude": 0,
    "addressId": "9c55e5a6-e7d5-4c13-97af-abcdef123456",
    "primaryContactId": "327ee08d-d1e1-4d99-9ce3-abcdef123456",
    "secondaryContactId": "00000000-0000-0000-0000-000000000000",
    "address": {
        "addressLine1": "AV MADERO NTE NO. 1000, SAN JOSE, 59663",
        "addressLine2": "SAN JOSE, 59663",
        "addressLine3": null,
        "directions": "Turn right after the bridge, entry is on your left.",
        "city": "Michoacan",
        "postalCode": "59663",
        "state": "Zamora",
        "countryId": "fd45d528-dfde-420e-9554-8dd02897a084",
        "longitude": 19.1234,
        "latitude": 49.12345,
        "id": "ea767d7e-d2d8-4948-89f5-abcdef123456"
    },
    "id": "85da51ae-a97b-4546-8b38-abcdef123456"
}

Properties

Property Type Description
organizationId String ID of the organization the farm is associated with
farmName String Display name of the field
description String Description of the farm
location GeoJSON Currently unused
latitude Float Location info of the farm
longitude Float Location info of the farm
addressId UUID ID of the address block
primaryContactId UUID ID of the user who serving as the farms's contact person
secondaryContactId UUID ID of the user who serving as the farms's primary contact person's backup
address.addressLine1 String Line 1 of the address record
address.addressLine2 String Line 2 of the address record
address.addressLine3 String Line 3 of the address record
address.directions String Can be used to provide detailed instructions of the farm is hard to locate
address.city String The city the farm is located in
address.postalCode String ZIP code of the farm
address.state String State or province the farm operates in
address.countryId UUID ID of the country the farm operates in (see CommonData API for details)
address.longitude Float Location info of the farm
address.latitude Float Location info of the farm
address.id UUID ID of this address record (identical to addressId)
id String ID of the current field