POST BlendTicket/PostRecalculateOrder

Recalculates the quantity and products needed to meet the requested value for the order.

Request Information

URI Parameters

Body Parameters

Request body to recalculate the order with

ClsRecalculateOrder
NameDescriptionTypeAdditional Information
MethodOfCalculation

The method of calculation. MethodNotSet (0) is not a valid request enumeration

MethodOfOrderCalcualtionEnum

Required

RequestedAdjustment

The value to adjust the order by

decimal number

Max of 3 decimal places

Must be filled out and numeric

Quantity

The quantity (acres) of the order use for calculations

decimal number

Cannot be negative

Max of 3 decimal places

Must be filled out and numeric

LocationGUID

Unique identifier of the location for this order

globally unique identifier

Required

ProductSetID

Identifier of the current product set to use for key inventory item calculation

string

Required

CurrentProductList

List of products currently on the order

Collection of ClsRecalculateOrderProduct

List cannot be empty

Request Formats

application/json, text/json

Sample:
{
  "MethodOfCalculation": 0,
  "RequestedAdjustment": 7.1,
  "Quantity": 8.1,
  "LocationGUID": "213330a5-340d-4eaa-af79-6c0c41672854",
  "ProductSetID": "sample string 10",
  "CurrentProductList": [
    {
      "ProductGuid": "6b7693b2-7906-4da3-bafc-85129257c3f8",
      "RatePerUnitAmount": 2.1,
      "MixingScale": 3,
      "ProductIsCarrier": true
    },
    {
      "ProductGuid": "6b7693b2-7906-4da3-bafc-85129257c3f8",
      "RatePerUnitAmount": 2.1,
      "MixingScale": 3,
      "ProductIsCarrier": true
    }
  ]
}

application/xml, text/xml

Sample:
<ClsBlendPlanUtilities.ClsRecalculateOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI.plbl">
  <CurrentProductList>
    <ClsBlendPlanUtilities.ClsRecalculateOrderProduct>
      <MixingScale>3</MixingScale>
      <ProductGuid>6b7693b2-7906-4da3-bafc-85129257c3f8</ProductGuid>
      <ProductIsCarrier>true</ProductIsCarrier>
      <RatePerUnitAmount>2.1</RatePerUnitAmount>
    </ClsBlendPlanUtilities.ClsRecalculateOrderProduct>
    <ClsBlendPlanUtilities.ClsRecalculateOrderProduct>
      <MixingScale>3</MixingScale>
      <ProductGuid>6b7693b2-7906-4da3-bafc-85129257c3f8</ProductGuid>
      <ProductIsCarrier>true</ProductIsCarrier>
      <RatePerUnitAmount>2.1</RatePerUnitAmount>
    </ClsBlendPlanUtilities.ClsRecalculateOrderProduct>
  </CurrentProductList>
  <LocationGUID>213330a5-340d-4eaa-af79-6c0c41672854</LocationGUID>
  <MethodOfCalculation>MethodNotSet</MethodOfCalculation>
  <ProductSetID>sample string 10</ProductSetID>
  <Quantity>8.1</Quantity>
  <RequestedAdjustment>7.1</RequestedAdjustment>
</ClsBlendPlanUtilities.ClsRecalculateOrder>

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

Response Information

Resource Description

Recalculates the quantity and products needed to meet the requested value for the order.

AgvBlendTicketRecalculateOrder
NameDescriptionTypeAdditional 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 error messages of the API call.

Collection of string
WarningList

List of warning messages of the API call.

Collection of string
Count

Number of results returned.

string
Data

Calculated Order Response with Quantity and Products updated.

ClsRecalculateOrderResponse

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": "1",
  "Data": {
    "Quantity": 1.1,
    "Products": [
      {
        "DepartmentID": "sample string 35",
        "ProductID": "sample string 36",
        "ProductGUID": "d89fad99-b8d3-4ce3-8b3f-681a1c2cda8b",
        "ProductName": "sample string 38",
        "RatePerUnitAmount": 39.1,
        "RatingUOM": "sample string 40",
        "TotalRatingAmount": 41.1,
        "MixedAmount": 42.1,
        "MixingUOM": "sample string 43",
        "MixingScale": 44,
        "InventoryAmount": 45.1,
        "InventoryUOM": "sample string 46",
        "TotalPoundsInTheMix": 47.1
      },
      {
        "DepartmentID": "sample string 35",
        "ProductID": "sample string 36",
        "ProductGUID": "d89fad99-b8d3-4ce3-8b3f-681a1c2cda8b",
        "ProductName": "sample string 38",
        "RatePerUnitAmount": 39.1,
        "RatingUOM": "sample string 40",
        "TotalRatingAmount": 41.1,
        "MixedAmount": 42.1,
        "MixingUOM": "sample string 43",
        "MixingScale": 44,
        "InventoryAmount": 45.1,
        "InventoryUOM": "sample string 46",
        "TotalPoundsInTheMix": 47.1
      }
    ]
  }
}

application/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'application/xml'. Exception message: Type 'SSI.plbl.ClsBlendPlanUtilities+ClsRecalculateOrderResponse' cannot inherit from a type that is not marked with DataContractAttribute or SerializableAttribute. Consider marking the base type 'SKY.Core.API.ClsApiResponse' with DataContractAttribute or SerializableAttribute, or removing them from the derived type.

text/xml

Sample:

An exception has occurred while using the formatter 'XmlMediaTypeFormatter' to generate sample for media type 'text/xml'. Exception message: Type 'SSI.plbl.ClsBlendPlanUtilities+ClsRecalculateOrderResponse' cannot inherit from a type that is not marked with DataContractAttribute or SerializableAttribute. Consider marking the base type 'SKY.Core.API.ClsApiResponse' with DataContractAttribute or SerializableAttribute, or removing them from the derived type.