POST BlendTicket/PostFormulateAnalysisFullDetail

Calculates the formulation request using Agvance logic returning the calculated product information. CAUTION: will include product detail when formulation cannot be met, and will also include the Request/Response object for Nutrients not met. DO NOT ASSUME IF products are returned that you have a valid formulation

Request Information

URI Parameters

Body Parameters

Request body to calculate the product quantities from

ClsFormulationFullDetailRequest

Name	Description	Type	Additional Information
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
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
Quantity	The quantity (acres) of the order to use for calculations	decimal number	Cannot be negative Max of 3 decimal places Must be filled out and numeric
LocationIdOrGuid	Identifier of the location for this order	string	Required Max length: 36
ProductSetIdOrGuid	Identifier of the current product set for this order	string	Required Max length: 36

Request Formats

application/json, text/json

Sample:

{
  "FormulateByGuaranteedAnalysis": true,
  "LbsOfAnalysis": 2.1,
  "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
        }
      ]
    }
  ],
  "Quantity": 5.1,
  "LocationIdOrGuid": "sample string 6",
  "ProductSetIdOrGuid": "sample string 7"
}

application/xml, text/xml

Sample:

<ClsBlendPlanUtilities.ClsFormulationFullDetailRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.plbl">
  <LocationIdOrGuid>sample string 6</LocationIdOrGuid>
  <ProductSetIdOrGuid>sample string 7</ProductSetIdOrGuid>
  <Quantity>5.1</Quantity>
  <FormulateByGuaranteedAnalysis>true</FormulateByGuaranteedAnalysis>
  <LbsOfAnalysis>2.1</LbsOfAnalysis>
  <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>
</ClsBlendPlanUtilities.ClsFormulationFullDetailRequest>

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 'ClsFormulationFullDetailRequest'.

Response Information

Resource Description

AgvBlendTicketFormulationFullWithErrorObject

Name	Description	Type
Status	0 = Success. 1 = An error occurred. 2 = An error occurred. 3 = Descriptive message, process was successful.	string
Message	Informational message that corresponds to the Status returned. 0 - Message will be "OK". 1 - Detailed message returned to give user an indication of what went wrong. 2 - Less Detailed message returned that may not mean anything to the user but that the application might use to take a corrective action. 3 - Not an error but something the user might need to know.	string
ErrorList	List of error messages of the API call.	Collection of string
WarningList	List of warning messages of the API call.	Collection of string
Count	Number of results returned.	string
Data	Calculated Order Response with Quantity and Products updated.	ClsCalculationResponse
NutrientErrorObj	If not null, list of nutrients requested that could not be fulfulled from the formulation blend set.	ClsFormulationResponseNutrients

Response Formats

application/json, text/json

Sample:

{
  "Status": "sample string 1",
  "Message": "sample string 2",
  "ErrorList": [
    "sample string 1",
    "sample string 2"
  ],
  "WarningList": [
    "sample string 1",
    "sample string 2"
  ],
  "Count": null,
  "Data": null,
  "NutrientErrorObj": {
    "Nutrients": [
      {
        "Nutrient": 0,
        "Requested": 1.1,
        "Returned": 2.1
      },
      {
        "Nutrient": 0,
        "Requested": 1.1,
        "Returned": 2.1
      }
    ]
  }
}

application/xml, text/xml

Sample:

<AgvBlendTicketFormulationFullWithErrorObject xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Blend">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.PLBLM" i:nil="true" />
  <ErrorList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </ErrorList>
  <Message>sample string 2</Message>
  <NutrientErrorObj xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.plbl">
    <d2p1:Nutrients>
      <d2p1:ClsBlendPlanUtilities.ClsFormulationResponseNutrient>
        <d2p1:Nutrient>AmmoniacalNitrogen</d2p1:Nutrient>
        <d2p1:Requested>1.1</d2p1:Requested>
        <d2p1:Returned>2.1</d2p1:Returned>
      </d2p1:ClsBlendPlanUtilities.ClsFormulationResponseNutrient>
      <d2p1:ClsBlendPlanUtilities.ClsFormulationResponseNutrient>
        <d2p1:Nutrient>AmmoniacalNitrogen</d2p1:Nutrient>
        <d2p1:Requested>1.1</d2p1:Requested>
        <d2p1:Returned>2.1</d2p1:Returned>
      </d2p1:ClsBlendPlanUtilities.ClsFormulationResponseNutrient>
    </d2p1:Nutrients>
  </NutrientErrorObj>
  <Status>sample string 1</Status>
  <WarningList xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </WarningList>
</AgvBlendTicketFormulationFullWithErrorObject>