Farms
This model represents a farm entity with its basic information, features, statistics, and production targets. The structure allows for both basic farm management and advanced features like production tracking and area calculations.
Both Farms and Organizations follow the same structure. They are in reality both Organizations.
Farm Object
| Field | Value Example | Type | Description | How it Can Be Used |
|---|---|---|---|---|
| id | "2b289a5a-62d2-40a8-8d8f-0b63951a863d" | String (UUID) | Unique identifier for the farm | Reference specific farms |
| name | "Ohta Farm" | String | Farm name | Display and identification |
| null | String | null | Contact email | Communication and notifications | |
| address | "" | String | Physical address | Location and shipping info |
| phone | "+819056043283" | String | Contact number with country code | Communication and SMS notifications |
| description | null | String | null | Farm description | Additional information |
| slug | "black-flower-9" | String | URL-friendly identifier | URL routing and friendly links |
| preview_uri | "https://maps.googleapis.com/maps/api/staticmap?..." | String | Google Maps static image URL | Visual map preview |
| created_at | "2022-01-12T02:12:32Z" | String (ISO 8601) | Creation timestamp | Audit trail |
| updated_at | "2022-12-25T04:32:32Z" | String (ISO 8601) | Last update timestamp | Track modifications |
| location | { type: "Point", coordinates: [...] } | Object | Geographic location information | Spatial data management |
| location.type | "Point" | String | GeoJSON type | Spatial data formatting |
| location.coordinates | [101.496012131774, 14.5184707338978] | Array[Number] | [longitude, latitude] | Geolocation and mapping |
| features | { production_graphs: true } | Object | Feature flags for the farm | Feature management |
| features.production_graphs | true | Boolean | Enable/disable production graphs | Feature flag management |
| production_targets | {} | Object | Production goals and targets | Planning and goal setting |
Location Object
| Field | Value Example | Type | Description | How it Can Be Used |
|---|---|---|---|---|
| type | "Point" | String | GeoJSON type | Spatial data formatting |
| coordinates | [101.496012131774, 14.5184707338978] | Array[Number] | [longitude, latitude] | Geolocation and mapping |
Features Object
| Field | Value Example | Type | Description | How it Can Be Used |
|---|---|---|---|---|
| production_graphs | true | Boolean | Enable/disable production graphs | Feature flag management |
Production Targets Object
| Field | Value Example | Type | Description | How it Can Be Used |
|---|---|---|---|---|
| prod_targets | {} | Object | Production goals and targets | Planning and goal setting |
📄️ Create a new farm
Create a new farm for your user. You must have an API token with the `organizations:write` scope (farms are organizations).
📄️ Get the list of farms
Get list of Farms associated to current token owner. You must have an API token with the `organizations:read` scope (farms are organizations).
📄️ farm info
Get farm info
📄️ Create a new farm in Organization
Create Farms. You must have an API token with the `organizations:write` scope.
📄️ Get farms of an Organization
Get the farms of an Organization