POST GrainReports/GetDprTprReport

Generate a Combined DPR/TPR Report

Request Information

URI Parameters

Body Parameters

The request object used to create the report

Name	Description	Type	Additional Information
FormType	Type of Form to be reutnred	FormTypeEnum	Required
PrintAcross	Amount of columns to print 1,2,3,4	string	Required
Commodities	Commodities to include in the report	Collection of string	Required
Locations	Locations to include in the report	Collection of string	Required
CombinLocationCommodity	Combine Commodites and Locations in the report	boolean
PrintLocationsIndividually	Print Locations individualy in the report	boolean
PrintDecimals	Print decimals	boolean
PrintCommas	Commas	boolean
ExcludeBasisFixed	Exclude Basis Fixed from the DPR Calcuations	boolean
IncludeBasisFixedinNetBasis	Include Basis Fixed in Net Basis	boolean
ExcludeUnsignedContracts	Exclude unsidged contracts (PLBF, MP) from TPR	boolean
Redeposited	Include Redeposited	boolean
UnaprovedStorage	Include Unaproved Storage	boolean
NewPageBeforeFuturesOptions	Include Page Before Futures/Optons	boolean
Futures	Include Futures	boolean
Options	Include Options	boolean
CompOwnedAdjustRecap	Print Company Owned Adjustment Recap	boolean
ReportDate	Given Report Date	string	Required Format must be MM/dd/yyyy
CurrentPosition	Current Position	boolean
DPR	DPR	boolean
DPRRange	DPR Range/Date Range	boolean
StartDPR	Start DPR range	string
EndDPR	End DPR range	string
HistoryDate	History Date range	boolean
StartHistoryDate	Start History Date range	string
EndHistoryDate	End History Date range	string
ObligationHeader	Obligation Heading	string

Request Formats

application/json, text/json

Sample:

{
  "FormType": 1,
  "PrintAcross": "sample string 1",
  "Commodities": [
    "sample string 1",
    "sample string 2"
  ],
  "Locations": [
    "sample string 1",
    "sample string 2"
  ],
  "CombinLocationCommodity": true,
  "PrintLocationsIndividually": true,
  "PrintDecimals": true,
  "PrintCommas": true,
  "ExcludeBasisFixed": true,
  "IncludeBasisFixedinNetBasis": true,
  "ExcludeUnsignedContracts": true,
  "Redeposited": true,
  "UnaprovedStorage": true,
  "NewPageBeforeFuturesOptions": true,
  "Futures": true,
  "Options": true,
  "CompOwnedAdjustRecap": true,
  "ReportDate": "sample string 15",
  "CurrentPosition": true,
  "DPR": true,
  "DPRRange": true,
  "StartDPR": "sample string 19",
  "EndDPR": "sample string 20",
  "HistoryDate": true,
  "StartHistoryDate": "sample string 22",
  "EndHistoryDate": "sample string 23",
  "ObligationHeader": "sample string 24"
}

application/xml, text/xml

Sample:

<CombinedDprTprReport.CombinedDPRTPRReportRequestBody xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.ApiReports">
  <CombinLocationCommodity>true</CombinLocationCommodity>
  <Commodities xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Commodities>
  <CompOwnedAdjustRecap>true</CompOwnedAdjustRecap>
  <CurrentPosition>true</CurrentPosition>
  <DPR>true</DPR>
  <DPRRange>true</DPRRange>
  <EndDPR>sample string 20</EndDPR>
  <EndHistoryDate>sample string 23</EndHistoryDate>
  <ExcludeBasisFixed>true</ExcludeBasisFixed>
  <ExcludeUnsignedContracts>true</ExcludeUnsignedContracts>
  <FormType>Standard</FormType>
  <Futures>true</Futures>
  <HistoryDate>true</HistoryDate>
  <IncludeBasisFixedinNetBasis>true</IncludeBasisFixedinNetBasis>
  <Locations xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>sample string 1</d2p1:string>
    <d2p1:string>sample string 2</d2p1:string>
  </Locations>
  <NewPageBeforeFuturesOptions>true</NewPageBeforeFuturesOptions>
  <ObligationHeader>sample string 24</ObligationHeader>
  <Options>true</Options>
  <PrintAcross>sample string 1</PrintAcross>
  <PrintCommas>true</PrintCommas>
  <PrintDecimals>true</PrintDecimals>
  <PrintLocationsIndividually>true</PrintLocationsIndividually>
  <Redeposited>true</Redeposited>
  <ReportDate>sample string 15</ReportDate>
  <StartDPR>sample string 19</StartDPR>
  <StartHistoryDate>sample string 22</StartHistoryDate>
  <UnaprovedStorage>true</UnaprovedStorage>
</CombinedDprTprReport.CombinedDPRTPRReportRequestBody>

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

Response Information

Resource Description

Generate a Combined DPR/TPR Report

AgvCombindedDprTprReport

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.
SecondaryPreSignedUrl	The presigned url of a secondaryfile 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",
  "SecondaryPreSignedUrl": "sample string 4"
}

application/xml, text/xml

Sample:

<AgvCombindedDprTprReport 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 3</PreSignedUrl>
  <SecondaryPreSignedUrl>sample string 4</SecondaryPreSignedUrl>
  <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>
</AgvCombindedDprTprReport>