POST BlendTicket/PostFormulateAnalysis

Calculates the formulation request using Agvance logic returning the calculated product information.

Request Information

URI Parameters

Body Parameters

Request body to calculate the product quantities from

ClsFormulationRequest
NameDescriptionTypeAdditional Information
Quantity

The quantity (acres) of the Blend or Plan use for calculations.

decimal number

Cannot be negative

Max of 3 decimal places

Must be filled out and numeric

LocationID

The location id to used for the preferences in the calculations.

string

Max length: 6

LocationGUID

The location Globally Unique Identifier. Used to identify the location of the preferences when the LocationID is not set.

globally unique identifier

(Hexadecimal 8-4-4-4-12)

FormulateByGuaranteedAnalysis

Property that indicates if the formulation request is in Lbs / Unit or Guaranteed Analysis.

boolean

Must be 0, 1, True, or False

LbsOfAnalysis

When formulating by Guaranteed Analysis, the Lbs / Unit of the final formulation.

decimal number

Cannot be negative

Max of 3 decimal places

Must be filled out and numeric

BlendProductSetUniqueId

The Unique ID of the Blend Product Set that will be used to supply the product information for the formulation.

integer

Must be filled out and numeric

OptimizeByPriceLevel

The Product Price or Cost level to use in the Least Cost formulation.

PriceLevelEnum
Nutrients

The list of nutrient requests to use in the calculation.

Collection of ClsFormulationRequestNutrients

List cannot be empty

Request Formats

application/json, text/json

Sample:
{
  "Quantity": 3.1,
  "LocationID": "sample string 4",
  "LocationGUID": "2b938e32-3b0f-4e28-8fe8-a3a2033f5496",
  "FormulateByGuaranteedAnalysis": true,
  "LbsOfAnalysis": 6.1,
  "BlendProductSetUniqueId": 7,
  "OptimizeByPriceLevel": 0,
  "Nutrients": [
    {
      "NutrientType": 0,
      "NutrientValue": 1.1,
      "NutrientBreakdowns": [
        {
          "BreakdownType": 0,
          "Equality": 0,
          "BreakdownPercentage": 1.1
        },
        {
          "BreakdownType": 0,
          "Equality": 0,
          "BreakdownPercentage": 1.1
        }
      ]
    },
    {
      "NutrientType": 0,
      "NutrientValue": 1.1,
      "NutrientBreakdowns": [
        {
          "BreakdownType": 0,
          "Equality": 0,
          "BreakdownPercentage": 1.1
        },
        {
          "BreakdownType": 0,
          "Equality": 0,
          "BreakdownPercentage": 1.1
        }
      ]
    }
  ]
}

application/xml, text/xml

Sample:
<ClsBlendPlanUtilities.ClsFormulationRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.plbl">
  <BlendProductSetUniqueId>7</BlendProductSetUniqueId>
  <FormulateByGuaranteedAnalysis>true</FormulateByGuaranteedAnalysis>
  <LbsOfAnalysis>6.1</LbsOfAnalysis>
  <LocationGUID>2b938e32-3b0f-4e28-8fe8-a3a2033f5496</LocationGUID>
  <LocationID>sample string 4</LocationID>
  <Nutrients>
    <ClsBlendPlanUtilities.ClsFormulationRequestNutrients>
      <NutrientBreakdowns>
        <ClsBlendPlanUtilities.ClsFormulationNutrientBreakdown>
          <BreakdownPercentage>1.1</BreakdownPercentage>
          <BreakdownType>AmmoniacalNitrogen</BreakdownType>
          <Equality>LessThanOrEqualTo</Equality>
        </ClsBlendPlanUtilities.ClsFormulationNutrientBreakdown>
        <ClsBlendPlanUtilities.ClsFormulationNutrientBreakdown>
          <BreakdownPercentage>1.1</BreakdownPercentage>
          <BreakdownType>AmmoniacalNitrogen</BreakdownType>
          <Equality>LessThanOrEqualTo</Equality>
        </ClsBlendPlanUtilities.ClsFormulationNutrientBreakdown>
      </NutrientBreakdowns>
      <NutrientType>N</NutrientType>
      <NutrientValue>1.1</NutrientValue>
    </ClsBlendPlanUtilities.ClsFormulationRequestNutrients>
    <ClsBlendPlanUtilities.ClsFormulationRequestNutrients>
      <NutrientBreakdowns>
        <ClsBlendPlanUtilities.ClsFormulationNutrientBreakdown>
          <BreakdownPercentage>1.1</BreakdownPercentage>
          <BreakdownType>AmmoniacalNitrogen</BreakdownType>
          <Equality>LessThanOrEqualTo</Equality>
        </ClsBlendPlanUtilities.ClsFormulationNutrientBreakdown>
        <ClsBlendPlanUtilities.ClsFormulationNutrientBreakdown>
          <BreakdownPercentage>1.1</BreakdownPercentage>
          <BreakdownType>AmmoniacalNitrogen</BreakdownType>
          <Equality>LessThanOrEqualTo</Equality>
        </ClsBlendPlanUtilities.ClsFormulationNutrientBreakdown>
      </NutrientBreakdowns>
      <NutrientType>N</NutrientType>
      <NutrientValue>1.1</NutrientValue>
    </ClsBlendPlanUtilities.ClsFormulationRequestNutrients>
  </Nutrients>
  <OptimizeByPriceLevel>List</OptimizeByPriceLevel>
  <Quantity>3.1</Quantity>
