Trendsic Platform Service

<back to all web services

CourierProfileResetRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/courier/profiles/{Id}/reset
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 CourierBooking
            Public Overridable Property [On] As Boolean
            Public Overridable Property Slug As String
            Public Overridable Property Asap As Boolean
            Public Overridable Property MinLeadMin As Integer
            Public Overridable Property Open As String
            Public Overridable Property Close As String
            Public Overridable Property DriveBufferMin As Integer
            Public Overridable Property Zips As List(Of String) = New List(Of String)
            Public Overridable Property Recurring As Boolean
            Public Overridable Property PayTiming As String
        End Class

        Public Partial Class CourierChange
            Public Overridable Property Key As String
            Public Overridable Property Section As String
            Public Overridable Property Label As String
            Public Overridable Property From As String
            Public Overridable Property [To] As String
        End Class

        Public Partial Class CourierDispatch
            Public Overridable Property PingSecs As Integer
            Public Overridable Property RadiusMi As Decimal
            Public Overridable Property DeclinePenalty As Boolean
            Public Overridable Property NextRule As String
            Public Overridable Property GoMin As Integer
            Public Overridable Property LastMin As Integer
            Public Overridable Property NearFull As Integer
            Public Overridable Property MarginMin As Integer
            Public Overridable Property TrafficSource As String
        End Class

        Public Partial Class CourierFacilityView
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property Address As String
            Public Overridable Property IntakeMin As Integer
            Public Overridable Property Levels As List(Of CourierLevelView) = New List(Of CourierLevelView)
            Public Overridable Property Holidays As List(Of String) = New List(Of String)
        End Class

        Public Partial Class CourierFleetVehicle
            Public Overridable Property EquipmentID As Integer
            Public Overridable Property UnitNumber As String
            Public Overridable Property Name As String
            Public Overridable Property VehicleType As String
            Public Overridable Property Unit As String
            Public Overridable Property Cap As Decimal?
            Public Overridable Property Cold As Boolean
            Public Overridable Property Status As String
            Public Overridable Property Assigned As Boolean
        End Class

        Public Partial Class CourierIssue
            Public Overridable Property Key As String
            Public Overridable Property Section As String
            Public Overridable Property Message As String
        End Class

        Public Partial Class CourierLevelView
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property InBy As String
            Public Overridable Property WithinMin As Integer
            Public Overridable Property Ready As String
            Public Overridable Property Days As List(Of Integer) = New List(Of Integer)
            Public Overridable Property IsOn As Boolean
        End Class

        Public Partial Class CourierMissed
            Public Overridable Property WaitMin As Integer
            Public Overridable Property Fee As Decimal
            Public Overridable Property CancelFee As Decimal
            Public Overridable Property AutoRebook As Boolean
            Public Overridable Property RequireContact As Boolean
            Public Overridable Property RequirePhoto As Boolean
        End Class

        Public Partial Class CourierPay
            Public Overridable Property WorkerClass As String
            Public Overridable Property PerPickup As Decimal
            Public Overridable Property PerStop As Decimal
            Public Overridable Property PerMissed As Decimal
            Public Overridable Property PerCancel As Decimal
            Public Overridable Property WaitAfterMin As Integer
            Public Overridable Property WaitPerMin As Decimal
            Public Overridable Property MileageOn As Boolean
            Public Overridable Property PerMile As Decimal
            Public Overridable Property MinPerJob As Decimal
            Public Overridable Property TipsPct As Decimal
        End Class

        Public Partial Class CourierPreview
            Public Overridable Property DeadlineTitle As String
            Public Overridable Property DeadlineLead As String
            Public Overridable Property RoomW As String
            Public Overridable Property LastW As String
            Public Overridable Property GoW As String
            Public Overridable Property Zones As List(Of CourierPreviewLine) = New List(Of CourierPreviewLine)
            Public Overridable Property PaySub As String
            Public Overridable Property PayRows As List(Of CourierPreviewLine) = New List(Of CourierPreviewLine)
            Public Overridable Property PayTotal As String
            Public Overridable Property ProofRows As List(Of CourierPreviewLine) = New List(Of CourierPreviewLine)
            Public Overridable Property Ping As String
        End Class

        Public Partial Class CourierPreviewLine
            Public Overridable Property K As String
            Public Overridable Property V As String
            Public Overridable Property Dot As String
        End Class

        Public Partial Class CourierPricing
            Public Overridable Property Base As Decimal
            Public Overridable Property PerUnit As Decimal
            Public Overridable Property PerMile As Decimal
            Public Overridable Property MinOrder As Decimal
            Public Overridable Property TaxPct As Decimal
            Public Overridable Property FinalAfterCount As Boolean
            Public Overridable Property ServiceArea As List(Of String) = New List(Of String)
            Public Overridable Property WindowMin As Integer
            Public Overridable Property Surcharges As Dictionary(Of String, Decimal) = New Dictionary(Of String, Decimal)
        End Class

        Public Partial Class CourierPrivacy
            Public Overridable Property ThreadHrs As Integer
            Public Overridable Property PhotoDays As Integer
            Public Overridable Property LockNames As String
            Public Overridable Property HideAddr As Boolean
            Public Overridable Property LiveEta As Boolean
            Public Overridable Property Tipping As Boolean
        End Class

        Public Partial Class CourierProfileContext
            Public Overridable Property Drivers As Integer
            Public Overridable Property ProfileCount As Integer
            Public Overridable Property PayPlanId As Integer?
            Public Overridable Property ZoneMode As String
            Public Overridable Property ZoneName As String
            Public Overridable Property ZoneCount As Integer
            Public Overridable Property HasBookingPage As Boolean
            Public Overridable Property HasRateConfig As Boolean
            Public Overridable Property VehicleFacts As Dictionary(Of String, String) = New Dictionary(Of String, String)
        End Class

        Public Partial Class CourierProfileResetRequest
            Public Overridable Property Id As Integer
            Public Overridable Property DryRun As Boolean
        End Class

        Public Partial Class CourierProfileSummary
            Public Overridable Property CourierProfileID As Integer
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property BusinessName As String
            Public Overridable Property RouteShape As String
            Public Overridable Property Enabled As Boolean
            Public Overridable Property TemplateFrom As String
            Public Overridable Property Drivers As Integer
        End Class

        Public Partial Class CourierProfileView
            Public Overridable Property CourierProfileID As Integer
            Public Overridable Property Code As String
            Public Overridable Property Name As String
            Public Overridable Property BusinessName As String
            Public Overridable Property RouteShape As String
            Public Overridable Property Enabled As Boolean
            Public Overridable Property TemplateFrom As String
            Public Overridable Property UnitOne As String
            Public Overridable Property UnitMany As String
            Public Overridable Property FacilityNoun As String
            Public Overridable Property UnitOneEs As String
            Public Overridable Property UnitManyEs As String
            Public Overridable Property FacilityNounEs As String
            Public Overridable Property TagMode As String
            Public Overridable Property TagFormats As List(Of String) = New List(Of String)
            Public Overridable Property Pay As CourierPay
            Public Overridable Property Dispatch As CourierDispatch
            Public Overridable Property Missed As CourierMissed
            Public Overridable Property Privacy As CourierPrivacy
            Public Overridable Property Pricing As CourierPricing
            Public Overridable Property Booking As CourierBooking
            Public Overridable Property Facilities As List(Of CourierFacilityView) = New List(Of CourierFacilityView)
            Public Overridable Property Vehicles As List(Of CourierVehicleView) = New List(Of CourierVehicleView)
            Public Overridable Property Proof As Dictionary(Of String, Dictionary(Of String,String)) = New Dictionary(Of String, Dictionary(Of String,String))
            Public Overridable Property Context As CourierProfileContext
        End Class

        Public Partial Class CourierResponse
            Public Overridable Property Profiles As List(Of CourierProfileSummary) = New List(Of CourierProfileSummary)
            Public Overridable Property Templates As List(Of CourierTemplateOption) = New List(Of CourierTemplateOption)
            Public Overridable Property Profile As CourierProfileView
            Public Overridable Property Issues As List(Of CourierIssue) = New List(Of CourierIssue)
            Public Overridable Property Changes As List(Of CourierChange) = New List(Of CourierChange)
            Public Overridable Property Preview As CourierPreview
            Public Overridable Property Fleet As List(Of CourierFleetVehicle) = New List(Of CourierFleetVehicle)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class CourierTemplateOption
            Public Overridable Property Key As String
            Public Overridable Property Label As String
            Public Overridable Property Detail As String
            Public Overridable Property RouteShape As String
        End Class

        Public Partial Class CourierVehicleView
            Public Overridable Property EquipmentID As Integer
            Public Overridable Property UnitNumber As String
            Public Overridable Property Name As String
            Public Overridable Property Unit As String
            Public Overridable Property Cap As Decimal
            Public Overridable Property Cold As Boolean
        End Class
    End Namespace
