POST Obligation/PostObligation

Creates an Obligation

Request Information

URI Parameters

Body Parameters

Name	Description	Type	Additional Information
ObligationNumber	Obligation #	integer
GrowerId	Id of the Customer on the Obligation	string	Required Max length: 6
ContractSigned	Signature status of the Obligation	boolean
LocationId	Id of the Location on the Obligaion	string	Required Max length: 6
Commodity	Id of the Commodity on the Obligaion	string	Required Max length: 6
DateEstablished	Date the Obligation was established	date	Required
ExpirationDate	Expiration date of the Obligation	date
PriceByDate	Price by date of the Obligation	date
ObligationType	Obligation Type Id	string	Required Max length: 50
ObligationStatus	Current status of an Obligation	ObligationStatusEnum	Required
MinPrice	Minimum price of an Obligation	decimal number	Max of 5 decimal places
MaxPrice	Maximum price of an Obligation	decimal number	Max of 5 decimal places
SalespersonId	Id of the sales person listed on the obligation	string	Max length: 15
FarmName	Id of the FarmId listed on the obligation	string	Max length: 8
ObligationQuantity	Quantity listed on the Obligation	decimal number	Required
FuturesMonth	Futures Month listed on the Obligation	string	Max length: 10
ExchangeId	Exchange Id on the Obligation	string	Max length: 10
BidCriteria	Bid Criteria Id on the Obligation	string	Max length: 20
ObligationFormat	Obligation Format Id on the Obligation	string	Required Max length: 50
AssignBuyerSignatureFromApi	Buyer signature on the Obligation sent from the api	string	Max length: 3
BuyerSignatureDateToPrint	Buyer signature date to print on the Obligation	date
BuyerSignatureDateTimeUtc	Buyer Signature Date on the Obligation	date
ObligationComments	List of comments associated with the obligation	Collection of clsObligationCommAdd
ObligationDeliveryDates	List of delivery dates for the obligation	Collection of clsObligationDDAdd
ObligationMinimumPriceInfo	List of minimum price roll records	Collection of clsObligationRolAdd

Request Formats

application/json, text/json

Sample:

{
  "ObligationNumber": 1,
  "GrowerId": "sample string 2",
  "ContractSigned": true,
  "LocationId": "sample string 4",
  "Commodity": "sample string 5",
  "DateEstablished": "2025-05-15T14:19:42.9396388+00:00",
  "ExpirationDate": "2025-05-15T14:19:42.9396388+00:00",
  "PriceByDate": "2025-05-15T14:19:42.9399447+00:00",
  "ObligationType": "sample string 7",
  "ObligationStatus": 1,
  "MinPrice": 8.1,
  "MaxPrice": 9.1,
  "SalespersonId": "sample string 10",
  "FarmName": "sample string 11",
  "ObligationQuantity": 12.1,
  "FuturesMonth": "sample string 13",
  "ExchangeId": "sample string 14",
  "BidCriteria": "sample string 15",
  "ObligationFormat": "sample string 16",
  "AssignBuyerSignatureFromApi": "sample string 17",
  "BuyerSignatureDateToPrint": "2025-05-15T14:19:42.9402694+00:00",
  "BuyerSignatureDateTimeUtc": "2025-05-15T14:19:42.9402694+00:00",
  "ObligationComments": [
    {
      "Comment": "sample string 1"
    },
    {
      "Comment": "sample string 1"
    }
  ],
  "ObligationDeliveryDates": [
    {
      "StartDate": "sample string 1",
      "EndDate": "sample string 2",
      "Quantity": 3.1
    },
    {
      "StartDate": "sample string 1",
      "EndDate": "sample string 2",
      "Quantity": 3.1
    }
  ],
  "ObligationMinimumPriceInfo": [
    {
      "FuturesPrice": 1.1,
      "BasisPrice": 2.1,
      "BuyOptionPrice": 3.1,
      "BuyOptionMonth": "sample string 4",
      "BuyOptionPorC": "sample string 5",
      "BuyOptionStrike": 6.1,
      "SellOptionPrice": 7.1,
      "SellOptionMonth": "sample string 8",
      "SellOptionPorC": "sample string 9",
      "SellOptionStrike": 10.1,
      "Storage": 11.1,
      "ServiceCharge": 12.1,
      "MinimumPrice": 13.1,
      "Expiration": "2025-05-15T14:19:42.9407267+00:00",
      "Comments": "sample string 14"
    },
    {
      "FuturesPrice": 1.1,
      "BasisPrice": 2.1,
      "BuyOptionPrice": 3.1,
      "BuyOptionMonth": "sample string 4",
      "BuyOptionPorC": "sample string 5",
      "BuyOptionStrike": 6.1,
      "SellOptionPrice": 7.1,
      "SellOptionMonth": "sample string 8",
      "SellOptionPorC": "sample string 9",
      "SellOptionStrike": 10.1,
      "Storage": 11.1,
      "ServiceCharge": 12.1,
      "MinimumPrice": 13.1,
      "Expiration": "2025-05-15T14:19:42.9407267+00:00",
      "Comments": "sample string 14"
    }
  ]
}

