Register a herd (livestock)

curl --request POST \
  --url https://app.microcrop.app/api/herds \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "farmerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "headCount": 50000,
  "estimatedValue": 123,
  "latitude": 123,
  "longitude": 123
}
'

import requests

url = "https://app.microcrop.app/api/herds"

payload = {
    "farmerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "headCount": 50000,
    "estimatedValue": 123,
    "latitude": 123,
    "longitude": 123
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    farmerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    headCount: 50000,
    estimatedValue: 123,
    latitude: 123,
    longitude: 123
  })
};

fetch('https://app.microcrop.app/api/herds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.microcrop.app/api/herds",
  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([
    'farmerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'headCount' => 50000,
    'estimatedValue' => 123,
    'latitude' => 123,
    'longitude' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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 := "https://app.microcrop.app/api/herds"

	payload := strings.NewReader("{\n  \"farmerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"headCount\": 50000,\n  \"estimatedValue\": 123,\n  \"latitude\": 123,\n  \"longitude\": 123\n}")

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

	req.Header.Add("x-api-key", "<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("https://app.microcrop.app/api/herds")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"farmerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"headCount\": 50000,\n  \"estimatedValue\": 123,\n  \"latitude\": 123,\n  \"longitude\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.microcrop.app/api/herds")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"farmerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"headCount\": 50000,\n  \"estimatedValue\": 123,\n  \"latitude\": 123,\n  \"longitude\": 123\n}"

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

{
  "success": true,
  "data": {}
}

POST

herds

curl --request POST \
  --url https://app.microcrop.app/api/herds \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "farmerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "name": "<string>",
  "headCount": 50000,
  "estimatedValue": 123,
  "latitude": 123,
  "longitude": 123
}
'

import requests

url = "https://app.microcrop.app/api/herds"

payload = {
    "farmerId": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
    "name": "<string>",
    "headCount": 50000,
    "estimatedValue": 123,
    "latitude": 123,
    "longitude": 123
}
headers = {
    "x-api-key": "<api-key>",
    "Content-Type": "application/json"
}

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

print(response.text)

const options = {
  method: 'POST',
  headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
  body: JSON.stringify({
    farmerId: '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    name: '<string>',
    headCount: 50000,
    estimatedValue: 123,
    latitude: 123,
    longitude: 123
  })
};

fetch('https://app.microcrop.app/api/herds', options)
  .then(res => res.json())
  .then(res => console.log(res))
  .catch(err => console.error(err));

<?php

$curl = curl_init();

curl_setopt_array($curl, [
  CURLOPT_URL => "https://app.microcrop.app/api/herds",
  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([
    'farmerId' => '3c90c3cc-0d44-4b50-8888-8dd25736052a',
    'name' => '<string>',
    'headCount' => 50000,
    'estimatedValue' => 123,
    'latitude' => 123,
    'longitude' => 123
  ]),
  CURLOPT_HTTPHEADER => [
    "Content-Type: application/json",
    "x-api-key: <api-key>"
  ],
]);

$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 := "https://app.microcrop.app/api/herds"

	payload := strings.NewReader("{\n  \"farmerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"headCount\": 50000,\n  \"estimatedValue\": 123,\n  \"latitude\": 123,\n  \"longitude\": 123\n}")

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

	req.Header.Add("x-api-key", "<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("https://app.microcrop.app/api/herds")
  .header("x-api-key", "<api-key>")
  .header("Content-Type", "application/json")
  .body("{\n  \"farmerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"headCount\": 50000,\n  \"estimatedValue\": 123,\n  \"latitude\": 123,\n  \"longitude\": 123\n}")
  .asString();

require 'uri'
require 'net/http'

url = URI("https://app.microcrop.app/api/herds")

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

request = Net::HTTP::Post.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"farmerId\": \"3c90c3cc-0d44-4b50-8888-8dd25736052a\",\n  \"name\": \"<string>\",\n  \"headCount\": 50000,\n  \"estimatedValue\": 123,\n  \"latitude\": 123,\n  \"longitude\": 123\n}"

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

{
  "success": true,
  "data": {}
}

Authorizations

x-api-key

string

header

required

Body

application/json

farmerId

string<uuid>

required

name

string

required

Maximum string length: 100

livestockType

enum<string>

required

Available options:

CATTLE,

GOAT,

SHEEP,

CAMEL,

POULTRY

headCount

integer

required

Required range: 1 <= x <= 100000

estimatedValue

number

required

latitude

number

longitude

number

Response

201 - application/json

Created

success

boolean

Example:

true

data

object

Overview

Endpoints

Register a herd (livestock)

Authorizations

Body

Response