POST PurchaseOffer/PostPurchaseOfferContract

Create a purchase offer contract

Request Information

URI Parameters

Body Parameters

PurchaseOfferContractAdd
NameDescriptionTypeAdditional Information
Contract

ID of the Purchase Offer Contract

 string

Required

Max length: 15
Location

Location of the Purchase Offer Contract

 string

Required

Max length: 6
CustID

ID of the customer Purchase Offer Contract

 string

Required

Max length: 6
Commodity

ID of the commodity Purchase Offer Contract

 string

Required

Max length: 6
DateEst

Date Establised on the Purchase Offer Contract

 string

Required

Format must be MM/dd/yyyy
ExpireDate

Expiration date of the Purchase Offer Contract

 string

Format must be MM/dd/yyyy
ContractStatus

Status of the Purchase Offer Contract

 PurchaseOfferContractStatus

Required
ContractType

Type of the Purchase Offer Contract

 PurchaseOfferContractType

Required
ContractOfferStatus

Offer Status of the Purchase Offer Contract

 PurchaseOfferStatus

Required
SalesID

SalesPersonID on the Purchase Offer Contract

 string

Max length: 15
ShipDest

Shipping Destination on the Purchase Offer Contract

 string

Max length: 6
ContractQuantity

Quatintiy of units on the Purchase Offer Contract

 decimal number
ContractSigned

Signature status on the Purchase Offer Contract

 boolean
PricingNotes

Pricing notes on the Purchase Offer Contract

 string

Max length: 50
CashOP

Cash offer price on the Purchase Offer Contract

 decimal number

Max of 5 decimal places
FuturesOP

Futures offer price on the Purchase Offer Contract

 decimal number

Max of 5 decimal places
BasisOP

BasisPrice of the Purchase Offer Contract

 decimal number

Max of 5 decimal places
FuturesMonth

Futures month on the Purchase Offer Contract

 string

Max length: 10
Exchange

ExchangeID of the Purchase Offer Contract

 string

Max length: 10
BidCriteria

BidCriteriaID of the Purchase Offer Contract

 string

Max length: 20
DocumentFormatGuid

globally unique identifier
PurchaseOfferContractGradeFactors

List of Grade Factors and Schedules for the Purchase Offer Contract

 Collection of clsGrPurOffConGFAdd
PurchaseOfferContractComments

List of Comments for the Purchase Offer Contract

 Collection of clsGrPurOffConCommAdd
PurchaseOfferContractDeliveryDates

List of Delivery Dates for the Purchase Offer Contract

 Collection of clsGrPurOffConDdAdd

Request Formats

application/json, text/json