</ClsBlendPlanUtilities.ClsFormulationRequest>

application/x-www-form-urlencoded

Sample:

Failed to generate the sample for media type 'application/x-www-form-urlencoded'. Cannot use formatter 'JQueryMvcFormUrlEncodedFormatter' to write type 'ClsFormulationRequest'.

Response Information

Resource Description

Calculates the formulation request using Agvance logic returning the calculated product information.

AgvBlendTicketFormulation
NameDescriptionTypeAdditional Information
Status

Status of the API call.

string
Message

Message of the API call.

string
Count

Count of how many Product JSON dictionaries.

string
ProductList

JSON dictionary of Products

Collection of ClsRecalculatePlanBlendResponseProduct

Response Formats

application/json, text/json

Sample:
{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "Count": "2",
  "ProductList": [
    {
      "DepartmentID": "sample string 35",
      "ProductID": "sample string 36",
      "ProductGUID": "f16054d9-4c3d-4421-a8b7-40a2197fb1a2",
      "ProductName": "sample string 38",
      "RatePerUnitAmount": 39.1,
      "RatingUOM": "sample string 40",
      "TotalRatingAmount": 41.1,
      "MixedAmount": 42.1,
      "MixingUOM": "sample string 43",
      "MixingScale": 44,
      "InventoryAmount": 45.1,
      "InventoryUOM": "sample string 46",
      "TotalPoundsInTheMix": 47.1
    },
    {
      "DepartmentID": "sample string 35",
      "ProductID": "sample string 36",
      "ProductGUID": "f16054d9-4c3d-4421-a8b7-40a2197fb1a2",
      "ProductName": "sample string 38",
      "RatePerUnitAmount": 39.1,
      "RatingUOM": "sample string 40",
      "TotalRatingAmount": 41.1,
      "MixedAmount": 42.1,
      "MixingUOM": "sample string 43",
      "MixingScale": 44,
      "InventoryAmount": 45.1,
      "InventoryUOM": "sample string 46",
      "TotalPoundsInTheMix": 47.1
    }
  ]
}

application/xml, text/xml

Sample:
<AgvBlendTicketFormulation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Blend">
  <Message>sample string 2</Message>
  <ProductList xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.plbl">
    <d2p1:ClsBlendPlanUtilities.ClsRecalculatePlanBlendResponseProduct>
      <d2p1:DepartmentID>sample string 35</d2p1:DepartmentID>
      <d2p1:InventoryAmount>45.1</d2p1:InventoryAmount>
      <d2p1:InventoryUOM>sample string 46</d2p1:InventoryUOM>
      <d2p1:MixedAmount>42.1</d2p1:MixedAmount>
      <d2p1:MixingScale>44</d2p1:MixingScale>
      <d2p1:MixingUOM>sample string 43</d2p1:MixingUOM>
      <d2p1:ProductGUID>f16054d9-4c3d-4421-a8b7-40a2197fb1a2</d2p1:ProductGUID>
      <d2p1:ProductID>sample string 36</d2p1:ProductID>
      <d2p1:ProductName>sample string 38</d2p1:ProductName>
      <d2p1:RatePerUnitAmount>39.1</d2p1:RatePerUnitAmount>
      <d2p1:RatingUOM>sample string 40</d2p1:RatingUOM>
      <d2p1:TotalPoundsInTheMix>47.1</d2p1:TotalPoundsInTheMix>
      <d2p1:TotalRatingAmount>41.1</d2p1:TotalRatingAmount>
    </d2p1:ClsBlendPlanUtilities.ClsRecalculatePlanBlendResponseProduct>
    <d2p1:ClsBlendPlanUtilities.ClsRecalculatePlanBlendResponseProduct>
      <d2p1:DepartmentID>sample string 35</d2p1:DepartmentID>
      <d2p1:InventoryAmount>45.1</d2p1:InventoryAmount>
      <d2p1:InventoryUOM>sample string 46</d2p1:InventoryUOM>
      <d2p1:MixedAmount>42.1</d2p1:MixedAmount>
      <d2p1:MixingScale>44</d2p1:MixingScale>
      <d2p1:MixingUOM>sample string 43</d2p1:MixingUOM>
      <d2p1:ProductGUID>f16054d9-4c3d-4421-a8b7-40a2197fb1a2</d2p1:ProductGUID>
      <d2p1:ProductID>sample string 36</d2p1:ProductID>
      <d2p1:ProductName>sample string 38</d2p1:ProductName>
      <d2p1:RatePerUnitAmount>39.1</d2p1:RatePerUnitAmount>
      <d2p1:RatingUOM>sample string 40</d2p1:RatingUOM>
      <d2p1:TotalPoundsInTheMix>47.1</d2p1:TotalPoundsInTheMix>
      <d2p1:TotalRatingAmount>41.1</d2p1:TotalRatingAmount>
    </d2p1:ClsBlendPlanUtilities.ClsRecalculatePlanBlendResponseProduct>
  </ProductList>
  <Status>sample string 1</Status>
</AgvBlendTicketFormulation>