POST api/orders/Waybill

Adds a waybill number to the order

Request Information

URI Parameters

None.

Body Parameters

OrderHeadWaybillRequest
NameDescriptionTypeAdditional information
OrderHeadId

Id of the order to add the waybill on

 integer

Required
BranchId

BranchId of the order to add the waybill on

 integer

Required
WaybillNumber

Waybill number to add.

 string

Required

Max length: 100

Remarks

None.

Example

None.

Request Formats

application/json, text/json

Sample: 
{
  "OrderHeadId": 1,
  "BranchId": 2,
  "WaybillNumber": "sample string 3"
}

application/xml, text/xml

Sample: 
<OrderHeadWaybillRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Order">
  <BranchId>2</BranchId>
  <OrderHeadId>1</OrderHeadId>
  <WaybillNumber>sample string 3</WaybillNumber>
</OrderHeadWaybillRequest>

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

Response Information

Resource Description

Returns

OrderHeadWaybillResponse
NameDescriptionTypeAdditional information
Success

True if success, false if errors occured, check the Errors for details

 boolean

None.
Errors

List of errors, will only contain errors if the Success is false.

 Collection of OrderHeadWaybillError

None.

Response Formats

application/json, text/json

Sample: 
{
  "Success": true,
  "Errors": [
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    },
    {
      "ErrorCode": 1,
      "ErrorMessage": "sample string 1"
    }
  ]
}

application/xml, text/xml

Sample: 
<OrderHeadWaybillResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Compilator.DDAPI.DTO.Order">
  <Errors>
    <OrderHeadWaybillError>
      <ErrorCode>OrderNotFound</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </OrderHeadWaybillError>
    <OrderHeadWaybillError>
      <ErrorCode>OrderNotFound</ErrorCode>
      <ErrorMessage>sample string 1</ErrorMessage>
    </OrderHeadWaybillError>
  </Errors>
  <Success>true</Success>
</OrderHeadWaybillResponse>