Create Farmer Endpoint - Trace Knowledge Center

cURL

curl --request POST \
  --url http://localhost:3000/connect/v1/supply-chains/farmers/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "id": "<string>",
  "phone": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "house_name": "<string>",
  "street": "<string>",
  "city": "<string>",
  "sub_province": "<string>",
  "province": "<string>",
  "latitude": 123,
  "longitude": 123,
  "zipcode": "<string>",
  "country": "<string>",
  "number": "<string>",
  "email": "jsmith@example.com",
  "identification_no": "<string>",
  "reference_number": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "gender": "<string>",
  "creator": "<string>",
  "updater": "<string>",
  "buyer": "<string>"
}
'

import requests

url = "http://localhost:3000/connect/v1/supply-chains/farmers/"

payload = {
    "first_name": "<string>",
    "id": "<string>",
    "phone": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "house_name": "<string>",
    "street": "<string>",
    "city": "<string>",
    "sub_province": "<string>",
    "province": "<string>",
    "latitude": 123,
    "longitude": 123,
    "zipcode": "<string>",
    "country": "<string>",
    "number": "<string>",
    "email": "jsmith@example.com",
    "identification_no": "<string>",
    "reference_number": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-12-25",
    "gender": "<string>",
    "creator": "<string>",
    "updater": "<string>",
    "buyer": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    first_name: '<string>',
    id: '<string>',
    phone: '<string>',
    created_on: '2023-11-07T05:31:56Z',
    description: '<string>',
    house_name: '<string>',
    street: '<string>',
    city: '<string>',
    sub_province: '<string>',
    province: '<string>',
    latitude: 123,
    longitude: 123,
    zipcode: '<string>',
    country: '<string>',
    number: '<string>',
    email: 'jsmith@example.com',
    identification_no: '<string>',
    reference_number: '<string>',
    last_name: '<string>',
    date_of_birth: '2023-12-25',
    gender: '<string>',
    creator: '<string>',
    updater: '<string>',
    buyer: '<string>'
  })
};

