Trendsic Platform Service

CourierOrderCancelRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/courier/orders/{Code}/cancel

import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CourierOrderCancelRequest
    {
        public String Code = null;
        public String Reason = null;
        public Boolean ChargeFee = null;
        
        public String getCode() { return Code; }
        public CourierOrderCancelRequest setCode(String value) { this.Code = value; return this; }
        public String getReason() { return Reason; }
        public CourierOrderCancelRequest setReason(String value) { this.Reason = value; return this; }
        public Boolean isChargeFee() { return ChargeFee; }
        public CourierOrderCancelRequest setChargeFee(Boolean value) { this.ChargeFee = value; return this; }
    }

    public static class CourierOrderResponse
    {
        public ArrayList<CourierOrderView> Orders = new ArrayList<CourierOrderView>();
        public CourierOrderView Order = null;
        public String Message = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<CourierOrderView> getOrders() { return Orders; }
        public CourierOrderResponse setOrders(ArrayList<CourierOrderView> value) { this.Orders = value; return this; }
        public CourierOrderView getOrder() { return Order; }
        public CourierOrderResponse setOrder(CourierOrderView value) { this.Order = value; return this; }
        public String getMessage() { return Message; }
        public CourierOrderResponse setMessage(String value) { this.Message = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CourierOrderResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class CourierOrderView
    {
        public Integer DispatchOdRequestID = null;
        public String Code = null;
        public Integer CourierProfileId = null;
        public String ProfileName = null;
        public String RouteShape = null;
        public String UnitOne = null;
        public String UnitMany = null;
        public Integer CourierFacilityId = null;
        public String FacilityName = null;
        public String ServiceLevelCode = null;
        public String LevelName = null;
        public String Source = null;
        public String Address = null;
        public String Unit = null;
        public String City = null;
        public String Zip = null;
        public String Zone = null;
        public String PickupContactName = null;
        public String DropoffAddress = null;
        public String DropoffUnit = null;
        public String DropoffCity = null;
        public String DropoffZip = null;
        public String DropoffContactName = null;
        public BigDecimal Miles = null;
        public Integer Units = null;
        public Integer UnitsFound = null;
        public String Stage = null;
        public String CourierStep = null;
        public String StepLabel = null;
        public String DriverCode = null;
        public String DriverName = null;
        public Integer DriverContactId = null;
        public Integer CourierRunId = null;
        public String RunCode = null;
        public Integer StopSequence = null;
        public Integer QueueSequence = null;
        public Boolean IsAsap = null;
        public Date WindowStartUtc = null;
        public Date WindowEndUtc = null;
        public String WindowText = null;
        public Date DueUtc = null;
        public String DueText = null;
        public Date PingAfterUtc = null;
        public Date PingExpiresUtc = null;
        public String CandidateCode = null;
        public String HeldReason = null;
        public Date HeldUtc = null;
        public String CustomerName = null;
        public String CustomerPhone = null;
        public String Handoff = null;
        public String GateCode = null;
        public String Instructions = null;
        public String DamageNote = null;
        public String DeliveredToName = null;
        public String PayMode = null;
        public BigDecimal Fare = null;
        public BigDecimal FinalPrice = null;
        public BigDecimal TipAmount = null;
        public String CancelledBy = null;
        public String CancelReason = null;
        public BigDecimal CancelFeeApplied = null;
        public BigDecimal MissedFeeApplied = null;
        public String CaptureMode = null;
        public BigDecimal AuthorizedAmount = null;
        public BigDecimal CapturedAmount = null;
        public BigDecimal RefundedAmount = null;
        public String ChargeError = null;
        public Date CreatedAt = null;
        public Date ArrivedUtc = null;
        public Date PickedUpUtc = null;
        public Date IntakeUtc = null;
        public Date ReadyUtc = null;
        public Date OutForDeliveryUtc = null;
        public Date DeliveredUtc = null;
        public Date MissedUtc = null;
        public Date CancelledUtc = null;
        public Boolean IsClosed = null;
        public Integer RebookOfId = null;
        public Integer RecurrenceId = null;
        public Integer PickupLoadId = null;
        public CourierOrderRuleView Rule = null;
        public ArrayList<CourierItemView> Items = new ArrayList<CourierItemView>();
        public ArrayList<CourierScanView> Scans = new ArrayList<CourierScanView>();
        public ArrayList<CourierProofResultView> Proof = new ArrayList<CourierProofResultView>();
        public ArrayList<CourierEventView> Events = new ArrayList<CourierEventView>();
        public ArrayList<CourierPhotoView> Photos = new ArrayList<CourierPhotoView>();
        public ArrayList<CourierPayLineView> PayLines = new ArrayList<CourierPayLineView>();
        
        public Integer getDispatchOdRequestID() { return DispatchOdRequestID; }
        public CourierOrderView setDispatchOdRequestID(Integer value) { this.DispatchOdRequestID = value; return this; }
        public String getCode() { return Code; }
        public CourierOrderView setCode(String value) { this.Code = value; return this; }
        public Integer getCourierProfileId() { return CourierProfileId; }
        public CourierOrderView setCourierProfileId(Integer value) { this.CourierProfileId = value; return this; }
        public String getProfileName() { return ProfileName; }
        public CourierOrderView setProfileName(String value) { this.ProfileName = value; return this; }
        public String getRouteShape() { return RouteShape; }
        public CourierOrderView setRouteShape(String value) { this.RouteShape = value; return this; }
        public String getUnitOne() { return UnitOne; }
        public CourierOrderView setUnitOne(String value) { this.UnitOne = value; return this; }
        public String getUnitMany() { return UnitMany; }
        public CourierOrderView setUnitMany(String value) { this.UnitMany = value; return this; }
        public Integer getCourierFacilityId() { return CourierFacilityId; }
        public CourierOrderView setCourierFacilityId(Integer value) { this.CourierFacilityId = value; return this; }
        public String getFacilityName() { return FacilityName; }
        public CourierOrderView setFacilityName(String value) { this.FacilityName = value; return this; }
        public String getServiceLevelCode() { return ServiceLevelCode; }
        public CourierOrderView setServiceLevelCode(String value) { this.ServiceLevelCode = value; return this; }
        public String getLevelName() { return LevelName; }
        public CourierOrderView setLevelName(String value) { this.LevelName = value; return this; }
        public String getSource() { return Source; }
        public CourierOrderView setSource(String value) { this.Source = value; return this; }
        public String getAddress() { return Address; }
        public CourierOrderView setAddress(String value) { this.Address = value; return this; }
        public String getUnit() { return Unit; }
        public CourierOrderView setUnit(String value) { this.Unit = value; return this; }
        public String getCity() { return City; }
        public CourierOrderView setCity(String value) { this.City = value; return this; }
        public String getZip() { return Zip; }
        public CourierOrderView setZip(String value) { this.Zip = value; return this; }
        public String getZone() { return Zone; }
        public CourierOrderView setZone(String value) { this.Zone = value; return this; }
        public String getPickupContactName() { return PickupContactName; }
        public CourierOrderView setPickupContactName(String value) { this.PickupContactName = value; return this; }
        public String getDropoffAddress() { return DropoffAddress; }
        public CourierOrderView setDropoffAddress(String value) { this.DropoffAddress = value; return this; }
        public String getDropoffUnit() { return DropoffUnit; }
        public CourierOrderView setDropoffUnit(String value) { this.DropoffUnit = value; return this; }
        public String getDropoffCity() { return DropoffCity; }
        public CourierOrderView setDropoffCity(String value) { this.DropoffCity = value; return this; }
        public String getDropoffZip() { return DropoffZip; }
        public CourierOrderView setDropoffZip(String value) { this.DropoffZip = value; return this; }
        public String getDropoffContactName() { return DropoffContactName; }
        public CourierOrderView setDropoffContactName(String value) { this.DropoffContactName = value; return this; }
        public BigDecimal getMiles() { return Miles; }
        public CourierOrderView setMiles(BigDecimal value) { this.Miles = value; return this; }
        public Integer getUnits() { return Units; }
        public CourierOrderView setUnits(Integer value) { this.Units = value; return this; }
        public Integer getUnitsFound() { return UnitsFound; }
        public CourierOrderView setUnitsFound(Integer value) { this.UnitsFound = value; return this; }
        public String getStage() { return Stage; }
        public CourierOrderView setStage(String value) { this.Stage = value; return this; }
        public String getCourierStep() { return CourierStep; }
        public CourierOrderView setCourierStep(String value) { this.CourierStep = value; return this; }
        public String getStepLabel() { return StepLabel; }
        public CourierOrderView setStepLabel(String value) { this.StepLabel = value; return this; }
        public String getDriverCode() { return DriverCode; }
        public CourierOrderView setDriverCode(String value) { this.DriverCode = value; return this; }
        public String getDriverName() { return DriverName; }
        public CourierOrderView setDriverName(String value) { this.DriverName = value; return this; }
        public Integer getDriverContactId() { return DriverContactId; }
        public CourierOrderView setDriverContactId(Integer value) { this.DriverContactId = value; return this; }
        public Integer getCourierRunId() { return CourierRunId; }
        public CourierOrderView setCourierRunId(Integer value) { this.CourierRunId = value; return this; }
        public String getRunCode() { return RunCode; }
        public CourierOrderView setRunCode(String value) { this.RunCode = value; return this; }
        public Integer getStopSequence() { return StopSequence; }
        public CourierOrderView setStopSequence(Integer value) { this.StopSequence = value; return this; }
        public Integer getQueueSequence() { return QueueSequence; }
        public CourierOrderView setQueueSequence(Integer value) { this.QueueSequence = value; return this; }
        public Boolean getIsAsap() { return IsAsap; }
        public CourierOrderView setIsAsap(Boolean value) { this.IsAsap = value; return this; }
        public Date getWindowStartUtc() { return WindowStartUtc; }
        public CourierOrderView setWindowStartUtc(Date value) { this.WindowStartUtc = value; return this; }
        public Date getWindowEndUtc() { return WindowEndUtc; }
        public CourierOrderView setWindowEndUtc(Date value) { this.WindowEndUtc = value; return this; }
        public String getWindowText() { return WindowText; }
        public CourierOrderView setWindowText(String value) { this.WindowText = value; return this; }
        public Date getDueUtc() { return DueUtc; }
        public CourierOrderView setDueUtc(Date value) { this.DueUtc = value; return this; }
        public String getDueText() { return DueText; }
        public CourierOrderView setDueText(String value) { this.DueText = value; return this; }
        public Date getPingAfterUtc() { return PingAfterUtc; }
        public CourierOrderView setPingAfterUtc(Date value) { this.PingAfterUtc = value; return this; }
        public Date getPingExpiresUtc() { return PingExpiresUtc; }
        public CourierOrderView setPingExpiresUtc(Date value) { this.PingExpiresUtc = value; return this; }
        public String getCandidateCode() { return CandidateCode; }
        public CourierOrderView setCandidateCode(String value) { this.CandidateCode = value; return this; }
        public String getHeldReason() { return HeldReason; }
        public CourierOrderView setHeldReason(String value) { this.HeldReason = value; return this; }
        public Date getHeldUtc() { return HeldUtc; }
        public CourierOrderView setHeldUtc(Date value) { this.HeldUtc = value; return this; }
        public String getCustomerName() { return CustomerName; }
        public CourierOrderView setCustomerName(String value) { this.CustomerName = value; return this; }
        public String getCustomerPhone() { return CustomerPhone; }
        public CourierOrderView setCustomerPhone(String value) { this.CustomerPhone = value; return this; }
        public String getHandoff() { return Handoff; }
        public CourierOrderView setHandoff(String value) { this.Handoff = value; return this; }
        public String getGateCode() { return GateCode; }
        public CourierOrderView setGateCode(String value) { this.GateCode = value; return this; }
        public String getInstructions() { return Instructions; }
        public CourierOrderView setInstructions(String value) { this.Instructions = value; return this; }
        public String getDamageNote() { return DamageNote; }
        public CourierOrderView setDamageNote(String value) { this.DamageNote = value; return this; }
        public String getDeliveredToName() { return DeliveredToName; }
        public CourierOrderView setDeliveredToName(String value) { this.DeliveredToName = value; return this; }
        public String getPayMode() { return PayMode; }
        public CourierOrderView setPayMode(String value) { this.PayMode = value; return this; }
        public BigDecimal getFare() { return Fare; }
        public CourierOrderView setFare(BigDecimal value) { this.Fare = value; return this; }
        public BigDecimal getFinalPrice() { return FinalPrice; }
        public CourierOrderView setFinalPrice(BigDecimal value) { this.FinalPrice = value; return this; }
        public BigDecimal getTipAmount() { return TipAmount; }
        public CourierOrderView setTipAmount(BigDecimal value) { this.TipAmount = value; return this; }
        public String getCancelledBy() { return CancelledBy; }
        public CourierOrderView setCancelledBy(String value) { this.CancelledBy = value; return this; }
        public String getCancelReason() { return CancelReason; }
        public CourierOrderView setCancelReason(String value) { this.CancelReason = value; return this; }
        public BigDecimal getCancelFeeApplied() { return CancelFeeApplied; }
        public CourierOrderView setCancelFeeApplied(BigDecimal value) { this.CancelFeeApplied = value; return this; }
        public BigDecimal getMissedFeeApplied() { return MissedFeeApplied; }
        public CourierOrderView setMissedFeeApplied(BigDecimal value) { this.MissedFeeApplied = value; return this; }
        public String getCaptureMode() { return CaptureMode; }
        public CourierOrderView setCaptureMode(String value) { this.CaptureMode = value; return this; }
        public BigDecimal getAuthorizedAmount() { return AuthorizedAmount; }
        public CourierOrderView setAuthorizedAmount(BigDecimal value) { this.AuthorizedAmount = value; return this; }
        public BigDecimal getCapturedAmount() { return CapturedAmount; }
        public CourierOrderView setCapturedAmount(BigDecimal value) { this.CapturedAmount = value; return this; }
        public BigDecimal getRefundedAmount() { return RefundedAmount; }
        public CourierOrderView setRefundedAmount(BigDecimal value) { this.RefundedAmount = value; return this; }
        public String getChargeError() { return ChargeError; }
        public CourierOrderView setChargeError(String value) { this.ChargeError = value; return this; }
        public Date getCreatedAt() { return CreatedAt; }
        public CourierOrderView setCreatedAt(Date value) { this.CreatedAt = value; return this; }
        public Date getArrivedUtc() { return ArrivedUtc; }
        public CourierOrderView setArrivedUtc(Date value) { this.ArrivedUtc = value; return this; }
        public Date getPickedUpUtc() { return PickedUpUtc; }
        public CourierOrderView setPickedUpUtc(Date value) { this.PickedUpUtc = value; return this; }
        public Date getIntakeUtc() { return IntakeUtc; }
        public CourierOrderView setIntakeUtc(Date value) { this.IntakeUtc = value; return this; }
        public Date getReadyUtc() { return ReadyUtc; }
        public CourierOrderView setReadyUtc(Date value) { this.ReadyUtc = value; return this; }
        public Date getOutForDeliveryUtc() { return OutForDeliveryUtc; }
        public CourierOrderView setOutForDeliveryUtc(Date value) { this.OutForDeliveryUtc = value; return this; }
        public Date getDeliveredUtc() { return DeliveredUtc; }
        public CourierOrderView setDeliveredUtc(Date value) { this.DeliveredUtc = value; return this; }
        public Date getMissedUtc() { return MissedUtc; }
        public CourierOrderView setMissedUtc(Date value) { this.MissedUtc = value; return this; }
        public Date getCancelledUtc() { return CancelledUtc; }
        public CourierOrderView setCancelledUtc(Date value) { this.CancelledUtc = value; return this; }
        public Boolean getIsClosed() { return IsClosed; }
        public CourierOrderView setIsClosed(Boolean value) { this.IsClosed = value; return this; }
        public Integer getRebookOfId() { return RebookOfId; }
        public CourierOrderView setRebookOfId(Integer value) { this.RebookOfId = value; return this; }
        public Integer getRecurrenceId() { return RecurrenceId; }
        public CourierOrderView setRecurrenceId(Integer value) { this.RecurrenceId = value; return this; }
        public Integer getPickupLoadId() { return PickupLoadId; }
        public CourierOrderView setPickupLoadId(Integer value) { this.PickupLoadId = value; return this; }
        public CourierOrderRuleView getRule() { return Rule; }
        public CourierOrderView setRule(CourierOrderRuleView value) { this.Rule = value; return this; }
        public ArrayList<CourierItemView> getItems() { return Items; }
        public CourierOrderView setItems(ArrayList<CourierItemView> value) { this.Items = value; return this; }
        public ArrayList<CourierScanView> getScans() { return Scans; }
        public CourierOrderView setScans(ArrayList<CourierScanView> value) { this.Scans = value; return this; }
        public ArrayList<CourierProofResultView> getProof() { return Proof; }
        public CourierOrderView setProof(ArrayList<CourierProofResultView> value) { this.Proof = value; return this; }
        public ArrayList<CourierEventView> getEvents() { return Events; }
        public CourierOrderView setEvents(ArrayList<CourierEventView> value) { this.Events = value; return this; }
        public ArrayList<CourierPhotoView> getPhotos() { return Photos; }
        public CourierOrderView setPhotos(ArrayList<CourierPhotoView> value) { this.Photos = value; return this; }
        public ArrayList<CourierPayLineView> getPayLines() { return PayLines; }
        public CourierOrderView setPayLines(ArrayList<CourierPayLineView> value) { this.PayLines = value; return this; }
    }

    public static class CourierOrderRuleView
    {
        public Integer PingSecs = null;
        public Integer MissedWaitMin = null;
        public BigDecimal MissedFee = null;
        public BigDecimal CancelFee = null;
        public Boolean MissedAutoRebook = null;
        public Boolean MissedRequireContact = null;
        public Boolean MissedRequirePhoto = null;
        public String PayTiming = null;
        public Boolean FinalPriceAfterCount = null;
        public String PayPlanName = null;
        public BigDecimal PerPickup = null;
        public BigDecimal PerStop = null;
        public BigDecimal PerMissed = null;
        public BigDecimal PerCancel = null;
        public Date AcceptedUtc = null;
        public HashMap<String,String> Proof = new HashMap<String,String>();
        
        public Integer getPingSecs() { return PingSecs; }
        public CourierOrderRuleView setPingSecs(Integer value) { this.PingSecs = value; return this; }
        public Integer getMissedWaitMin() { return MissedWaitMin; }
        public CourierOrderRuleView setMissedWaitMin(Integer value) { this.MissedWaitMin = value; return this; }
        public BigDecimal getMissedFee() { return MissedFee; }
        public CourierOrderRuleView setMissedFee(BigDecimal value) { this.MissedFee = value; return this; }
        public BigDecimal getCancelFee() { return CancelFee; }
        public CourierOrderRuleView setCancelFee(BigDecimal value) { this.CancelFee = value; return this; }
        public Boolean isMissedAutoRebook() { return MissedAutoRebook; }
        public CourierOrderRuleView setMissedAutoRebook(Boolean value) { this.MissedAutoRebook = value; return this; }
        public Boolean isMissedRequireContact() { return MissedRequireContact; }
        public CourierOrderRuleView setMissedRequireContact(Boolean value) { this.MissedRequireContact = value; return this; }
        public Boolean isMissedRequirePhoto() { return MissedRequirePhoto; }
        public CourierOrderRuleView setMissedRequirePhoto(Boolean value) { this.MissedRequirePhoto = value; return this; }
        public String getPayTiming() { return PayTiming; }
        public CourierOrderRuleView setPayTiming(String value) { this.PayTiming = value; return this; }
        public Boolean isFinalPriceAfterCount() { return FinalPriceAfterCount; }
        public CourierOrderRuleView setFinalPriceAfterCount(Boolean value) { this.FinalPriceAfterCount = value; return this; }
        public String getPayPlanName() { return PayPlanName; }
        public CourierOrderRuleView setPayPlanName(String value) { this.PayPlanName = value; return this; }
        public BigDecimal getPerPickup() { return PerPickup; }
        public CourierOrderRuleView setPerPickup(BigDecimal value) { this.PerPickup = value; return this; }
        public BigDecimal getPerStop() { return PerStop; }
        public CourierOrderRuleView setPerStop(BigDecimal value) { this.PerStop = value; return this; }
        public BigDecimal getPerMissed() { return PerMissed; }
        public CourierOrderRuleView setPerMissed(BigDecimal value) { this.PerMissed = value; return this; }
        public BigDecimal getPerCancel() { return PerCancel; }
        public CourierOrderRuleView setPerCancel(BigDecimal value) { this.PerCancel = value; return this; }
        public Date getAcceptedUtc() { return AcceptedUtc; }
        public CourierOrderRuleView setAcceptedUtc(Date value) { this.AcceptedUtc = value; return this; }
        public HashMap<String,String> getProof() { return Proof; }
        public CourierOrderRuleView setProof(HashMap<String,String> value) { this.Proof = value; return this; }
    }

    public static class CourierItemView
    {
        public Integer CourierItemID = null;
        public Integer DispatchOdRequestID = null;
        public Integer Seq = null;
        public String TagCode = null;
        public String Custody = null;
        public Boolean IsOpen = null;
        public Boolean IsMissing = null;
        public String MissingReason = null;
        public Boolean IsManual = null;
        public Boolean ReTagFlag = null;
        public Boolean Scanned = null;
        
        public Integer getCourierItemID() { return CourierItemID; }
        public CourierItemView setCourierItemID(Integer value) { this.CourierItemID = value; return this; }
        public Integer getDispatchOdRequestID() { return DispatchOdRequestID; }
        public CourierItemView setDispatchOdRequestID(Integer value) { this.DispatchOdRequestID = value; return this; }
        public Integer getSeq() { return Seq; }
        public CourierItemView setSeq(Integer value) { this.Seq = value; return this; }
        public String getTagCode() { return TagCode; }
        public CourierItemView setTagCode(String value) { this.TagCode = value; return this; }
        public String getCustody() { return Custody; }
        public CourierItemView setCustody(String value) { this.Custody = value; return this; }
        public Boolean getIsOpen() { return IsOpen; }
        public CourierItemView setIsOpen(Boolean value) { this.IsOpen = value; return this; }
        public Boolean getIsMissing() { return IsMissing; }
        public CourierItemView setIsMissing(Boolean value) { this.IsMissing = value; return this; }
        public String getMissingReason() { return MissingReason; }
        public CourierItemView setMissingReason(String value) { this.MissingReason = value; return this; }
        public Boolean getIsManual() { return IsManual; }
        public CourierItemView setIsManual(Boolean value) { this.IsManual = value; return this; }
        public Boolean isReTagFlag() { return ReTagFlag; }
        public CourierItemView setReTagFlag(Boolean value) { this.ReTagFlag = value; return this; }
        public Boolean isScanned() { return Scanned; }
        public CourierItemView setScanned(Boolean value) { this.Scanned = value; return this; }
    }

    public static class CourierScanView
    {
        public String TagCode = null;
        public String Stage = null;
        public String Result = null;
        public Date AtUtc = null;
        
        public String getTagCode() { return TagCode; }
        public CourierScanView setTagCode(String value) { this.TagCode = value; return this; }
        public String getStage() { return Stage; }
        public CourierScanView setStage(String value) { this.Stage = value; return this; }
        public String getResult() { return Result; }
        public CourierScanView setResult(String value) { this.Result = value; return this; }
        public Date getAtUtc() { return AtUtc; }
        public CourierScanView setAtUtc(Date value) { this.AtUtc = value; return this; }
    }

    public static class CourierProofResultView
    {
        public String Stage = null;
        public String StepKey = null;
        public String Value = null;
        public Date AtUtc = null;
        
        public String getStage() { return Stage; }
        public CourierProofResultView setStage(String value) { this.Stage = value; return this; }
        public String getStepKey() { return StepKey; }
        public CourierProofResultView setStepKey(String value) { this.StepKey = value; return this; }
        public String getValue() { return Value; }
        public CourierProofResultView setValue(String value) { this.Value = value; return this; }
        public Date getAtUtc() { return AtUtc; }
        public CourierProofResultView setAtUtc(Date value) { this.AtUtc = value; return this; }
    }

    public static class CourierEventView
    {
        public String Kind = null;
        public String Party = null;
        public String Body = null;
        public Date AtUtc = null;
        
        public String getKind() { return Kind; }
        public CourierEventView setKind(String value) { this.Kind = value; return this; }
        public String getParty() { return Party; }
        public CourierEventView setParty(String value) { this.Party = value; return this; }
        public String getBody() { return Body; }
        public CourierEventView setBody(String value) { this.Body = value; return this; }
        public Date getAtUtc() { return AtUtc; }
        public CourierEventView setAtUtc(Date value) { this.AtUtc = value; return this; }
    }

    public static class CourierPhotoView
    {
        public Integer PhotoId = null;
        public String Kind = null;
        public String FileName = null;
        public String Url = null;
        public Date TakenUtc = null;
        
        public Integer getPhotoId() { return PhotoId; }
        public CourierPhotoView setPhotoId(Integer value) { this.PhotoId = value; return this; }
        public String getKind() { return Kind; }
        public CourierPhotoView setKind(String value) { this.Kind = value; return this; }
        public String getFileName() { return FileName; }
        public CourierPhotoView setFileName(String value) { this.FileName = value; return this; }
        public String getUrl() { return Url; }
        public CourierPhotoView setUrl(String value) { this.Url = value; return this; }
        public Date getTakenUtc() { return TakenUtc; }
        public CourierPhotoView setTakenUtc(Date value) { this.TakenUtc = value; return this; }
    }

    public static class CourierPayLineView
    {
        public Integer DispatchLoadID = null;
        public String Kind = null;
        public String Label = null;
        public BigDecimal Qty = null;
        public BigDecimal Rate = null;
        public BigDecimal Amount = null;
        
        public Integer getDispatchLoadID() { return DispatchLoadID; }
        public CourierPayLineView setDispatchLoadID(Integer value) { this.DispatchLoadID = value; return this; }
        public String getKind() { return Kind; }
        public CourierPayLineView setKind(String value) { this.Kind = value; return this; }
        public String getLabel() { return Label; }
        public CourierPayLineView setLabel(String value) { this.Label = value; return this; }
        public BigDecimal getQty() { return Qty; }
        public CourierPayLineView setQty(BigDecimal value) { this.Qty = value; return this; }
        public BigDecimal getRate() { return Rate; }
        public CourierPayLineView setRate(BigDecimal value) { this.Rate = value; return this; }
        public BigDecimal getAmount() { return Amount; }
        public CourierPayLineView setAmount(BigDecimal value) { this.Amount = value; return this; }
    }

}

Java CourierOrderCancelRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /v1/dispatch/courier/orders/{Code}/cancel HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CourierOrderCancelRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ChargeFee>false</ChargeFee>
  <Code>String</Code>
  <Reason>String</Reason>
</CourierOrderCancelRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierOrderResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Message>String</Message>
  <Order>
    <Address>String</Address>
    <ArrivedUtc>0001-01-01T00:00:00</ArrivedUtc>
    <AuthorizedAmount>0</AuthorizedAmount>
    <CancelFeeApplied>0</CancelFeeApplied>
    <CancelReason>String</CancelReason>
    <CancelledBy>String</CancelledBy>
    <CancelledUtc>0001-01-01T00:00:00</CancelledUtc>
    <CandidateCode>String</CandidateCode>
    <CaptureMode>String</CaptureMode>
    <CapturedAmount>0</CapturedAmount>
    <ChargeError>String</ChargeError>
    <City>String</City>
    <Code>String</Code>
    <CourierFacilityId>0</CourierFacilityId>
    <CourierProfileId>0</CourierProfileId>
    <CourierRunId>0</CourierRunId>
    <CourierStep>String</CourierStep>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CustomerName>String</CustomerName>
    <CustomerPhone>String</CustomerPhone>
    <DamageNote>String</DamageNote>
    <DeliveredToName>String</DeliveredToName>
    <DeliveredUtc>0001-01-01T00:00:00</DeliveredUtc>
    <DispatchOdRequestID>0</DispatchOdRequestID>
    <DriverCode>String</DriverCode>
    <DriverContactId>0</DriverContactId>
    <DriverName>String</DriverName>
    <DropoffAddress>String</DropoffAddress>
    <DropoffCity>String</DropoffCity>
    <DropoffContactName>String</DropoffContactName>
    <DropoffUnit>String</DropoffUnit>
    <DropoffZip>String</DropoffZip>
    <DueText>String</DueText>
    <DueUtc>0001-01-01T00:00:00</DueUtc>
    <Events>
      <CourierEventView>
        <AtUtc>0001-01-01T00:00:00</AtUtc>
        <Body>String</Body>
        <Kind>String</Kind>
        <Party>String</Party>
      </CourierEventView>
    </Events>
    <FacilityName>String</FacilityName>
    <Fare>0</Fare>
    <FinalPrice>0</FinalPrice>
    <GateCode>String</GateCode>
    <Handoff>String</Handoff>
    <HeldReason>String</HeldReason>
    <HeldUtc>0001-01-01T00:00:00</HeldUtc>
    <Instructions>String</Instructions>
    <IntakeUtc>0001-01-01T00:00:00</IntakeUtc>
    <IsAsap>false</IsAsap>
    <IsClosed>false</IsClosed>
    <Items>
      <CourierItemView>
        <CourierItemID>0</CourierItemID>
        <Custody>String</Custody>
        <DispatchOdRequestID>0</DispatchOdRequestID>
        <IsManual>false</IsManual>
        <IsMissing>false</IsMissing>
        <IsOpen>false</IsOpen>
        <MissingReason>String</MissingReason>
        <ReTagFlag>false</ReTagFlag>
        <Scanned>false</Scanned>
        <Seq>0</Seq>
        <TagCode>String</TagCode>
      </CourierItemView>
    </Items>
    <LevelName>String</LevelName>
    <Miles>0</Miles>
    <MissedFeeApplied>0</MissedFeeApplied>
    <MissedUtc>0001-01-01T00:00:00</MissedUtc>
    <OutForDeliveryUtc>0001-01-01T00:00:00</OutForDeliveryUtc>
    <PayLines>
      <CourierPayLineView>
        <Amount>0</Amount>
        <DispatchLoadID>0</DispatchLoadID>
        <Kind>String</Kind>
        <Label>String</Label>
        <Qty>0</Qty>
        <Rate>0</Rate>
      </CourierPayLineView>
    </PayLines>
    <PayMode>String</PayMode>
    <Photos>
      <CourierPhotoView>
        <FileName>String</FileName>
        <Kind>String</Kind>
        <PhotoId>0</PhotoId>
        <TakenUtc>0001-01-01T00:00:00</TakenUtc>
        <Url>String</Url>
      </CourierPhotoView>
    </Photos>
    <PickedUpUtc>0001-01-01T00:00:00</PickedUpUtc>
    <PickupContactName>String</PickupContactName>
    <PickupLoadId>0</PickupLoadId>
    <PingAfterUtc>0001-01-01T00:00:00</PingAfterUtc>
    <PingExpiresUtc>0001-01-01T00:00:00</PingExpiresUtc>
    <ProfileName>String</ProfileName>
    <Proof>
      <CourierProofResultView>
        <AtUtc>0001-01-01T00:00:00</AtUtc>
        <Stage>String</Stage>
        <StepKey>String</StepKey>
        <Value>String</Value>
      </CourierProofResultView>
    </Proof>
    <QueueSequence>0</QueueSequence>
    <ReadyUtc>0001-01-01T00:00:00</ReadyUtc>
    <RebookOfId>0</RebookOfId>
    <RecurrenceId>0</RecurrenceId>
    <RefundedAmount>0</RefundedAmount>
    <RouteShape>String</RouteShape>
    <Rule>
      <AcceptedUtc>0001-01-01T00:00:00</AcceptedUtc>
      <CancelFee>0</CancelFee>
      <FinalPriceAfterCount>false</FinalPriceAfterCount>
      <MissedAutoRebook>false</MissedAutoRebook>
      <MissedFee>0</MissedFee>
      <MissedRequireContact>false</MissedRequireContact>
      <MissedRequirePhoto>false</MissedRequirePhoto>
      <MissedWaitMin>0</MissedWaitMin>
      <PayPlanName>String</PayPlanName>
      <PayTiming>String</PayTiming>
      <PerCancel>0</PerCancel>
      <PerMissed>0</PerMissed>
      <PerPickup>0</PerPickup>
      <PerStop>0</PerStop>
      <PingSecs>0</PingSecs>
      <Proof xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </Proof>
    </Rule>
    <RunCode>String</RunCode>
    <Scans>
      <CourierScanView>
        <AtUtc>0001-01-01T00:00:00</AtUtc>
        <Result>String</Result>
        <Stage>String</Stage>
        <TagCode>String</TagCode>
      </CourierScanView>
    </Scans>
    <ServiceLevelCode>String</ServiceLevelCode>
    <Source>String</Source>
    <Stage>String</Stage>
    <StepLabel>String</StepLabel>
    <StopSequence>0</StopSequence>
    <TipAmount>0</TipAmount>
    <Unit>String</Unit>
    <UnitMany>String</UnitMany>
    <UnitOne>String</UnitOne>
    <Units>0</Units>
    <UnitsFound>0</UnitsFound>
    <WindowEndUtc>0001-01-01T00:00:00</WindowEndUtc>
    <WindowStartUtc>0001-01-01T00:00:00</WindowStartUtc>
    <WindowText>String</WindowText>
    <Zip>String</Zip>
    <Zone>String</Zone>
  </Order>
  <Orders>
    <CourierOrderView>
      <Address>String</Address>
      <ArrivedUtc>0001-01-01T00:00:00</ArrivedUtc>
      <AuthorizedAmount>0</AuthorizedAmount>
      <CancelFeeApplied>0</CancelFeeApplied>
      <CancelReason>String</CancelReason>
      <CancelledBy>String</CancelledBy>
      <CancelledUtc>0001-01-01T00:00:00</CancelledUtc>
      <CandidateCode>String</CandidateCode>
      <CaptureMode>String</CaptureMode>
      <CapturedAmount>0</CapturedAmount>
      <ChargeError>String</ChargeError>
      <City>String</City>
      <Code>String</Code>
      <CourierFacilityId>0</CourierFacilityId>
      <CourierProfileId>0</CourierProfileId>
      <CourierRunId>0</CourierRunId>
      <CourierStep>String</CourierStep>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CustomerName>String</CustomerName>
      <CustomerPhone>String</CustomerPhone>
      <DamageNote>String</DamageNote>
      <DeliveredToName>String</DeliveredToName>
      <DeliveredUtc>0001-01-01T00:00:00</DeliveredUtc>
      <DispatchOdRequestID>0</DispatchOdRequestID>
      <DriverCode>String</DriverCode>
      <DriverContactId>0</DriverContactId>
      <DriverName>String</DriverName>
      <DropoffAddress>String</DropoffAddress>
      <DropoffCity>String</DropoffCity>
      <DropoffContactName>String</DropoffContactName>
      <DropoffUnit>String</DropoffUnit>
      <DropoffZip>String</DropoffZip>
      <DueText>String</DueText>
      <DueUtc>0001-01-01T00:00:00</DueUtc>
      <Events>
        <CourierEventView>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <Body>String</Body>
          <Kind>String</Kind>
          <Party>String</Party>
        </CourierEventView>
      </Events>
      <FacilityName>String</FacilityName>
      <Fare>0</Fare>
      <FinalPrice>0</FinalPrice>
      <GateCode>String</GateCode>
      <Handoff>String</Handoff>
      <HeldReason>String</HeldReason>
      <HeldUtc>0001-01-01T00:00:00</HeldUtc>
      <Instructions>String</Instructions>
      <IntakeUtc>0001-01-01T00:00:00</IntakeUtc>
      <IsAsap>false</IsAsap>
      <IsClosed>false</IsClosed>
      <Items>
        <CourierItemView>
          <CourierItemID>0</CourierItemID>
          <Custody>String</Custody>
          <DispatchOdRequestID>0</DispatchOdRequestID>
          <IsManual>false</IsManual>
          <IsMissing>false</IsMissing>
          <IsOpen>false</IsOpen>
          <MissingReason>String</MissingReason>
          <ReTagFlag>false</ReTagFlag>
          <Scanned>false</Scanned>
          <Seq>0</Seq>
          <TagCode>String</TagCode>
        </CourierItemView>
      </Items>
      <LevelName>String</LevelName>
      <Miles>0</Miles>
      <MissedFeeApplied>0</MissedFeeApplied>
      <MissedUtc>0001-01-01T00:00:00</MissedUtc>
      <OutForDeliveryUtc>0001-01-01T00:00:00</OutForDeliveryUtc>
      <PayLines>
        <CourierPayLineView>
          <Amount>0</Amount>
          <DispatchLoadID>0</DispatchLoadID>
          <Kind>String</Kind>
          <Label>String</Label>
          <Qty>0</Qty>
          <Rate>0</Rate>
        </CourierPayLineView>
      </PayLines>
      <PayMode>String</PayMode>
      <Photos>
        <CourierPhotoView>
          <FileName>String</FileName>
          <Kind>String</Kind>
          <PhotoId>0</PhotoId>
          <TakenUtc>0001-01-01T00:00:00</TakenUtc>
          <Url>String</Url>
        </CourierPhotoView>
      </Photos>
      <PickedUpUtc>0001-01-01T00:00:00</PickedUpUtc>
      <PickupContactName>String</PickupContactName>
      <PickupLoadId>0</PickupLoadId>
      <PingAfterUtc>0001-01-01T00:00:00</PingAfterUtc>
      <PingExpiresUtc>0001-01-01T00:00:00</PingExpiresUtc>
      <ProfileName>String</ProfileName>
      <Proof>
        <CourierProofResultView>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <Stage>String</Stage>
          <StepKey>String</StepKey>
          <Value>String</Value>
        </CourierProofResultView>
      </Proof>
      <QueueSequence>0</QueueSequence>
      <ReadyUtc>0001-01-01T00:00:00</ReadyUtc>
      <RebookOfId>0</RebookOfId>
      <RecurrenceId>0</RecurrenceId>
      <RefundedAmount>0</RefundedAmount>
      <RouteShape>String</RouteShape>
      <Rule>
        <AcceptedUtc>0001-01-01T00:00:00</AcceptedUtc>
        <CancelFee>0</CancelFee>
        <FinalPriceAfterCount>false</FinalPriceAfterCount>
        <MissedAutoRebook>false</MissedAutoRebook>
        <MissedFee>0</MissedFee>
        <MissedRequireContact>false</MissedRequireContact>
        <MissedRequirePhoto>false</MissedRequirePhoto>
        <MissedWaitMin>0</MissedWaitMin>
        <PayPlanName>String</PayPlanName>
        <PayTiming>String</PayTiming>
        <PerCancel>0</PerCancel>
        <PerMissed>0</PerMissed>
        <PerPickup>0</PerPickup>
        <PerStop>0</PerStop>
        <PingSecs>0</PingSecs>
        <Proof xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </Proof>
      </Rule>
      <RunCode>String</RunCode>
      <Scans>
        <CourierScanView>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <Result>String</Result>
          <Stage>String</Stage>
          <TagCode>String</TagCode>
        </CourierScanView>
      </Scans>
      <ServiceLevelCode>String</ServiceLevelCode>
      <Source>String</Source>
      <Stage>String</Stage>
      <StepLabel>String</StepLabel>
      <StopSequence>0</StopSequence>
      <TipAmount>0</TipAmount>
      <Unit>String</Unit>
      <UnitMany>String</UnitMany>
      <UnitOne>String</UnitOne>
      <Units>0</Units>
      <UnitsFound>0</UnitsFound>
      <WindowEndUtc>0001-01-01T00:00:00</WindowEndUtc>
      <WindowStartUtc>0001-01-01T00:00:00</WindowStartUtc>
      <WindowText>String</WindowText>
      <Zip>String</Zip>
      <Zone>String</Zone>
    </CourierOrderView>
  </Orders>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CourierOrderResponse>