POST api/delivery/deleteorderproduct

Delete an app created ordered product.

Request Information

URI Parameters

None.

Body Parameters

OrderedProduct
NameDescriptionTypeAdditional information
orderedProductId integer

Required

Request Formats

application/json, text/json

Sample:
{
  "orderedProductId": 1
}

application/xml, text/xml

Sample:
<OrderedProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Request.Delivery">
  <Order_Id>1</Order_Id>
  <OrderedProductId>1</OrderedProductId>
  <Product_Id>2</Product_Id>
</OrderedProduct>

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

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OrderedProductId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Order_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Product_Id"

2
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ResponseOfOrderedProduct
NameDescriptionTypeAdditional information
Message string

None.

Success boolean

None.

StatusCode HttpStatusCode

None.

Data OrderedProduct

None.

Errors Dictionary of string [key] and Collection of string [value]

None.

Response Formats

application/json, text/json

Sample:
{
  "message": "sample string 1",
  "success": true,
  "statusCode": 100,
  "data": {
    "orderedProductId": 1
  },
  "errors": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:
<ResponseOfOrderedProducthpmiEZBz xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Response">
  <Data xmlns:d2p1="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Request.Delivery">
    <d2p1:Order_Id>1</d2p1:Order_Id>
    <d2p1:OrderedProductId>1</d2p1:OrderedProductId>
    <d2p1:Product_Id>2</d2p1:Product_Id>
  </Data>
  <Errors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 1</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
    <d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
      <d2p1:Key>sample string 2</d2p1:Key>
      <d2p1:Value>
        <d2p1:string>sample string 1</d2p1:string>
        <d2p1:string>sample string 2</d2p1:string>
      </d2p1:Value>
    </d2p1:KeyValueOfstringArrayOfstringty7Ep6D1>
  </Errors>
  <Message>sample string 1</Message>
  <StatusCode>Continue</StatusCode>
  <Success>true</Success>
</ResponseOfOrderedProducthpmiEZBz>

multipart/form-data

Sample:
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Message"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Success"

True
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="StatusCode"

Continue
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.OrderedProductId"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Order_Id"

1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Data.Product_Id"

2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Key"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Value[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[0].Value[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Key"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Value[0]"

sample string 1
--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="Errors[1].Value[1]"

sample string 2
--MultipartDataMediaFormatterBoundary1q2w3e--