POST GrainReports/GetGrainBalanceDetailReport

Generate a Grain Balance Detail Report

Request Information

URI Parameters

Body Parameters

The request object used to create the report

Name	Description	Type	Additional Information
Customers	List of Customers to run the Report for. Send [] or null to run for all Customers.	Collection of string
PrimarySort	Primary Sort order for the report.	PrimarySortEnum	Required
SecondarySort	Secondary Sort order for the report, defaults to None.	SecondarySortEnum
OnlyIncludeOpenObligations	Option to only inlcude open Obligations on the report. If Obligations are disabled, defaults to false.	boolean
PriceDetails	Price Details to be printed.	GrainBalanceDetailReportType	Required
PrintCustomerAddress	Option to Print the Customers's Address on the Report	boolean
GrainBalanceIncludeDetail	Option to print for Customers with balances > 0	boolean
ExcludeClosedContracts	Option to Exclude Clased Contracts	boolean
CurrentPrice	List of Current Prices for commoditys, only accipable if PriceDetails = CurrentPrice	Collection of CurrentCommodityPrices

Request Formats

application/json, text/json

Sample:

{
  "Customers": [
    "sample string 1",
    "sample string 2"
  ],
  "PrimarySort": 0,
  "SecondarySort": 0,
  "OnlyIncludeOpenObligations": true,
  "PriceDetails": 0,
  "PrintCustomerAddress": true,
  "GrainBalanceIncludeDetail": true,
  "ExcludeClosedContracts": true,
  "CurrentPrice": [
    {
      "CommodityId": "sample string 1",
      "Price": 2.1
    },
    {
      "CommodityId": "sample string 1",
      "Price": 2.1
    }
  ]
}

application/xml, text/xml

Sample:

<GrainBalanceDetailReport.GrainBalanceDetailBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.ApiReports">
  <CurrentPrice>
    <GrainBalanceDetailReport.CurrentCommodityPrices>
      <CommodityId>sample string 1</CommodityId>
      <Price>2.1</Price>
    </GrainBalanceDetailReport.CurrentCommodityPrices>
    <GrainBalanceDetailReport.CurrentCommodityPrices>
      <CommodityId>sample string 1</CommodityId>
      <Price>2.1</Price>
    </GrainBalanceDetailReport.CurrentCommodityPrices>
  </CurrentPrice>
  <Customers xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Customers>
  <ExcludeClosedContracts>true</ExcludeClosedContracts>
  <GrainBalanceIncludeDetail>true</GrainBalanceIncludeDetail>
  <OnlyIncludeOpenObligations>true</OnlyIncludeOpenObligations>
  <PriceDetails>NoPrice</PriceDetails>
  <PrimarySort>Commodity</PrimarySort>
  <PrintCustomerAddress>true</PrintCustomerAddress>
  <SecondarySort>None</SecondarySort>
</GrainBalanceDetailReport.GrainBalanceDetailBody>

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

Response Information

Resource Description

Generate a Grain Balance Detail Report

AgvGrainBalanceDetailReport

Name	Description	Type	Additional Information
Status	0 = Success. 1 = An error occurred.	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.	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	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"
  ],
  "PreSignedUrl": "sample string 3"
}

application/xml, text/xml

Sample:

<AgvGrainBalanceDetailReport xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.ToolGen">
  <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>
</AgvGrainBalanceDetailReport>