POST AgrReports/GetGrowerSummaryReport

Generate a Grower Summary report

Request Information

URI Parameters

Body Parameters

The request object used to create report

Name	Description	Type	Additional Information
SendToS3Description	The Description that is used to display in G360 for this grower summary report	string	Required Max length: 250
CurrentLocationID	The Current Location ID for the report creation	string	Required Max length: 6
ReportDateAndTime	The Date and Time to print at the bottom of the report	date	Required
CustomerID	Agvance Customer ID	string	Required Max length: 6
StartDate	Start Date (If provided - must also include the end date)	date
EndDate	End Date (If provided - must also include the start date)	date
NewPageBreak	Determines the page breaks for the report: 0 = None, 1 = Each Customer, 2 = Each Field	PageBreak
PrintWhichCustomers	Determines which customers to print: 0 = All, 1 = Growers Only, 2 = Landlords Only	CustomersToPrint
PrintProductRecap	Include the product recap	boolean
PrintProductRecapOnNewPage	When the PrintProductRecap is true, insert a page break before printing	boolean
PrintCustomerProductRecap	Include the Customer / Product recap	boolean
PrintCustomerCostRecap	Include the Custoemr Cost Recap	boolean
CostPerAcreAsGrowersShareOnly	When printing the Cost / Acre, calculate as the customer's share only	boolean
SuppressCostPerUnit	Hide the cost per unit on the report - only honored when 'ShowProfit' = false	boolean
SuppressCostOfYourShare	Hide the cost of the customer's share on the report - only honored when 'ShowProfit' = false	boolean
SuppressCostPerAcre	Hide the cost per acre on the report - only honored when 'ShowProfit' = false	boolean
ShowBlendedAnalysisRecap	Include the Blended Analysis recap per field	boolean
IncludeFarmGroupBy	Group the report by farm	boolean
ShowProfit	Report option to show the profit information based on the current costs saved with the plan to the selling price	boolean
SelectedPlans	The selected plans to run the grower summary report for These will be filtered by the date range if provided and for user login restrictions of the plan location	Collection of SelectedFieldPlan	Required List cannot be empty

Request Formats

application/json, text/json

Sample:

{
  "SendToS3Description": "sample string 1",
  "CurrentLocationID": "sample string 2",
  "ReportDateAndTime": "2025-05-15T15:08:25.8420425+00:00",
  "CustomerID": "sample string 3",
  "StartDate": "2025-05-15T15:08:25.8420425+00:00",
  "EndDate": "2025-05-15T15:08:25.8420425+00:00",
  "NewPageBreak": 0,
  "PrintWhichCustomers": 0,
  "PrintProductRecap": true,
  "PrintProductRecapOnNewPage": true,
  "PrintCustomerProductRecap": true,
  "PrintCustomerCostRecap": true,
  "CostPerAcreAsGrowersShareOnly": true,
  "SuppressCostPerUnit": true,
  "SuppressCostOfYourShare": true,
  "SuppressCostPerAcre": true,
  "ShowBlendedAnalysisRecap": true,
  "IncludeFarmGroupBy": true,
  "ShowProfit": true,
  "SelectedPlans": [
    {
      "GrowerID": "sample string 1",
      "FieldID": "sample string 2",
      "AreaID": "sample string 3",
      "PlanID": "sample string 4",
      "PlanGUID": "64b3b005-3728-4c86-b97c-8380002d45f2"
    },
    {
      "GrowerID": "sample string 1",
      "FieldID": "sample string 2",
      "AreaID": "sample string 3",
      "PlanID": "sample string 4",
      "PlanGUID": "64b3b005-3728-4c86-b97c-8380002d45f2"
    }
  ]
}

application/xml, text/xml

Sample:

<GrowerSummaryReportRequestBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.ApiReports">
  <CostPerAcreAsGrowersShareOnly>true</CostPerAcreAsGrowersShareOnly>
  <CurrentLocationID>sample string 2</CurrentLocationID>
  <CustomerID>sample string 3</CustomerID>
  <EndDate>2025-05-15T15:08:25.8420425+00:00</EndDate>
  <IncludeFarmGroupBy>true</IncludeFarmGroupBy>
  <NewPageBreak>None</NewPageBreak>
  <PrintCustomerCostRecap>true</PrintCustomerCostRecap>
  <PrintCustomerProductRecap>true</PrintCustomerProductRecap>
  <PrintProductRecap>true</PrintProductRecap>
  <PrintProductRecapOnNewPage>true</PrintProductRecapOnNewPage>
  <PrintWhichCustomers>All</PrintWhichCustomers>
  <ReportDateAndTime>2025-05-15T15:08:25.8420425+00:00</ReportDateAndTime>
  <SelectedPlans>
    <GrowerSummaryReport.SelectedFieldPlan>
      <AreaID>sample string 3</AreaID>
      <FieldID>sample string 2</FieldID>
      <GrowerID>sample string 1</GrowerID>
      <PlanGUID>64b3b005-3728-4c86-b97c-8380002d45f2</PlanGUID>
      <PlanID>sample string 4</PlanID>
    </GrowerSummaryReport.SelectedFieldPlan>
    <GrowerSummaryReport.SelectedFieldPlan>
      <AreaID>sample string 3</AreaID>
      <FieldID>sample string 2</FieldID>
      <GrowerID>sample string 1</GrowerID>
      <PlanGUID>64b3b005-3728-4c86-b97c-8380002d45f2</PlanGUID>
      <PlanID>sample string 4</PlanID>
    </GrowerSummaryReport.SelectedFieldPlan>
  </SelectedPlans>
  <SendToS3Description>sample string 1</SendToS3Description>
  <ShowBlendedAnalysisRecap>true</ShowBlendedAnalysisRecap>
  <ShowProfit>true</ShowProfit>
  <StartDate>2025-05-15T15:08:25.8420425+00:00</StartDate>
  <SuppressCostOfYourShare>true</SuppressCostOfYourShare>
  <SuppressCostPerAcre>true</SuppressCostPerAcre>
  <SuppressCostPerUnit>true</SuppressCostPerUnit>
</GrowerSummaryReportRequestBody>

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

Response Information

Resource Description

Generate a Grower Summary report

AgvAgronomyReport

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 errors from the API	Collection of string
WarningList	List of warnings from the API	Collection of string
PreSignedUrl	The presigned url of the file	string

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"
  ],
  "PreSignedUrl": "sample string 3"
}

application/xml, text/xml

Sample:

<AgvAgronomyReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.AgrReports">
  <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>
  <PreSignedUrl>sample string 3</PreSignedUrl>
  <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>
</AgvAgronomyReport>