POST api/delivery/resetdeliveredproduct

Reset delivery for a Product.

Request Information

URI Parameters

None.

Body Parameters

Name	Type	Additional information
orderId	integer	Required
productId	integer	Required
orderedProductId	integer	Required

Request Formats

application/json, text/json

Sample:

{
  "orderId": 1,
  "productId": 2,
  "orderedProductId": 3
}

application/xml, text/xml

Sample:

<ResetProduct xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/TillApi.DTOs.Request.Delivery">
  <OrderId>1</OrderId>
  <OrderedProductId>3</OrderedProductId>
  <ProductId>2</ProductId>
</ResetProduct>

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

multipart/form-data

Sample:

--MultipartDataMediaFormatterBoundary1q2w3e
Content-Disposition: form-data; name="OrderId"

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

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

3
--MultipartDataMediaFormatterBoundary1q2w3e--

Response Information

Resource Description

ResponseOfResetProduct

Name	Type	Additional information
Message	string	None.
Success	boolean	None.
StatusCode	HttpStatusCode	None.
Data	ResetProduct	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": {
    "orderId": 1,
    "productId": 2,
    "orderedProductId": 3
  },
  "errors": {
    "sample string 1": [
      "sample string 1",
      "sample string 2"
    ],
    "sample string 2": [
      "sample string 1",
      "sample string 2"
    ]
  }
}

application/xml, text/xml

Sample:

<ResponseOfResetProducthpmiEZBz 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:OrderId>1</d2p1:OrderId>
    <d2p1:OrderedProductId>3</d2p1:OrderedProductId>
    <d2p1:ProductId>2</d2p1:ProductId>
  </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>
</ResponseOfResetProducthpmiEZBz>

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.OrderId"

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

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

3
--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--