End Namespace

VB.NET CourierProfileResetRequest DTOs

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

HTTP + CSV

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

POST /v1/dispatch/courier/profiles/{Id}/reset HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":0,"DryRun":false}

HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Profiles":[{"CourierProfileID":0,"Code":"String","Name":"String","BusinessName":"String","RouteShape":"String","Enabled":false,"TemplateFrom":"String","Drivers":0}],"Templates":[{"Key":"String","Label":"String","Detail":"String","RouteShape":"String"}],"Profile":{"CourierProfileID":0,"Code":"String","Name":"String","BusinessName":"String","RouteShape":"String","Enabled":false,"TemplateFrom":"String","UnitOne":"String","UnitMany":"String","FacilityNoun":"String","UnitOneEs":"String","UnitManyEs":"String","FacilityNounEs":"String","TagMode":"String","TagFormats":["String"],"Pay":{"WorkerClass":"String","PerPickup":0,"PerStop":0,"PerMissed":0,"PerCancel":0,"WaitAfterMin":0,"WaitPerMin":0,"MileageOn":false,"PerMile":0,"MinPerJob":0,"TipsPct":0},"Dispatch":{"PingSecs":0,"RadiusMi":0,"DeclinePenalty":false,"NextRule":"String","GoMin":0,"LastMin":0,"NearFull":0,"MarginMin":0,"TrafficSource":"String"},"Missed":{"WaitMin":0,"Fee":0,"CancelFee":0,"AutoRebook":false,"RequireContact":false,"RequirePhoto":false},"Privacy":{"ThreadHrs":0,"PhotoDays":0,"LockNames":"String","HideAddr":false,"LiveEta":false,"Tipping":false},"Pricing":{"Base":0,"PerUnit":0,"PerMile":0,"MinOrder":0,"TaxPct":0,"FinalAfterCount":false,"ServiceArea":["String"],"WindowMin":0,"Surcharges":{"String":0}},"Booking":{"On":false,"Slug":"String","Asap":false,"MinLeadMin":0,"Open":"String","Close":"String","DriveBufferMin":0,"Zips":["String"],"Recurring":false,"PayTiming":"String"},"Facilities":[{"Code":"String","Name":"String","Address":"String","IntakeMin":0,"Levels":[{"Code":"String","Name":"String","InBy":"String","WithinMin":0,"Ready":"String","Days":[0],"IsOn":false}],"Holidays":["String"]}],"Vehicles":[{"EquipmentID":0,"UnitNumber":"String","Name":"String","Unit":"String","Cap":0,"Cold":false}],"Proof":{"String":{"String":"String"}},"Context":{"Drivers":0,"ProfileCount":0,"PayPlanId":0,"ZoneMode":"String","ZoneName":"String","ZoneCount":0,"HasBookingPage":false,"HasRateConfig":false,"VehicleFacts":{"String":"String"}}},"Issues":[{"Key":"String","Section":"String","Message":"String"}],"Changes":[{"Key":"String","Section":"String","Label":"String","From":"String","To":"String"}],"Preview":{"DeadlineTitle":"String","DeadlineLead":"String","RoomW":"String","LastW":"String","GoW":"String","Zones":[{"K":"String","V":"String","Dot":"String"}],"PaySub":"String","PayRows":[{"K":"String","V":"String","Dot":"String"}],"PayTotal":"String","ProofRows":[{"K":"String","V":"String","Dot":"String"}],"Ping":"String"},"Fleet":[{"EquipmentID":0,"UnitNumber":"String","Name":"String","VehicleType":"String","Unit":"String","Cap":0,"Cold":false,"Status":"String","Assigned":false}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}