application/xml, text/xml

Sample:

<ClsObligation.clsObligationAdd xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SKY.Core.Grain">
  <AssignBuyerSignatureFromApi>sample string 17</AssignBuyerSignatureFromApi>
  <BidCriteria>sample string 15</BidCriteria>
  <BuyerSignatureDateTimeUtc>2025-05-15T14:19:42.9402694+00:00</BuyerSignatureDateTimeUtc>
  <BuyerSignatureDateToPrint>2025-05-15T14:19:42.9402694+00:00</BuyerSignatureDateToPrint>
  <Commodity>sample string 5</Commodity>
  <ContractSigned>true</ContractSigned>
  <DateEstablished>2025-05-15T14:19:42.9396388+00:00</DateEstablished>
  <ExchangeId>sample string 14</ExchangeId>
  <ExpirationDate>2025-05-15T14:19:42.9396388+00:00</ExpirationDate>
  <FarmName>sample string 11</FarmName>
  <FuturesMonth>sample string 13</FuturesMonth>
  <GrowerId>sample string 2</GrowerId>
  <LocationId>sample string 4</LocationId>
  <MaxPrice>9.1</MaxPrice>
  <MinPrice>8.1</MinPrice>
  <ObligationComments>
    <ClsObligation.clsObligationAdd.clsObligationCommAdd>
      <Comment>sample string 1</Comment>
    </ClsObligation.clsObligationAdd.clsObligationCommAdd>
    <ClsObligation.clsObligationAdd.clsObligationCommAdd>
      <Comment>sample string 1</Comment>
    </ClsObligation.clsObligationAdd.clsObligationCommAdd>
  </ObligationComments>
  <ObligationDeliveryDates>
    <ClsObligation.clsObligationAdd.clsObligationDDAdd>
      <EndDate>sample string 2</EndDate>
      <Quantity>3.1</Quantity>
      <StartDate>sample string 1</StartDate>
    </ClsObligation.clsObligationAdd.clsObligationDDAdd>
    <ClsObligation.clsObligationAdd.clsObligationDDAdd>
      <EndDate>sample string 2</EndDate>
      <Quantity>3.1</Quantity>
      <StartDate>sample string 1</StartDate>
    </ClsObligation.clsObligationAdd.clsObligationDDAdd>
  </ObligationDeliveryDates>
  <ObligationFormat>sample string 16</ObligationFormat>
  <ObligationMinimumPriceInfo>
    <ClsObligation.clsObligationAdd.clsObligationRolAdd>
      <BasisPrice>2.1</BasisPrice>
      <BuyOptionMonth>sample string 4</BuyOptionMonth>
      <BuyOptionPorC>sample string 5</BuyOptionPorC>
      <BuyOptionPrice>3.1</BuyOptionPrice>
      <BuyOptionStrike>6.1</BuyOptionStrike>
      <Comments>sample string 14</Comments>
      <Expiration>2025-05-15T14:19:42.9407267+00:00</Expiration>
      <FuturesPrice>1.1</FuturesPrice>
      <MinimumPrice>13.1</MinimumPrice>
      <SellOptionMonth>sample string 8</SellOptionMonth>
      <SellOptionPorC>sample string 9</SellOptionPorC>
      <SellOptionPrice>7.1</SellOptionPrice>
      <SellOptionStrike>10.1</SellOptionStrike>
      <ServiceCharge>12.1</ServiceCharge>
      <Storage>11.1</Storage>
    </ClsObligation.clsObligationAdd.clsObligationRolAdd>
    <ClsObligation.clsObligationAdd.clsObligationRolAdd>
      <BasisPrice>2.1</BasisPrice>
      <BuyOptionMonth>sample string 4</BuyOptionMonth>
      <BuyOptionPorC>sample string 5</BuyOptionPorC>
      <BuyOptionPrice>3.1</BuyOptionPrice>
      <BuyOptionStrike>6.1</BuyOptionStrike>
      <Comments>sample string 14</Comments>
      <Expiration>2025-05-15T14:19:42.9407267+00:00</Expiration>
      <FuturesPrice>1.1</FuturesPrice>
      <MinimumPrice>13.1</MinimumPrice>
      <SellOptionMonth>sample string 8</SellOptionMonth>
      <SellOptionPorC>sample string 9</SellOptionPorC>
      <SellOptionPrice>7.1</SellOptionPrice>
      <SellOptionStrike>10.1</SellOptionStrike>
      <ServiceCharge>12.1</ServiceCharge>
      <Storage>11.1</Storage>
    </ClsObligation.clsObligationAdd.clsObligationRolAdd>
  </ObligationMinimumPriceInfo>
  <ObligationNumber>1</ObligationNumber>
  <ObligationQuantity>12.1</ObligationQuantity>
  <ObligationStatus>Open</ObligationStatus>
  <ObligationType>sample string 7</ObligationType>
  <PriceByDate>2025-05-15T14:19:42.9399447+00:00</PriceByDate>
  <SalespersonId>sample string 10</SalespersonId>