fetch('http://localhost:3000/connect/v1/supply-chains/farmers/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/connect/v1/supply-chains/farmers/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'first_name' => '<string>',
    'id' => '<string>',
    'phone' => '<string>',
    'created_on' => '2023-11-07T05:31:56Z',
    'description' => '<string>',
    'house_name' => '<string>',
    'street' => '<string>',
    'city' => '<string>',
    'sub_province' => '<string>',
    'province' => '<string>',
    'latitude' => 123,
    'longitude' => 123,
    'zipcode' => '<string>',
    'country' => '<string>',
    'number' => '<string>',
    'email' => 'jsmith@example.com',
    'identification_no' => '<string>',
    'reference_number' => '<string>',
    'last_name' => '<string>',
    'date_of_birth' => '2023-12-25',
    'gender' => '<string>',
    'creator' => '<string>',
    'updater' => '<string>',
    'buyer' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/connect/v1/supply-chains/farmers/"

	payload := strings.NewReader("{\n  \"first_name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"created_on\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"house_name\": \"<string>\",\n  \"street\": \"<string>\",\n  \"city\": \"<string>\",\n  \"sub_province\": \"<string>\",\n  \"province\": \"<string>\",\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"zipcode\": \"<string>\",\n  \"country\": \"<string>\",\n  \"number\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"identification_no\": \"<string>\",\n  \"reference_number\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"date_of_birth\": \"2023-12-25\",\n  \"gender\": \"<string>\",\n  \"creator\": \"<string>\",\n  \"updater\": \"<string>\",\n  \"buyer\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:3000/connect/v1/supply-chains/farmers/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"created_on\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"house_name\": \"<string>\",\n  \"street\": \"<string>\",\n  \"city\": \"<string>\",\n  \"sub_province\": \"<string>\",\n  \"province\": \"<string>\",\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"zipcode\": \"<string>\",\n  \"country\": \"<string>\",\n  \"number\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"identification_no\": \"<string>\",\n  \"reference_number\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"date_of_birth\": \"2023-12-25\",\n  \"gender\": \"<string>\",\n  \"creator\": \"<string>\",\n  \"updater\": \"<string>\",\n  \"buyer\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/connect/v1/supply-chains/farmers/")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"first_name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"created_on\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"house_name\": \"<string>\",\n  \"street\": \"<string>\",\n  \"city\": \"<string>\",\n  \"sub_province\": \"<string>\",\n  \"province\": \"<string>\",\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"zipcode\": \"<string>\",\n  \"country\": \"<string>\",\n  \"number\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"identification_no\": \"<string>\",\n  \"reference_number\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"date_of_birth\": \"2023-12-25\",\n  \"gender\": \"<string>\",\n  \"creator\": \"<string>\",\n  \"updater\": \"<string>\",\n  \"buyer\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "first_name": "<string>",
  "id": "<string>",
  "entity_card": {
    "card": {
      "card_id": "<string>",
      "id": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "display_id": "<string>",
      "creator": "<string>",
      "updater": "<string>"
    },
    "entity": "<string>",
    "id": "<string>",
    "updated_on": "2023-11-07T05:31:56Z",
    "created_on": "2023-11-07T05:31:56Z",
    "is_active": true,
    "creator": "<string>",
    "updater": "<string>"
  },
  "submission": {
    "values": [
      {
        "field": "<string>",
        "value": "<string>",
        "id": "<string>",
        "field_details": {
          "label": "<string>",
          "type": "TEXT",
          "id": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "label_en_us": "<string>",
          "label_en_uk": "<string>",
          "label_fr": "<string>",
          "label_nl": "<string>",
          "label_ind": "<string>",
          "key": "<string>",
          "required": true,
          "default_value": "<string>",
          "options": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        },
        "updated_on": "2023-11-07T05:31:56Z",
        "created_on": "2023-11-07T05:31:56Z",
        "creator": "<string>",
        "updater": "<string>"
      }
    ],
    "form": "<string>",
    "id": "<string>",
    "form_details": {
      "fields": [
        {
          "label": "<string>",
          "type": "TEXT",
          "id": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "label_en_us": "<string>",
          "label_en_uk": "<string>",
          "label_fr": "<string>",
          "label_nl": "<string>",
          "label_ind": "<string>",
          "key": "<string>",
          "required": true,
          "default_value": "<string>",
          "options": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "owner": "<string>",
      "id": "<string>",
      "products": [
        {
          "name": "<string>",
          "id": "<string>",
          "premiums": "<string>",
          "is_active": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "image": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "field_config": [
        {
          "label": "<string>",
          "key": "<string>",
          "id": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "visibility": true,
          "required": true,
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "form_type": "TRANSACTION",
      "creator": "<string>",
      "updater": "<string>"
    },
    "updated_on": "2023-11-07T05:31:56Z",
    "created_on": "2023-11-07T05:31:56Z",
    "creator": "<string>",
    "updater": "<string>",
    "product": "<string>"
  },
  "phone": "<string>",
  "updated_on": "2023-11-07T05:31:56Z",
  "created_on": "2023-11-07T05:31:56Z",
  "image": "<string>",
  "description": "<string>",
  "house_name": "<string>",
  "street": "<string>",
  "city": "<string>",
  "sub_province": "<string>",
  "province": "<string>",
  "latitude": 123,
  "longitude": 123,
  "zipcode": "<string>",
  "country": "<string>",
  "number": "<string>",
  "email": "jsmith@example.com",
  "identification_no": "<string>",
  "reference_number": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "gender": "<string>",
  "consent_status": "GRANTED",
  "creator": "<string>",
  "updater": "<string>",
  "buyer": "<string>"
}

POST

supply-chains

farmers

cURL

curl --request POST \
  --url http://localhost:3000/connect/v1/supply-chains/farmers/ \
  --header 'Authorization: <api-key>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "first_name": "<string>",
  "id": "<string>",
  "phone": "<string>",
  "created_on": "2023-11-07T05:31:56Z",
  "description": "<string>",
  "house_name": "<string>",
  "street": "<string>",
  "city": "<string>",
  "sub_province": "<string>",
  "province": "<string>",
  "latitude": 123,
  "longitude": 123,
  "zipcode": "<string>",
  "country": "<string>",
  "number": "<string>",
  "email": "jsmith@example.com",
  "identification_no": "<string>",
  "reference_number": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "gender": "<string>",
  "creator": "<string>",
  "updater": "<string>",
  "buyer": "<string>"
}
'

import requests

url = "http://localhost:3000/connect/v1/supply-chains/farmers/"

payload = {
    "first_name": "<string>",
    "id": "<string>",
    "phone": "<string>",
    "created_on": "2023-11-07T05:31:56Z",
    "description": "<string>",
    "house_name": "<string>",
    "street": "<string>",
    "city": "<string>",
    "sub_province": "<string>",
    "province": "<string>",
    "latitude": 123,
    "longitude": 123,
    "zipcode": "<string>",
    "country": "<string>",
    "number": "<string>",
    "email": "jsmith@example.com",
    "identification_no": "<string>",
    "reference_number": "<string>",
    "last_name": "<string>",
    "date_of_birth": "2023-12-25",
    "gender": "<string>",
    "creator": "<string>",
    "updater": "<string>",
    "buyer": "<string>"
}
headers = {
    "Authorization": "<api-key>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.text)

const options = {
  method: 'POST',
  headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    first_name: '<string>',
    id: '<string>',
    phone: '<string>',
    created_on: '2023-11-07T05:31:56Z',
    description: '<string>',
    house_name: '<string>',
    street: '<string>',
    city: '<string>',
    sub_province: '<string>',
    province: '<string>',
    latitude: 123,
    longitude: 123,
    zipcode: '<string>',
    country: '<string>',
    number: '<string>',
    email: 'jsmith@example.com',
    identification_no: '<string>',
    reference_number: '<string>',
    last_name: '<string>',
    date_of_birth: '2023-12-25',
    gender: '<string>',
    creator: '<string>',
    updater: '<string>',
    buyer: '<string>'
  })
};

fetch('http://localhost:3000/connect/v1/supply-chains/farmers/', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_PORT => "3000",
  CURLOPT_URL => "http://localhost:3000/connect/v1/supply-chains/farmers/",
  CURLOPT_RETURNTRANSFER => true,
  CURLOPT_ENCODING => "",
  CURLOPT_MAXREDIRS => 10,
  CURLOPT_TIMEOUT => 30,
  CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
  CURLOPT_CUSTOMREQUEST => "POST",
  CURLOPT_POSTFIELDS => json_encode([
    'first_name' => '<string>',
    'id' => '<string>',
    'phone' => '<string>',
    'created_on' => '2023-11-07T05:31:56Z',
    'description' => '<string>',
    'house_name' => '<string>',
    'street' => '<string>',
    'city' => '<string>',
    'sub_province' => '<string>',
    'province' => '<string>',
    'latitude' => 123,
    'longitude' => 123,
    'zipcode' => '<string>',
    'country' => '<string>',
    'number' => '<string>',
    'email' => 'jsmith@example.com',
    'identification_no' => '<string>',
    'reference_number' => '<string>',
    'last_name' => '<string>',
    'date_of_birth' => '2023-12-25',
    'gender' => '<string>',
    'creator' => '<string>',
    'updater' => '<string>',
    'buyer' => '<string>'
  ]),
  CURLOPT_HTTPHEADER => [
    "Authorization: <api-key>",
    "Content-Type: application/json"
  ],
]);

$response = curl_exec($curl);
$err = curl_error($curl);

curl_close($curl);

if ($err) {
  echo "cURL Error #:" . $err;
} else {
  echo $response;
}

package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "http://localhost:3000/connect/v1/supply-chains/farmers/"

	payload := strings.NewReader("{\n  \"first_name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"created_on\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"house_name\": \"<string>\",\n  \"street\": \"<string>\",\n  \"city\": \"<string>\",\n  \"sub_province\": \"<string>\",\n  \"province\": \"<string>\",\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"zipcode\": \"<string>\",\n  \"country\": \"<string>\",\n  \"number\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"identification_no\": \"<string>\",\n  \"reference_number\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"date_of_birth\": \"2023-12-25\",\n  \"gender\": \"<string>\",\n  \"creator\": \"<string>\",\n  \"updater\": \"<string>\",\n  \"buyer\": \"<string>\"\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "<api-key>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(string(body))

}

HttpResponse<String> response = Unirest.post("http://localhost:3000/connect/v1/supply-chains/farmers/")
  .header("Authorization", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"first_name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"created_on\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"house_name\": \"<string>\",\n  \"street\": \"<string>\",\n  \"city\": \"<string>\",\n  \"sub_province\": \"<string>\",\n  \"province\": \"<string>\",\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"zipcode\": \"<string>\",\n  \"country\": \"<string>\",\n  \"number\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"identification_no\": \"<string>\",\n  \"reference_number\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"date_of_birth\": \"2023-12-25\",\n  \"gender\": \"<string>\",\n  \"creator\": \"<string>\",\n  \"updater\": \"<string>\",\n  \"buyer\": \"<string>\"\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("http://localhost:3000/connect/v1/supply-chains/farmers/")

http = Net::HTTP.new(url.host, url.port)

request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"first_name\": \"<string>\",\n  \"id\": \"<string>\",\n  \"phone\": \"<string>\",\n  \"created_on\": \"2023-11-07T05:31:56Z\",\n  \"description\": \"<string>\",\n  \"house_name\": \"<string>\",\n  \"street\": \"<string>\",\n  \"city\": \"<string>\",\n  \"sub_province\": \"<string>\",\n  \"province\": \"<string>\",\n  \"latitude\": 123,\n  \"longitude\": 123,\n  \"zipcode\": \"<string>\",\n  \"country\": \"<string>\",\n  \"number\": \"<string>\",\n  \"email\": \"jsmith@example.com\",\n  \"identification_no\": \"<string>\",\n  \"reference_number\": \"<string>\",\n  \"last_name\": \"<string>\",\n  \"date_of_birth\": \"2023-12-25\",\n  \"gender\": \"<string>\",\n  \"creator\": \"<string>\",\n  \"updater\": \"<string>\",\n  \"buyer\": \"<string>\"\n}"

response = http.request(request)
puts response.read_body

{
  "first_name": "<string>",
  "id": "<string>",
  "entity_card": {
    "card": {
      "card_id": "<string>",
      "id": "<string>",
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "display_id": "<string>",
      "creator": "<string>",
      "updater": "<string>"
    },
    "entity": "<string>",
    "id": "<string>",
    "updated_on": "2023-11-07T05:31:56Z",
    "created_on": "2023-11-07T05:31:56Z",
    "is_active": true,
    "creator": "<string>",
    "updater": "<string>"
  },
  "submission": {
    "values": [
      {
        "field": "<string>",
        "value": "<string>",
        "id": "<string>",
        "field_details": {
          "label": "<string>",
          "type": "TEXT",
          "id": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "label_en_us": "<string>",
          "label_en_uk": "<string>",
          "label_fr": "<string>",
          "label_nl": "<string>",
          "label_ind": "<string>",
          "key": "<string>",
          "required": true,
          "default_value": "<string>",
          "options": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        },
        "updated_on": "2023-11-07T05:31:56Z",
        "created_on": "2023-11-07T05:31:56Z",
        "creator": "<string>",
        "updater": "<string>"
      }
    ],
    "form": "<string>",
    "id": "<string>",
    "form_details": {
      "fields": [
        {
          "label": "<string>",
          "type": "TEXT",
          "id": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "label_en_us": "<string>",
          "label_en_uk": "<string>",
          "label_fr": "<string>",
          "label_nl": "<string>",
          "label_ind": "<string>",
          "key": "<string>",
          "required": true,
          "default_value": "<string>",
          "options": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "owner": "<string>",
      "id": "<string>",
      "products": [
        {
          "name": "<string>",
          "id": "<string>",
          "premiums": "<string>",
          "is_active": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "description": "<string>",
          "image": "<string>",
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "field_config": [
        {
          "label": "<string>",
          "key": "<string>",
          "id": "<string>",
          "updated_on": "2023-11-07T05:31:56Z",
          "created_on": "2023-11-07T05:31:56Z",
          "visibility": true,
          "required": true,
          "creator": "<string>",
          "updater": "<string>"
        }
      ],
      "updated_on": "2023-11-07T05:31:56Z",
      "created_on": "2023-11-07T05:31:56Z",
      "form_type": "TRANSACTION",
      "creator": "<string>",
      "updater": "<string>"
    },
    "updated_on": "2023-11-07T05:31:56Z",
    "created_on": "2023-11-07T05:31:56Z",
    "creator": "<string>",
    "updater": "<string>",
    "product": "<string>"
  },
  "phone": "<string>",
  "updated_on": "2023-11-07T05:31:56Z",
  "created_on": "2023-11-07T05:31:56Z",
  "image": "<string>",
  "description": "<string>",
  "house_name": "<string>",
  "street": "<string>",
  "city": "<string>",
  "sub_province": "<string>",
  "province": "<string>",
  "latitude": 123,
  "longitude": 123,
  "zipcode": "<string>",
  "country": "<string>",
  "number": "<string>",
  "email": "jsmith@example.com",
  "identification_no": "<string>",
  "reference_number": "<string>",
  "last_name": "<string>",
  "date_of_birth": "2023-12-25",
  "gender": "<string>",
  "consent_status": "GRANTED",
  "creator": "<string>",
  "updater": "<string>",
  "buyer": "<string>"
}

Authorizations

Authorization

string

header

required

Body

application/json

first_name

string

required

First name of the farmer. This is part of the farmer's personal details.

Required string length: 1 - 100

string

Unique identifier for the farmer. This identifier is used to distinguish one farmer from another in the system.

entity_card

object

Information related to the Connect card of the farmer.

Show child attributes

submission

object

Submission details related to the farmer. This could include any extra fields metioned in form associated with the company.

Show child attributes

phone

string | null

Phone number of the farmer. This is typically used for contacting the farmer if necessary.

created_on

string<date-time>

Date and time when the farmer information was created. This field indicates when the farmer record was initially added to the system.

description

string | null

Description or additional information about the farmer. This field allows for notes or comments to be added regarding the farmer.

Maximum string length: 500

house_name

string | null

Name of the house or building where the farmer resides. This could be useful for address clarification.

Maximum string length: 100

street

string | null

Name of the street where the farmer resides. This is part of the farmer's address details.

Maximum string length: 500

city

string | null

Name of the city where the farmer resides. This is part of the farmer's address details.

Maximum string length: 500

sub_province

string | null

Name of the sub-province where the farmer resides. This is part of the farmer's address details.

Maximum string length: 500

province

string | null

Name of the province where the farmer resides. This is part of the farmer's address details.

Maximum string length: 500

latitude

number

Latitude coordinate of the farmer's location. This is used for geolocation purposes.

longitude

number

Longitude coordinate of the farmer's location. This is used for geolocation purposes.

zipcode

string | null

Postal code or ZIP code of the area where the farmer resides. This is part of the farmer's address details.

Maximum string length: 50

country

string | null

Name of the country where the farmer resides. This is part of the farmer's address details.

Maximum string length: 500

number

string | null

Additional number for reference. It will be a auto generated value field.

Maximum string length: 10

string<email> | null

Email address of the farmer. This is used for electronic communication with the farmer.

Maximum string length: 100

identification_no

string | null

Identification number of the farmer. This could be a national identification number or any other form of identification.

Maximum string length: 100

reference_number

string | null

Reference number associated with the farmer. This could be a reference to another system or database.

Maximum string length: 100

last_name

string | null

Last name of the farmer. This is part of the farmer's personal details.

Maximum string length: 100

date_of_birth

string<date> | null

Date of birth of the farmer. This is part of the farmer's personal details.

gender

string | null

Gender of the farmer. This is part of the farmer's personal details.

Maximum string length: 50

Consent status of the farmer for data usage. This indicates whether the farmer has given consent for their data to be used.

Available options:

GRANTED,

NOT_GRANTED,

UNKNOWN

creator

string

Identifier of the user who created the farmer entry. This indicates the user responsible for adding the farmer information to the system.

updater

string

Identifier of the user who last updated the farmer entry. This indicates the user responsible for the latest modifications to the farmer information.

buyer

string

Identifier of the buyer associated with the farmer. This indicates any buyer or customer linked to the farmer, if applicable.

Response

201 - application/json

first_name

string

required

First name of the farmer. This is part of the farmer's personal details.

Required string length: 1 - 100

string

Unique identifier for the farmer. This identifier is used to distinguish one farmer from another in the system.

entity_card

object

Information related to the Connect card of the farmer.

Show child attributes

submission

object

Submission details related to the farmer. This could include any extra fields metioned in form associated with the company.

Show child attributes

phone

string | null

Phone number of the farmer. This is typically used for contacting the farmer if necessary.

updated_on

string<date-time>

read-only

Date and time when the farmer information was last updated. This field is automatically generated and cannot be modified directly.

created_on

string<date-time>

Date and time when the farmer information was created. This field indicates when the farmer record was initially added to the system.

image

string<uri> | null

read-only

URL to the photo of the farmer. This could be a link to a profile picture or any relevant image associated with the farmer.

description

string | null

Description or additional information about the farmer. This field allows for notes or comments to be added regarding the farmer.

Maximum string length: 500

house_name

string | null

Name of the house or building where the farmer resides. This could be useful for address clarification.

Maximum string length: 100

street

string | null

Name of the street where the farmer resides. This is part of the farmer's address details.

Maximum string length: 500

city

string | null

Name of the city where the farmer resides. This is part of the farmer's address details.

Maximum string length: 500

sub_province

string | null

Name of the sub-province where the farmer resides. This is part of the farmer's address details.

Maximum string length: 500

province

string | null

Name of the province where the farmer resides. This is part of the farmer's address details.

Maximum string length: 500

latitude

number

Latitude coordinate of the farmer's location. This is used for geolocation purposes.

longitude

number

Longitude coordinate of the farmer's location. This is used for geolocation purposes.

zipcode

string | null

Postal code or ZIP code of the area where the farmer resides. This is part of the farmer's address details.

Maximum string length: 50

country

string | null

Name of the country where the farmer resides. This is part of the farmer's address details.

Maximum string length: 500

number

string | null

Additional number for reference. It will be a auto generated value field.

Maximum string length: 10

string<email> | null

Email address of the farmer. This is used for electronic communication with the farmer.

Maximum string length: 100

identification_no

string | null

Identification number of the farmer. This could be a national identification number or any other form of identification.

Maximum string length: 100

reference_number

string | null

Reference number associated with the farmer. This could be a reference to another system or database.

Maximum string length: 100

last_name

string | null

Last name of the farmer. This is part of the farmer's personal details.

Maximum string length: 100

date_of_birth

string<date> | null

Date of birth of the farmer. This is part of the farmer's personal details.

gender

string | null

Gender of the farmer. This is part of the farmer's personal details.

Maximum string length: 50

Consent status of the farmer for data usage. This indicates whether the farmer has given consent for their data to be used.

Available options:

GRANTED,

NOT_GRANTED,

UNKNOWN

creator

string

Identifier of the user who created the farmer entry. This indicates the user responsible for adding the farmer information to the system.

updater

string

Identifier of the user who last updated the farmer entry. This indicates the user responsible for the latest modifications to the farmer information.

buyer

string

Identifier of the buyer associated with the farmer. This indicates any buyer or customer linked to the farmer, if applicable.