Get Model Details

You are here:
< All Topics
image_pdfDownload as PDF

Every model has its own parameters and criteria it uses to calculate the results. This API will return those details; for the growth stage models currently available this API returns information about the crop stages that the model may return.

API Request

API Endpoints

▶ HTTP VERBS AND URIS

GET /v2/agronomics/models/{modelId}/details
  • Returns the details for the specified model.

▶ PARAMETERS

PARAMETERDESCRIPTIONVALID VALUES
{modelId}The ID of the model you wish to reference. Model IDs are strings provided by the aWhere APIs.A string

Query String Parameters

QUERY PARAMETER NAMEDESCRIPTIONVALID VALUES
unitsBy default, the API will work in metric units (e.g., Celsius, millimeters, etc). When set to usa, the relevant numeric properties will use values common in the US; for example, GDDs are calculated using Fahrenheit temperatures. The API response includes properties that indicate the units for each temperature attribute.metric
usa

Request Body

None

HTTP Headers

Remember to always send your OAuth2 Access Token in the Authorization header (see Authentication). This API doesn’t require any additional headers.

API Response

Response HTTP Status Codes and Headers

This API returns standard HTTP status codes and headers for aWhere APIs. No additional headers are returned.

Response Body

▶ FORMAT FOR THE GROWTH STAGE MODELS

{
    "biofix":{biofix},
    "gddMethod":"{gddMethod}",
    "gddBaseTemp":{gddBaseTemp},
    "gddMaxBoundary":{gddMaxBoundary},
    "gddMinBoundary":{gddMinBoundary},
    "gddUnits":"{gddUnits}",
    "stages":[{ 
            "id":"{stageId}",
            "stage":"{stage}",
            "description":"{description}",
            "gddThreshold":{gddThreshold},
            "gddUnits":"{gddUnits}"
             },{
            ...
             }
           ],
    "_links":{ 
        "self":{"href":"{selfLink}"
        "curies":[{
            "name":"awhere",
            "href":"http://awhere.com/rels/{rel}",
            "templated":true
            }],
        "awhere:model":{ "href":"{modelLink}" }
        }
}

▶ PROPERTY DESCRIPTIONS

NAMEDESCRIPTION
{biofix}The biofix date is the date from which the GDDs begin accumulating, and is expressed as a plus or minus number of days relative to the planting date. The results API handles this adjustment automatically.
{gddMethod}The GDD calculation used for this model.  Details about the equations and parameters are available here.
{gddBaseTemp}The base temperature used in the GDD equation for this model.
{gddMaxBoundary}The maximum temperature boundary used in the GDD equation.  Behavior of this value depends on the equation used. A null value represents no maximum boundary.
{gddMinBoundary}The minimum temperature boundary used in the GDD equation.  Behavior of this value depends on the equation used. A null value represents no minimum boundary.
{gddUnits}The temperature units (Celsius or Fahrenheit) for the above GDD parameters.
stagesThis is an array of objects where every object represents one of the growth stages for the crop.
{stageId}An ID for the stage.
{stage}A name for the stage.
{description}A description of the stage, such as what the plant may look like.
{gddThreshold}The number of GDDs required to enter this stage.
{gddUnits}The temperature units (Celsius or Fahrenheit) used to calculate the number of GDDs.
{self}The URI of the Details object (the same API called to generate these results).
{modelLink}The URI of each the relevant Model object.
Was this article helpful?
0 out Of 5 Stars
5 Stars 0%
4 Stars 0%
3 Stars 0%
2 Stars 0%
1 Stars 0%
How can we improve this article?
Table of Contents