FarmerJoe API

Analyses

getAnalyses

Get analyses by filter

Use any combination of field_id, crop_id and user_id


/companies/{companyId}/analyses

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/analyses?field_id=&crop_id=&user_id=&group_id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AnalysesApi;

import java.io.File;
import java.util.*;

public class AnalysesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        AnalysesApi apiInstance = new AnalysesApi();
        String companyId = companyId_example; // String | The company ID
        String fieldId = fieldId_example; // String | The field ID
        String cropId = cropId_example; // String | The crop ID
        String userId = userId_example; // String | The user ID
        String groupId = groupId_example; // String | The group ID
        try {
            List<Analysis> result = apiInstance.getAnalyses(companyId, fieldId, cropId, userId, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysesApi#getAnalyses");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.AnalysesApi()
var companyId = companyId_example; // {String} The company ID
var opts = {
  'fieldId': fieldId_example, // {String} The field ID
  'cropId': cropId_example, // {String} The crop ID
  'userId': userId_example, // {String} The user ID
  'groupId': groupId_example // {String} The group ID
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalyses(companyId, opts, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\AnalysesApi();
$companyId = companyId_example; // String | The company ID
$fieldId = fieldId_example; // String | The field ID
$cropId = cropId_example; // String | The crop ID
$userId = userId_example; // String | The user ID
$groupId = groupId_example; // String | The group ID

try {
    $result = $api_instance->getAnalyses($companyId, $fieldId, $cropId, $userId, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalysesApi->getAnalyses: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
Query parameters
Name Description
field_id
String
The field ID
crop_id
String
The crop ID
user_id
String
The user ID
group_id
String
The group ID

Responses

getAnalysis

Get analyses


/companies/{companyId}/analyses/{analysisId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/analyses/{analysisId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.AnalysesApi;

import java.io.File;
import java.util.*;

public class AnalysesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        AnalysesApi apiInstance = new AnalysesApi();
        String companyId = companyId_example; // String | The company ID
        String analysisId = analysisId_example; // String | The analysis ID
        try {
            Analysis result = apiInstance.getAnalysis(companyId, analysisId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling AnalysesApi#getAnalysis");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.AnalysesApi()
var companyId = companyId_example; // {String} The company ID
var analysisId = analysisId_example; // {String} The analysis ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getAnalysis(companyId, analysisId, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\AnalysesApi();
$companyId = companyId_example; // String | The company ID
$analysisId = analysisId_example; // String | The analysis ID

try {
    $result = $api_instance->getAnalysis($companyId, $analysisId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling AnalysesApi->getAnalysis: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
analysisId*
String
The analysis ID
Required

Responses

Comments

getComment

Get comment


/companies/{companyId}/comments/{commentId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/comments/{commentId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

import java.io.File;
import java.util.*;

public class CommentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        CommentsApi apiInstance = new CommentsApi();
        String companyId = companyId_example; // String | The company ID
        String commentId = commentId_example; // String | The comment ID
        try {
            Comment result = apiInstance.getComment(companyId, commentId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#getComment");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.CommentsApi()
var companyId = companyId_example; // {String} The company ID
var commentId = commentId_example; // {String} The comment ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getComment(companyId, commentId, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\CommentsApi();
$companyId = companyId_example; // String | The company ID
$commentId = commentId_example; // String | The comment ID

try {
    $result = $api_instance->getComment($companyId, $commentId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->getComment: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
commentId*
String
The comment ID
Required

Responses

getComments

Get comments by filter

Use any combination of field_id, crop_id and user_id. This call uses pagination and results are ordered from newest to oldest. Use the limit query parameter to limit the number of results (default = 50, max = 1000) and start_after to continue the list starting from the next comment after the one specified. For example call this interface once, then call it again with start_after set to the last comment's 'created' property from the previous call. Continue passing last comment's 'created' property to subsequent calls until 'hasMore' is false to get the whole list. You can also pass a date to start_after like '2018-10-20'.


/companies/{companyId}/comments

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/comments?field_id=&crop_id=&user_id=&limit=&start_after=&group_id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CommentsApi;

import java.io.File;
import java.util.*;

public class CommentsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        CommentsApi apiInstance = new CommentsApi();
        String companyId = companyId_example; // String | The company ID
        String fieldId = fieldId_example; // String | The field ID
        String cropId = cropId_example; // String | The crop ID
        String userId = userId_example; // String | The user ID
        Integer limit = 56; // Integer | The limit of comments returned
        String startAfter = startAfter_example; // String | The date after which the list should start
        String groupId = groupId_example; // String | The group ID
        try {
            InlineResponse200 result = apiInstance.getComments(companyId, fieldId, cropId, userId, limit, startAfter, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CommentsApi#getComments");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.CommentsApi()
var companyId = companyId_example; // {String} The company ID
var opts = {
  'fieldId': fieldId_example, // {String} The field ID
  'cropId': cropId_example, // {String} The crop ID
  'userId': userId_example, // {String} The user ID
  'limit': 56, // {Integer} The limit of comments returned
  'startAfter': startAfter_example, // {String} The date after which the list should start
  'groupId': groupId_example // {String} The group ID
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getComments(companyId, opts, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\CommentsApi();
$companyId = companyId_example; // String | The company ID
$fieldId = fieldId_example; // String | The field ID
$cropId = cropId_example; // String | The crop ID
$userId = userId_example; // String | The user ID
$limit = 56; // Integer | The limit of comments returned
$startAfter = startAfter_example; // String | The date after which the list should start
$groupId = groupId_example; // String | The group ID

try {
    $result = $api_instance->getComments($companyId, $fieldId, $cropId, $userId, $limit, $startAfter, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CommentsApi->getComments: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
Query parameters
Name Description
field_id
String
The field ID
crop_id
String
The crop ID
user_id
String
The user ID
limit
Integer (int32)
The limit of comments returned
start_after
String
The date after which the list should start
group_id
String
The group ID

Responses

Company

getCompany

Get company information


/companies/{companyId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CompanyApi;

import java.io.File;
import java.util.*;

public class CompanyApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        CompanyApi apiInstance = new CompanyApi();
        String companyId = companyId_example; // String | The company ID
        try {
            Company result = apiInstance.getCompany(companyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CompanyApi#getCompany");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.CompanyApi()
var companyId = companyId_example; // {String} The company ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCompany(companyId, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\CompanyApi();
$companyId = companyId_example; // String | The company ID

try {
    $result = $api_instance->getCompany($companyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CompanyApi->getCompany: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required

Responses

Crops

getCrop

Get crop


/companies/{companyId}/crops/{cropId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/crops/{cropId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CropsApi;

import java.io.File;
import java.util.*;

public class CropsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        CropsApi apiInstance = new CropsApi();
        String companyId = companyId_example; // String | The company ID
        String cropId = cropId_example; // String | The crop ID
        try {
            Crop result = apiInstance.getCrop(companyId, cropId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CropsApi#getCrop");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.CropsApi()
var companyId = companyId_example; // {String} The company ID
var cropId = cropId_example; // {String} The crop ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCrop(companyId, cropId, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\CropsApi();
$companyId = companyId_example; // String | The company ID
$cropId = cropId_example; // String | The crop ID

try {
    $result = $api_instance->getCrop($companyId, $cropId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CropsApi->getCrop: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
cropId*
String
The crop ID
Required

Responses

getCrops

Get fields's crop list


/companies/{companyId}/crops

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/crops?field_id=&group_id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.CropsApi;

import java.io.File;
import java.util.*;

public class CropsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        CropsApi apiInstance = new CropsApi();
        String companyId = companyId_example; // String | The company ID
        String fieldId = fieldId_example; // String | The field ID
        String groupId = groupId_example; // String | The group ID
        try {
            List<Crop> result = apiInstance.getCrops(companyId, fieldId, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling CropsApi#getCrops");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.CropsApi()
var companyId = companyId_example; // {String} The company ID
var fieldId = fieldId_example; // {String} The field ID
var opts = {
  'groupId': groupId_example // {String} The group ID
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getCrops(companyId, fieldId, opts, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\CropsApi();
$companyId = companyId_example; // String | The company ID
$fieldId = fieldId_example; // String | The field ID
$groupId = groupId_example; // String | The group ID

try {
    $result = $api_instance->getCrops($companyId, $fieldId, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling CropsApi->getCrops: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
Query parameters
Name Description
field_id*
String
The field ID
Required
group_id
String
The group ID

Responses

Fertilizers

getFertilizer

Get fertilizer


/companies/{companyId}/fertilizers/{fertilizerId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/fertilizers/{fertilizerId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FertilizersApi;

import java.io.File;
import java.util.*;

public class FertilizersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        FertilizersApi apiInstance = new FertilizersApi();
        String companyId = companyId_example; // String | The company ID
        String fertilizerId = fertilizerId_example; // String | The fertilizer ID
        try {
            Fertilizer result = apiInstance.getFertilizer(companyId, fertilizerId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FertilizersApi#getFertilizer");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.FertilizersApi()
var companyId = companyId_example; // {String} The company ID
var fertilizerId = fertilizerId_example; // {String} The fertilizer ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFertilizer(companyId, fertilizerId, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\FertilizersApi();
$companyId = companyId_example; // String | The company ID
$fertilizerId = fertilizerId_example; // String | The fertilizer ID

try {
    $result = $api_instance->getFertilizer($companyId, $fertilizerId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FertilizersApi->getFertilizer: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
fertilizerId*
String
The fertilizer ID
Required

Responses

getFertilizers

Get fertilizers by filter

Use any combination of field_id, crop_id and user_id


/companies/{companyId}/fertilizers

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/fertilizers?field_id=&crop_id=&user_id=&group_id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FertilizersApi;

import java.io.File;
import java.util.*;

public class FertilizersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        FertilizersApi apiInstance = new FertilizersApi();
        String companyId = companyId_example; // String | The company ID
        String fieldId = fieldId_example; // String | The field ID
        String cropId = cropId_example; // String | The crop ID
        String userId = userId_example; // String | The user ID
        String groupId = groupId_example; // String | The group ID
        try {
            List<Fertilizer> result = apiInstance.getFertilizers(companyId, fieldId, cropId, userId, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FertilizersApi#getFertilizers");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.FertilizersApi()
var companyId = companyId_example; // {String} The company ID
var opts = {
  'fieldId': fieldId_example, // {String} The field ID
  'cropId': cropId_example, // {String} The crop ID
  'userId': userId_example, // {String} The user ID
  'groupId': groupId_example // {String} The group ID
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFertilizers(companyId, opts, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\FertilizersApi();
$companyId = companyId_example; // String | The company ID
$fieldId = fieldId_example; // String | The field ID
$cropId = cropId_example; // String | The crop ID
$userId = userId_example; // String | The user ID
$groupId = groupId_example; // String | The group ID

try {
    $result = $api_instance->getFertilizers($companyId, $fieldId, $cropId, $userId, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FertilizersApi->getFertilizers: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
Query parameters
Name Description
field_id
String
The field ID
crop_id
String
The crop ID
user_id
String
The user ID
group_id
String
The group ID

Responses

Fields

getField

Get company's field


/companies/{companyId}/fields/{fieldId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/fields/{fieldId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FieldsApi;

import java.io.File;
import java.util.*;

public class FieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        FieldsApi apiInstance = new FieldsApi();
        String companyId = companyId_example; // String | The company ID
        String fieldId = fieldId_example; // String | The field ID
        try {
            Field result = apiInstance.getField(companyId, fieldId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FieldsApi#getField");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.FieldsApi()
var companyId = companyId_example; // {String} The company ID
var fieldId = fieldId_example; // {String} The field ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getField(companyId, fieldId, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\FieldsApi();
$companyId = companyId_example; // String | The company ID
$fieldId = fieldId_example; // String | The field ID

try {
    $result = $api_instance->getField($companyId, $fieldId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldsApi->getField: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
fieldId*
String
The field ID
Required

Responses

getFields

Get company's field list


/companies/{companyId}/fields

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/fields?group_id=&trader_id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.FieldsApi;

import java.io.File;
import java.util.*;

public class FieldsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        FieldsApi apiInstance = new FieldsApi();
        String companyId = companyId_example; // String | The company ID
        String groupId = groupId_example; // String | The group ID
        String traderId = traderId_example; // String | The trader ID
        try {
            List<Field> result = apiInstance.getFields(companyId, groupId, traderId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling FieldsApi#getFields");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.FieldsApi()
var companyId = companyId_example; // {String} The company ID
var opts = {
  'groupId': groupId_example, // {String} The group ID
  'traderId': traderId_example // {String} The trader ID
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getFields(companyId, opts, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\FieldsApi();
$companyId = companyId_example; // String | The company ID
$groupId = groupId_example; // String | The group ID
$traderId = traderId_example; // String | The trader ID

try {
    $result = $api_instance->getFields($companyId, $groupId, $traderId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling FieldsApi->getFields: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
Query parameters
Name Description
group_id
String
The group ID
trader_id
String
The trader ID

Responses

Groups

getGroup

Get group


/companies/{companyId}/groups/{groupId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/groups/{groupId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        GroupsApi apiInstance = new GroupsApi();
        String companyId = companyId_example; // String | The company ID
        String groupId = groupId_example; // String | The group ID
        try {
            Group result = apiInstance.getGroup(companyId, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getGroup");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.GroupsApi()
var companyId = companyId_example; // {String} The company ID
var groupId = groupId_example; // {String} The group ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGroup(companyId, groupId, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$companyId = companyId_example; // String | The company ID
$groupId = groupId_example; // String | The group ID

try {
    $result = $api_instance->getGroup($companyId, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->getGroup: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
groupId*
String
The group ID
Required

Responses

getGroupUsers

Get group's user list


/companies/{companyId}/groups/{groupId}/users

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/groups/{groupId}/users"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        GroupsApi apiInstance = new GroupsApi();
        String companyId = companyId_example; // String | The company ID
        String groupId = groupId_example; // String | The group ID
        try {
            List<User> result = apiInstance.getGroupUsers(companyId, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getGroupUsers");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.GroupsApi()
var companyId = companyId_example; // {String} The company ID
var groupId = groupId_example; // {String} The group ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGroupUsers(companyId, groupId, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$companyId = companyId_example; // String | The company ID
$groupId = groupId_example; // String | The group ID

try {
    $result = $api_instance->getGroupUsers($companyId, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->getGroupUsers: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
groupId*
String
The group ID
Required

Responses

getGroups

Get company's group list


/companies/{companyId}/groups

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/groups?type="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.GroupsApi;

import java.io.File;
import java.util.*;

public class GroupsApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        GroupsApi apiInstance = new GroupsApi();
        String companyId = companyId_example; // String | The company ID
        String type = type_example; // String | Type of group
        try {
            List result = apiInstance.getGroups(companyId, type);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling GroupsApi#getGroups");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.GroupsApi()
var companyId = companyId_example; // {String} The company ID
var opts = {
  'type': type_example // {String} Type of group
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getGroups(companyId, opts, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\GroupsApi();
$companyId = companyId_example; // String | The company ID
$type = type_example; // String | Type of group

try {
    $result = $api_instance->getGroups($companyId, $type);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling GroupsApi->getGroups: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
Query parameters
Name Description
type
String
Type of group

Responses

Users

getUser

Get company's user


/companies/{companyId}/users/{userId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/users/{userId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        UsersApi apiInstance = new UsersApi();
        String companyId = companyId_example; // String | The company ID
        String userId = userId_example; // String | The user ID
        try {
            User result = apiInstance.getUser(companyId, userId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUser");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.UsersApi()
var companyId = companyId_example; // {String} The company ID
var userId = userId_example; // {String} The user ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUser(companyId, userId, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\UsersApi();
$companyId = companyId_example; // String | The company ID
$userId = userId_example; // String | The user ID

try {
    $result = $api_instance->getUser($companyId, $userId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->getUser: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
userId*
String
The user ID
Required

Responses

getUsers

Get company's user list


/companies/{companyId}/users

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/users"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.UsersApi;

import java.io.File;
import java.util.*;

public class UsersApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        UsersApi apiInstance = new UsersApi();
        String companyId = companyId_example; // String | The company ID
        try {
            List<User> result = apiInstance.getUsers(companyId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling UsersApi#getUsers");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.UsersApi()
var companyId = companyId_example; // {String} The company ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getUsers(companyId, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\UsersApi();
$companyId = companyId_example; // String | The company ID

try {
    $result = $api_instance->getUsers($companyId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling UsersApi->getUsers: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required

Responses

Waittimes

getWaitTime

Get wait time


/companies/{companyId}/waittimes/{waitTimeId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/waittimes/{waitTimeId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WaittimesApi;

import java.io.File;
import java.util.*;

public class WaittimesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        WaittimesApi apiInstance = new WaittimesApi();
        String companyId = companyId_example; // String | The company ID
        String waitTimeId = waitTimeId_example; // String | The wait time ID
        try {
            WaitTime result = apiInstance.getWaitTime(companyId, waitTimeId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WaittimesApi#getWaitTime");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.WaittimesApi()
var companyId = companyId_example; // {String} The company ID
var waitTimeId = waitTimeId_example; // {String} The wait time ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWaitTime(companyId, waitTimeId, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\WaittimesApi();
$companyId = companyId_example; // String | The company ID
$waitTimeId = waitTimeId_example; // String | The wait time ID

try {
    $result = $api_instance->getWaitTime($companyId, $waitTimeId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WaittimesApi->getWaitTime: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
waitTimeId*
String
The wait time ID
Required

Responses

getWaitTimes

Get wait times by filter

Use any combination of field_id, crop_id and user_id


/companies/{companyId}/waittimes

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/waittimes?field_id=&crop_id=&user_id=&group_id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WaittimesApi;

import java.io.File;
import java.util.*;

public class WaittimesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        WaittimesApi apiInstance = new WaittimesApi();
        String companyId = companyId_example; // String | The company ID
        String fieldId = fieldId_example; // String | The field ID
        String cropId = cropId_example; // String | The crop ID
        String userId = userId_example; // String | The user ID
        String groupId = groupId_example; // String | The group ID
        try {
            List<WaitTime> result = apiInstance.getWaitTimes(companyId, fieldId, cropId, userId, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WaittimesApi#getWaitTimes");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.WaittimesApi()
var companyId = companyId_example; // {String} The company ID
var opts = {
  'fieldId': fieldId_example, // {String} The field ID
  'cropId': cropId_example, // {String} The crop ID
  'userId': userId_example, // {String} The user ID
  'groupId': groupId_example // {String} The group ID
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWaitTimes(companyId, opts, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\WaittimesApi();
$companyId = companyId_example; // String | The company ID
$fieldId = fieldId_example; // String | The field ID
$cropId = cropId_example; // String | The crop ID
$userId = userId_example; // String | The user ID
$groupId = groupId_example; // String | The group ID

try {
    $result = $api_instance->getWaitTimes($companyId, $fieldId, $cropId, $userId, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WaittimesApi->getWaitTimes: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
Query parameters
Name Description
field_id
String
The field ID
crop_id
String
The crop ID
user_id
String
The user ID
group_id
String
The group ID

Responses

Warehouses

getWarehouse

Get company's warehouse


/companies/{companyId}/warehouses/{warehouseId}

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/warehouses/{warehouseId}"
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WarehousesApi;

import java.io.File;
import java.util.*;

public class WarehousesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        WarehousesApi apiInstance = new WarehousesApi();
        String companyId = companyId_example; // String | The company ID
        String warehouseId = warehouseId_example; // String | The warehouse ID
        try {
            Warehouse result = apiInstance.getWarehouse(companyId, warehouseId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousesApi#getWarehouse");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.WarehousesApi()
var companyId = companyId_example; // {String} The company ID
var warehouseId = warehouseId_example; // {String} The warehouse ID

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWarehouse(companyId, warehouseId, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\WarehousesApi();
$companyId = companyId_example; // String | The company ID
$warehouseId = warehouseId_example; // String | The warehouse ID

try {
    $result = $api_instance->getWarehouse($companyId, $warehouseId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarehousesApi->getWarehouse: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
warehouseId*
String
The warehouse ID
Required

Responses

getWarehouses

Get company's warehouse list


/companies/{companyId}/warehouses

Usage and SDK Samples

curl -X GET -H "Accept: application/json" -H "Authorization: Bearer [[apiKey]]" "https://api.farmerjoe.com/v1/companies/{companyId}/warehouses?group_id="
import org.openapitools.client.*;
import org.openapitools.client.auth.*;
import org.openapitools.client.model.*;
import org.openapitools.client.api.WarehousesApi;

import java.io.File;
import java.util.*;

public class WarehousesApiExample {

    public static void main(String[] args) {
        ApiClient defaultClient = Configuration.getDefaultApiClient();
        defaultClient.setConnectTimeout(60000);
        defaultClient.setReadTimeout(60000);
        
        // Configure HTTP basic authorization: bearerAuth
        HttpBearerAuth bearerAuth = (HttpBearerAuth) defaultClient.getAuthentication("bearerAuth");
        bearerAuth.setApiKey("YOUR API KEY");

        WarehousesApi apiInstance = new WarehousesApi();
        String companyId = companyId_example; // String | The company ID
        String groupId = groupId_example; // String | The group ID
        try {
            List<Warehouse> result = apiInstance.getWarehouses(companyId, groupId);
            System.out.println(result);
        } catch (ApiException e) {
            System.err.println("Exception when calling WarehousesApi#getWarehouses");
            e.printStackTrace();
        }
    }
}
var FarmerJoeApi = require('farmer_joe_api');
var defaultClient = FarmerJoeApi.ApiClient.instance;

// Configure HTTP bearer authorization: bearerAuth
var bearerAuth = defaultClient.authentications['bearerAuth'];
bearerAuth.bearerApiKey = 'YOUR API KEY'

var api = new FarmerJoeApi.WarehousesApi()
var companyId = companyId_example; // {String} The company ID
var opts = {
  'groupId': groupId_example // {String} The group ID
};

var callback = function(error, data, response) {
  if (error) {
    console.error(error);
  } else {
    console.log('API called successfully. Returned data: ' + data);
  }
};
api.getWarehouses(companyId, opts, callback);

<?php
require_once(__DIR__ . '/vendor/autoload.php');

// Configure HTTP bearer authorization: bearerAuth
OpenAPITools\Client\Configuration::getDefaultConfiguration()->setBearerApiKey('YOUR_API_KEY');

$api_instance = new OpenAPITools\Client\Api\WarehousesApi();
$companyId = companyId_example; // String | The company ID
$groupId = groupId_example; // String | The group ID

try {
    $result = $api_instance->getWarehouses($companyId, $groupId);
    print_r($result);
} catch (Exception $e) {
    echo 'Exception when calling WarehousesApi->getWarehouses: ', $e->getMessage(), PHP_EOL;
}
?>

Scopes

Parameters

Path parameters
Name Description
companyId*
String
The company ID
Required
Query parameters
Name Description
group_id
String
The group ID

Responses