Trendsic Platform Service

<back to all web services

CourierTrackCancelRequest

The following routes are available for this service:
POST,OPTIONS/v1/dispatch/track/{Token}/cancel
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class CourierTrackActRequest
            Public Overridable Property Token As String
            Public Overridable Property ActToken As String
        End Class

        Public Partial Class CourierTrackBusiness
            Public Overridable Property Name As String
            Public Overridable Property Phone As String
        End Class

        Public Partial Class CourierTrackCan
            Public Overridable Property EditInstructions As Boolean
            Public Overridable Property ChangeUnits As Boolean
            Public Overridable Property Cancel As Boolean
            Public Overridable Property RescheduleDelivery As Boolean
            Public Overridable Property Rebook As Boolean
            Public Overridable Property Rate As Boolean
            Public Overridable Property Message As Boolean
            Public Overridable Property Report As Boolean
            Public Overridable Property MaxUnits As Integer
        End Class

        Public Partial Class CourierTrackCancelRequest
            Inherits CourierTrackActRequest
            Public Overridable Property ExpectedFee As Decimal?
        End Class

        Public Partial Class CourierTrackDriver
            Public Overridable Property FirstName As String
            Public Overridable Property Initial As String
            Public Overridable Property Vehicle As String
            Public Overridable Property Plate As String
            Public Overridable Property EtaMin As Integer?
            Public Overridable Property EtaPct As Integer?
        End Class

        Public Partial Class CourierTrackMessage
            Public Overridable Property Who As String
            Public Overridable Property Mine As Boolean
            Public Overridable Property Office As Boolean
            Public Overridable Property AtText As String
            Public Overridable Property Body As String
        End Class

        Public Partial Class CourierTrackMissed
            Public Overridable Property Code As String
            Public Overridable Property Fee As Decimal
            Public Overridable Property WaitedMin As Integer
            Public Overridable Property AutoRebook As Boolean
            Public Overridable Property RebookWindowText As String
            Public Overridable Property Slots As List(Of CourierTrackSlot) = New List(Of CourierTrackSlot)
        End Class

        Public Partial Class CourierTrackProof
            Public Overridable Property Kind As String
            Public Overridable Property PhotoUrl As String
            Public Overridable Property AtText As String
            Public Overridable Property GpsOk As Boolean
            Public Overridable Property Units As Integer
            Public Overridable Property DamageNote As String
            Public Overridable Property DeliveredTo As String
            Public Overridable Property WaitedMin As Integer
            Public Overridable Property Attempts As Integer
            Public Overridable Property ContactedText As String
            Public Overridable Property EachTagged As Boolean
            Public Overridable Property EachScanned As Boolean
        End Class

        Public Partial Class CourierTrackRating
            Public Overridable Property Stars As Integer
            Public Overridable Property Tags As String
            Public Overridable Property Tip As Decimal
            Public Overridable Property TipStatus As String
        End Class

        Public Partial Class CourierTrackSlot
            Public Overridable Property Id As String
            Public Overridable Property Day As String
            Public Overridable Property DayEs As String
            Public Overridable Property Win As String
        End Class

        Public Partial Class CourierTrackView
            Public Overridable Property State As String
            Public Overridable Property Code As String
            Public Overridable Property RunCode As String
            Public Overridable Property Shape As String
            Public Overridable Property Template As String
            Public Overridable Property CourierStep As String
            Public Overridable Property UnitOne As String
            Public Overridable Property UnitMany As String
            Public Overridable Property UnitOneEs As String
            Public Overridable Property UnitManyEs As String
            Public Overridable Property FacilityNoun As String
            Public Overridable Property FacilityNounEs As String
            Public Overridable Property Units As Integer
            Public Overridable Property UnitsCounted As Boolean
            Public Overridable Property Address As String
            Public Overridable Property DropoffAddress As String
            Public Overridable Property DropoffName As String
            Public Overridable Property Instructions As String
            Public Overridable Property GateCode As String
            Public Overridable Property Handoff As String
            Public Overridable Property LevelName As String
            Public Overridable Property ReadyPromise As String
            Public Overridable Property WindowText As String
            Public Overridable Property IsAsap As Boolean
            Public Overridable Property Times As Dictionary(Of String, String) = New Dictionary(Of String, String)
            Public Overridable Property StopPosition As Integer?
            Public Overridable Property StopCount As Integer?
            Public Overridable Property DeliveryWindowText As String
            Public Overridable Property Driver As CourierTrackDriver
            Public Overridable Property Proof As CourierTrackProof
            Public Overridable Property HandoffCode As String
            Public Overridable Property Rating As CourierTrackRating
            Public Overridable Property TipAllowed As Boolean
            Public Overridable Property TipsPct As Decimal
            Public Overridable Property Missed As CourierTrackMissed
            Public Overridable Property CancelFee As Decimal
            Public Overridable Property CancelFeeCharged As Decimal
            Public Overridable Property CancelledBy As String
            Public Overridable Property BookUrl As String
            Public Overridable Property Can As CourierTrackCan
            Public Overridable Property DeliverySlots As List(Of CourierTrackSlot) = New List(Of CourierTrackSlot)
            Public Overridable Property Messages As List(Of CourierTrackMessage) = New List(Of CourierTrackMessage)
            Public Overridable Property MessagesOpen As Boolean
            Public Overridable Property CaseCode As String
            Public Overridable Property CaseStatus As String
            Public Overridable Property CaseReply As String
            Public Overridable Property ThreadHrs As Integer
            Public Overridable Property ExpiresUtc As Date?
            Public Overridable Property LiveEta As Boolean
            Public Overridable Property Live As Boolean
            Public Overridable Property ServerUtc As Date
        End Class

        Public Partial Class DispatchTrackResponse
            Public Overridable Property Kind As String
            Public Overridable Property Code As String
            Public Overridable Property What As String
            Public Overridable Property FromLoc As String
            Public Overridable Property ToLoc As String
            Public Overridable Property Bags As Integer?
            Public Overridable Property Fare As Decimal?
            Public Overridable Property PayMode As String
            Public Overridable Property CardLast4 As String
            Public Overridable Property Charged As Boolean
            Public Overridable Property Stage As String
            Public Overridable Property Headline As String
            Public Overridable Property [Sub] As String
            Public Overridable Property IsClosed As Boolean
            Public Overridable Property Eta As String
            Public Overridable Property DriverName As String
            Public Overridable Property CustomerName As String
            Public Overridable Property Steps As List(Of DispatchTrackStepView) = New List(Of DispatchTrackStepView)
            Public Overridable Property Expired As Boolean
            Public Overridable Property Invalid As Boolean
            Public Overridable Property Business As CourierTrackBusiness
            Public Overridable Property Courier As CourierTrackView
            Public Overridable Property Notice As String
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class DispatchTrackStepView
            Public Overridable Property Name As String
            Public Overridable Property At As Date?
            Public Overridable Property Done As Boolean
            Public Overridable Property Current As Boolean
        End Class
    End Namespace
