POST GrainReports/GetDeliveredGrainReport

Generate a Delivered Grain report

Request Information

URI Parameters

Body Parameters

The request object used to create report

Name	Description	Type	Additional Information
CustomerID	Agvance Customer ID	string	Required Max length: 6
StartDate	Start Date	string	Required
EndDate	End Date	string	Required
ReportStyle	Report style - Commodity, Farm, or Location	string	Required
PrimarySort	Primary Sort - Commodity, Farm, Field, or Location. Must not be the same as the Report style.	string	Required
SecondarySort	Secondary Sort - Commodity, Farm, Field, or Location. Must not be the same as the Report style.	string
FarmGuid	Guid of the Farm	globally unique identifier
NewPagePerFarm	For Farm Style Reports, make a New Page per Farm	boolean	Must be 0, 1, True, or False

Request Formats

application/json, text/json

Sample:

{
  "CustomerID": "sample string 1",
  "StartDate": "sample string 2",
  "EndDate": "sample string 3",
  "ReportStyle": "sample string 4",
  "PrimarySort": "sample string 5",
  "SecondarySort": "sample string 6",
  "FarmGuid": "b26ec055-42c5-4899-9200-7e3b4bbe4290",
  "NewPagePerFarm": true
}

application/xml, text/xml

Sample:

<DeliveredGrainReportRequestBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.ApiReports">
  <CustomerID>sample string 1</CustomerID>
  <EndDate>sample string 3</EndDate>
  <FarmGuid>b26ec055-42c5-4899-9200-7e3b4bbe4290</FarmGuid>
  <NewPagePerFarm>true</NewPagePerFarm>
  <PrimarySort>sample string 5</PrimarySort>
  <ReportStyle>sample string 4</ReportStyle>
  <SecondarySort>sample string 6</SecondarySort>
  <StartDate>sample string 2</StartDate>
</DeliveredGrainReportRequestBody>

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

Response Information

Resource Description

Generate a Delivered Grain report

AgvDeliveredGrainReport

Name	Description	Type	Additional Information
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
S3FileName	The S3 file that was generated for the requested Delivered Grain Report	string	Will be "null" when the status is not success.
PreSignedUrl	The presigned url of the file	string	Will be "null" when the S3FileName is not populated.

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

application/xml, text/xml

Sample:

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