Sample: 
{
  "Contract": "sample string 1",
  "Location": "sample string 2",
  "CustID": "sample string 3",
  "Commodity": "sample string 4",
  "DateEst": "sample string 5",
  "ExpireDate": "sample string 6",
  "ContractStatus": 1,
  "ContractType": 1,
  "ContractOfferStatus": 1,
  "SalesID": "sample string 7",
  "ShipDest": "sample string 8",
  "ContractQuantity": 9.1,
  "ContractSigned": true,
  "PricingNotes": "sample string 11",
  "CashOP": 12.1,
  "FuturesOP": 13.1,
  "BasisOP": 14.1,
  "FuturesMonth": "sample string 15",
  "Exchange": "sample string 16",
  "BidCriteria": "sample string 17",
  "DocumentFormatGuid": "77dde840-f6f8-45e5-b945-9c4727380ae6",
  "PurchaseOfferContractGradeFactors": [
    {
      "PremiumDiscountGuid": "f7c2ef47-f79c-43fd-bd1f-fba8a71bc226",
      "GradeFactorId": "sample string 1",
      "ScheduleId": "sample string 2"
    },
    {
      "PremiumDiscountGuid": "f7c2ef47-f79c-43fd-bd1f-fba8a71bc226",
      "GradeFactorId": "sample string 1",
      "ScheduleId": "sample string 2"
    }
  ],
  "PurchaseOfferContractComments": [
    {
      "Comment": "sample string 1",
      "CommentDate": "sample string 2"
    },
    {
      "Comment": "sample string 1",
      "CommentDate": "sample string 2"
    }
  ],
  "PurchaseOfferContractDeliveryDates": [
    {
      "StartDate": "sample string 1",
      "CompleteDate": "sample string 2",
      "Quantity": "sample string 3"
    },
    {
      "StartDate": "sample string 1",
      "CompleteDate": "sample string 2",
      "Quantity": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample: 
<clsGRPurOffCon.PurchaseOfferContractAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI">
  <BasisOP>14.1</BasisOP>
  <BidCriteria>sample string 17</BidCriteria>
  <CashOP>12.1</CashOP>
  <Commodity>sample string 4</Commodity>
  <Contract>sample string 1</Contract>
  <ContractOfferStatus>Open</ContractOfferStatus>
  <ContractQuantity>9.1</ContractQuantity>
  <ContractSigned>true</ContractSigned>
  <ContractStatus>Open</ContractStatus>
  <ContractType>Priced</ContractType>
  <CustID>sample string 3</CustID>
  <DateEst>sample string 5</DateEst>
  <DocumentFormatGuid>77dde840-f6f8-45e5-b945-9c4727380ae6</DocumentFormatGuid>
  <Exchange>sample string 16</Exchange>
  <ExpireDate>sample string 6</ExpireDate>
  <FuturesMonth>sample string 15</FuturesMonth>
  <FuturesOP>13.1</FuturesOP>
  <Location>sample string 2</Location>
  <PricingNotes>sample string 11</PricingNotes>
  <PurchaseOfferContractComments>
    <clsGRPurOffCon.PurchaseOfferContractAdd.clsGrPurOffConCommAdd>
      <Comment>sample string 1</Comment>
      <CommentDate>sample string 2</CommentDate>
    </clsGRPurOffCon.PurchaseOfferContractAdd.clsGrPurOffConCommAdd>
    <clsGRPurOffCon.PurchaseOfferContractAdd.clsGrPurOffConCommAdd>
      <Comment>sample string 1</Comment>
      <CommentDate>sample string 2</CommentDate>
    </clsGRPurOffCon.PurchaseOfferContractAdd.clsGrPurOffConCommAdd>
  </PurchaseOfferContractComments>
  <PurchaseOfferContractDeliveryDates>
    <clsGRPurOffCon.PurchaseOfferContractAdd.clsGrPurOffConDdAdd>
      <CompleteDate>sample string 2</CompleteDate>
      <Quantity>sample string 3</Quantity>
      <StartDate>sample string 1</StartDate>
    </clsGRPurOffCon.PurchaseOfferContractAdd.clsGrPurOffConDdAdd>
    <clsGRPurOffCon.PurchaseOfferContractAdd.clsGrPurOffConDdAdd>
      <CompleteDate>sample string 2</CompleteDate>
      <Quantity>sample string 3</Quantity>
      <StartDate>sample string 1</StartDate>
    </clsGRPurOffCon.PurchaseOfferContractAdd.clsGrPurOffConDdAdd>
  </PurchaseOfferContractDeliveryDates>
  <PurchaseOfferContractGradeFactors>
    <clsGRPurOffCon.PurchaseOfferContractAdd.clsGrPurOffConGFAdd>
      <GradeFactorId>sample string 1</GradeFactorId>
      <PremiumDiscountGuid>f7c2ef47-f79c-43fd-bd1f-fba8a71bc226</PremiumDiscountGuid>
      <ScheduleId>sample string 2</ScheduleId>
    </clsGRPurOffCon.PurchaseOfferContractAdd.clsGrPurOffConGFAdd>
    <clsGRPurOffCon.PurchaseOfferContractAdd.clsGrPurOffConGFAdd>
      <GradeFactorId>sample string 1</GradeFactorId>
      <PremiumDiscountGuid>f7c2ef47-f79c-43fd-bd1f-fba8a71bc226</PremiumDiscountGuid>
      <ScheduleId>sample string 2</ScheduleId>
    </clsGRPurOffCon.PurchaseOfferContractAdd.clsGrPurOffConGFAdd>
  </PurchaseOfferContractGradeFactors>
  <SalesID>sample string 7</SalesID>
  <ShipDest>sample string 8</ShipDest>
</clsGRPurOffCon.PurchaseOfferContractAdd>

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

Response Information

Resource Description

Create a purchase offer contract

AgvPurchaseOfferContract
NameDescriptionTypeAdditional Information
Status

Status of the API call.

 string
Message

Message of the API call.

 string
ErrorList

List of Error Messages returned by the api

 Collection of string
WarningList

List of Warning Messages returned by the api

 Collection of string
Count

Count of how many purchase offer contracts.

 string
Data

Collection of clsGRPurOffCon

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"
  ],
  "Count": "2",
  "Data": [
    {
      "Contract": "sample string 24",
      "Location": "sample string 25",
      "PurchaseOfferContractGuid": "2fa5dbd7-faaf-43db-abe1-1fa8e2477787"
    },
    {
      "Contract": "sample string 24",
      "Location": "sample string 25",
      "PurchaseOfferContractGuid": "2fa5dbd7-faaf-43db-abe1-1fa8e2477787"
    }
  ]
}

application/xml, text/xml

Sample: 
<AgvPurchaseOfferContract xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Contract.PurchaseOffer">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SSI">
    <d2p1:clsGRPurOffCon>
      <d2p1:Contract>sample string 24</d2p1:Contract>
      <d2p1:Location>sample string 25</d2p1:Location>
      <d2p1:PurchaseOfferContractGuid>2fa5dbd7-faaf-43db-abe1-1fa8e2477787</d2p1:PurchaseOfferContractGuid>
    </d2p1:clsGRPurOffCon>
    <d2p1:clsGRPurOffCon>
      <d2p1:Contract>sample string 24</d2p1:Contract>
      <d2p1:Location>sample string 25</d2p1:Location>
      <d2p1:PurchaseOfferContractGuid>2fa5dbd7-faaf-43db-abe1-1fa8e2477787</d2p1:PurchaseOfferContractGuid>
    </d2p1:clsGRPurOffCon>
  </Data>
  <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>
</AgvPurchaseOfferContract>