PUT ProductDeliveryOrder/PutProductDeliveryOrder

Edit a Product Delivery Order.

Request Information

URI Parameters

Body Parameters

The request object used to update the order.

Name	Description	Type	Additional Information
OrderID	Call in Order ID. Leave 0 when adding a product delivery order	integer	Required
CallInDate	Call In Date	string	Format must be MM/dd/yyyy
DueDate	Due Date	string	Format must be MM/dd/yyyy
CurrentTankPercent	Current Tank Percentage	decimal number
OrderType	Order Type. Must be "A" for Amount of Purchase, "G" for Number of gallons, "P" for Fill Percent, or "S" for scheduled	string	Max length: 1
OrderPercent	Order percentage when order type is "P"	decimal number
OrderGals	Order gallons when order type is "G"	decimal number
OrderDollars	Order dollar amount when order type is "A"	decimal number
OrderPrice	Charge price	decimal number	Max of 4 decimal places
Completed	Completed. True for Completed, False for Open	boolean
Notes	Notes	string	Max length: 255
ProdID	Product ID of the product being ordered	string	Max length: 10
DeptID	Department ID of the product being ordered	string	Max length: 6
DispJobStatus	Dispatch Job Status. When provided must be "Ready", "In Process", "Completed", or "On Hold"	string	Max length: 10
LocationID	Order Location	string	Max length: 6
DriverEmailAddresses	List of driver email addresses	Collection of DriverEmailAddress

Request Formats

application/json, text/json

Sample:

{
  "OrderID": 1,
  "CallInDate": "sample string 2",
  "DueDate": "sample string 3",
  "CurrentTankPercent": 1.1,
  "OrderType": "sample string 5",
  "OrderPercent": 1.1,
  "OrderGals": 1.1,
  "OrderDollars": 1.1,
  "OrderPrice": 6.1,
  "Completed": true,
  "Notes": "sample string 7",
  "ProdID": "sample string 8",
  "DeptID": "sample string 9",
  "DispJobStatus": "sample string 10",
  "LocationID": "sample string 11",
  "DriverEmailAddresses": [
    {
      "DriverId": "sample string 1",
      "EmailAddress": "sample string 2",
      "Format": "sample string 3"
    },
    {
      "DriverId": "sample string 1",
      "EmailAddress": "sample string 2",
      "Format": "sample string 3"
    }
  ]
}

application/xml, text/xml

Sample:

<clsPutLpCallin xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/SSI">
  <CallInDate>sample string 2</CallInDate>
  <Completed>true</Completed>
  <CurrentTankPercent>1.1</CurrentTankPercent>
  <DeptID>sample string 9</DeptID>
  <DispJobStatus>sample string 10</DispJobStatus>
  <DriverEmailAddresses>
    <ClsLPCallin.DriverEmailAddress>
      <DriverId>sample string 1</DriverId>
      <EmailAddress>sample string 2</EmailAddress>
      <Format>sample string 3</Format>
    </ClsLPCallin.DriverEmailAddress>
    <ClsLPCallin.DriverEmailAddress>
      <DriverId>sample string 1</DriverId>
      <EmailAddress>sample string 2</EmailAddress>
      <Format>sample string 3</Format>
    </ClsLPCallin.DriverEmailAddress>
  </DriverEmailAddresses>
  <DueDate>sample string 3</DueDate>
  <LocationID>sample string 11</LocationID>
  <Notes>sample string 7</Notes>
  <OrderDollars>1.1</OrderDollars>
  <OrderGals>1.1</OrderGals>
  <OrderID>1</OrderID>
  <OrderPercent>1.1</OrderPercent>
  <OrderPrice>6.1</OrderPrice>
  <OrderType>sample string 5</OrderType>
  <ProdID>sample string 8</ProdID>
</clsPutLpCallin>

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

Response Information

Resource Description

Edit a Product Delivery Order.

AgvProductDeliveryOrder

Name	Description	Type
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
OrderId		integer

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"
  ],
  "OrderId": 3
}

application/xml, text/xml

Sample:

<AgvProductDeliveryOrder xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/AgvWebAPICSharp.Models.ProductDeliveryOrder">
  <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>
  <OrderId>3</OrderId>
  <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>
</AgvProductDeliveryOrder>