POST api/PickerShipment/StopTrip

Request Information

URI Parameters

None.

Body Parameters

StopTrip
NameDescriptionTypeAdditional information
BusinessId

integer

None.

Loginuserid

integer

None.

ShipmentId

string

None.

stopTripLatitude

string

None.

stopTripLongitude

string

None.

distanceFromWarehouse

decimal number

None.

transferId

integer

None.

Request Formats

application/json, text/json

Sample:
{
  "BusinessId": 1,
  "Loginuserid": 2,
  "ShipmentId": "sample string 3",
  "stopTripLatitude": "sample string 4",
  "stopTripLongitude": "sample string 5",
  "distanceFromWarehouse": 6.0,
  "transferId": 7
}

application/xml, text/xml

Sample:
<StopTrip xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <BusinessId>1</BusinessId>
  <Loginuserid>2</Loginuserid>
  <ShipmentId>sample string 3</ShipmentId>
  <distanceFromWarehouse>6</distanceFromWarehouse>
  <stopTripLatitude>sample string 4</stopTripLatitude>
  <stopTripLongitude>sample string 5</stopTripLongitude>
  <transferId>7</transferId>
</StopTrip>

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

Response Information

Resource Description

VCAPIResponse
NameDescriptionTypeAdditional information
Version

string

None.

dateTime

string

None.

StatusCode

integer

None.

ErrorMessage

string

None.

Result

Object

None.

Response Formats

application/json, text/json

Sample:
{
  "Version": "1.0.0",
  "dateTime": "2024/09/19 18:25:50",
  "StatusCode": 1,
  "ErrorMessage": "sample string 2",
  "Result": {}
}

application/xml, text/xml

Sample:
<VCAPIResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/BOPWAAPI.Model">
  <ErrorMessage>sample string 2</ErrorMessage>
  <Result />
  <StatusCode>1</StatusCode>
</VCAPIResponse>