End Namespace

VB.NET CourierTrackCancelRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/dispatch/track/{Token}/cancel HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"ExpectedFee":0,"Token":"String","ActToken":"String"}

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

{"Kind":"String","Code":"String","What":"String","FromLoc":"String","ToLoc":"String","Bags":0,"Fare":0,"PayMode":"String","CardLast4":"String","Charged":false,"Stage":"String","Headline":"String","Sub":"String","IsClosed":false,"Eta":"String","DriverName":"String","CustomerName":"String","Steps":[{"Name":"String","At":"0001-01-01T00:00:00.0000000","Done":false,"Current":false}],"Expired":false,"Invalid":false,"Business":{"Name":"String","Phone":"String"},"Courier":{"State":"String","Code":"String","RunCode":"String","Shape":"String","Template":"String","CourierStep":"String","UnitOne":"String","UnitMany":"String","UnitOneEs":"String","UnitManyEs":"String","FacilityNoun":"String","FacilityNounEs":"String","Units":0,"UnitsCounted":false,"Address":"String","DropoffAddress":"String","DropoffName":"String","Instructions":"String","GateCode":"String","Handoff":"String","LevelName":"String","ReadyPromise":"String","WindowText":"String","IsAsap":false,"Times":{"String":"String"},"StopPosition":0,"StopCount":0,"DeliveryWindowText":"String","Driver":{"FirstName":"String","Initial":"String","Vehicle":"String","Plate":"String","EtaMin":0,"EtaPct":0},"Proof":{"Kind":"String","PhotoUrl":"String","AtText":"String","GpsOk":false,"Units":0,"DamageNote":"String","DeliveredTo":"String","WaitedMin":0,"Attempts":0,"ContactedText":"String","EachTagged":false,"EachScanned":false},"HandoffCode":"String","Rating":{"Stars":0,"Tags":"String","Tip":0,"TipStatus":"String"},"TipAllowed":false,"TipsPct":0,"Missed":{"Code":"String","Fee":0,"WaitedMin":0,"AutoRebook":false,"RebookWindowText":"String","Slots":[{"Id":"String","Day":"String","DayEs":"String","Win":"String"}]},"CancelFee":0,"CancelFeeCharged":0,"CancelledBy":"String","BookUrl":"String","Can":{"EditInstructions":false,"ChangeUnits":false,"Cancel":false,"RescheduleDelivery":false,"Rebook":false,"Rate":false,"Message":false,"Report":false,"MaxUnits":0},"DeliverySlots":[{"Id":"String","Day":"String","DayEs":"String","Win":"String"}],"Messages":[{"Who":"String","Mine":false,"Office":false,"AtText":"String","Body":"String"}],"MessagesOpen":false,"CaseCode":"String","CaseStatus":"String","CaseReply":"String","ThreadHrs":0,"ExpiresUtc":"0001-01-01T00:00:00.0000000","LiveEta":false,"Live":false,"ServerUtc":"0001-01-01T00:00:00.0000000"},"Notice":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}