</ClsObligation.clsObligationAdd>

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

Response Information

Resource Description

Creates an Obligation

AgvObligation

Name	Description	Type
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 Obligations.	string
Data		Collection of ClsObligation

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": [
    {
      "ObligationGuid": "b4594f22-76a5-48d6-af68-8b82a70cbddb",
      "ObligationNumber": 14,
      "LocationId": "sample string 16"
    },
    {
      "ObligationGuid": "b4594f22-76a5-48d6-af68-8b82a70cbddb",
      "ObligationNumber": 14,
      "LocationId": "sample string 16"
    }
  ]
}

application/xml, text/xml

Sample:

<AgvObligation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.Contract.Obligation">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/SKY.Core.Grain">
    <d2p1:ClsObligation>
      <d2p1:LocationId>sample string 16</d2p1:LocationId>
      <d2p1:ObligationGuid>b4594f22-76a5-48d6-af68-8b82a70cbddb</d2p1:ObligationGuid>
      <d2p1:ObligationNumber>14</d2p1:ObligationNumber>
    </d2p1:ClsObligation>
    <d2p1:ClsObligation>
      <d2p1:LocationId>sample string 16</d2p1:LocationId>
      <d2p1:ObligationGuid>b4594f22-76a5-48d6-af68-8b82a70cbddb</d2p1:ObligationGuid>
      <d2p1:ObligationNumber>14</d2p1:ObligationNumber>
    </d2p1:ClsObligation>
  </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>
</AgvObligation>