POST SettlementDocument/GetSettlementContractDocument

Get a settlement contract document

Request Information

URI Parameters

Body Parameters

The request object used to create the contract

clsSettlementContractDocument

Name	Description	Type	Additional Information
Settlement	Settlement	string	Required Max length: 10
LocationId	LocationId	string	Required Max length: 6
Contracts	Contracts	Collection of SettlementContractDetail	Required List cannot be empty

Name

Description

Type

Additional Information

Settlement

string

Required

Max length: 10

LocationId

string

Required

Max length: 6

Contracts

Collection of SettlementContractDetail

Required

List cannot be empty

Request Formats

application/json, text/json

Sample:

{
  "Settlement": "sample string 1",
  "LocationId": "sample string 2",
  "Contracts": [
    {
      "ToDPR": "sample string 1",
      "Contract": "sample string 2"
    },
    {
      "ToDPR": "sample string 1",
      "Contract": "sample string 2"
    }
  ]
}

application/xml, text/xml

Sample:

<clsSettlementContractDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.Grain">
  <Contracts>
    <clsSettlementContractDocument.SettlementContractDetail>
      <Contract>sample string 2</Contract>
      <ToDPR>sample string 1</ToDPR>
    </clsSettlementContractDocument.SettlementContractDetail>
    <clsSettlementContractDocument.SettlementContractDetail>
      <Contract>sample string 2</Contract>
      <ToDPR>sample string 1</ToDPR>
    </clsSettlementContractDocument.SettlementContractDetail>
  </Contracts>
  <LocationId>sample string 2</LocationId>
  <Settlement>sample string 1</Settlement>
</clsSettlementContractDocument>

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

Response Information

Resource Description

Get a settlement contract document

AgvSettlementContractDocument

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
Documents	The list of documents created	Collection of SettlementContractDocumentDetail	Will be "null" when the status is not success.

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"
  ],
  "Documents": [
    {
      "ToDPR": "sample string 1",
      "Contract": "sample string 2",
      "PreSignedUrl": "sample string 3"
    },
    {
      "ToDPR": "sample string 1",
      "Contract": "sample string 2",
      "PreSignedUrl": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<AgvSettlementContractDocument xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.SettlementDocument">
  <Documents xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI.Grain">
    <d2p1:clsSettlementContractDocument.SettlementContractDocumentDetail>
      <d2p1:Contract>sample string 2</d2p1:Contract>
      <d2p1:PreSignedUrl>sample string 3</d2p1:PreSignedUrl>
      <d2p1:ToDPR>sample string 1</d2p1:ToDPR>
    </d2p1:clsSettlementContractDocument.SettlementContractDocumentDetail>
    <d2p1:clsSettlementContractDocument.SettlementContractDocumentDetail>
      <d2p1:Contract>sample string 2</d2p1:Contract>
      <d2p1:PreSignedUrl>sample string 3</d2p1:PreSignedUrl>
      <d2p1:ToDPR>sample string 1</d2p1:ToDPR>
    </d2p1:clsSettlementContractDocument.SettlementContractDocumentDetail>
  </Documents>
  <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>
  <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>
</AgvSettlementContractDocument>