| GET,OPTIONS | /v1/dispatch/courier/held-pings |
|---|
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 CourierEventView
Public Overridable Property Kind As String
Public Overridable Property Party As String
Public Overridable Property Body As String
Public Overridable Property AtUtc As Date
End Class
Public Partial Class CourierHeldPingsRequest
End Class
Public Partial Class CourierItemView
Public Overridable Property CourierItemID As Integer
Public Overridable Property DispatchOdRequestID As Integer
Public Overridable Property Seq As Integer
Public Overridable Property TagCode As String
Public Overridable Property Custody As String
Public Overridable Property IsOpen As Boolean
Public Overridable Property IsMissing As Boolean
Public Overridable Property MissingReason As String
Public Overridable Property IsManual As Boolean
Public Overridable Property ReTagFlag As Boolean
Public Overridable Property Scanned As Boolean
End Class
Public Partial Class CourierOrderResponse
Public Overridable Property Orders As List(Of CourierOrderView) = New List(Of CourierOrderView)
Public Overridable Property Order As CourierOrderView
Public Overridable Property Message As String
Public Overridable Property ResponseStatus As ResponseStatus
End Class
Public Partial Class CourierOrderRuleView
Public Overridable Property PingSecs As Integer
Public Overridable Property MissedWaitMin As Integer
Public Overridable Property MissedFee As Decimal
Public Overridable Property CancelFee As Decimal
Public Overridable Property MissedAutoRebook As Boolean
Public Overridable Property MissedRequireContact As Boolean
Public Overridable Property MissedRequirePhoto As Boolean
Public Overridable Property PayTiming As String
Public Overridable Property FinalPriceAfterCount As Boolean
Public Overridable Property PayPlanName 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 AcceptedUtc As Date?
Public Overridable Property Proof As Dictionary(Of String, String) = New Dictionary(Of String, String)
End Class
Public Partial Class CourierOrderView
Public Overridable Property DispatchOdRequestID As Integer
Public Overridable Property Code As String
Public Overridable Property CourierProfileId As Integer
Public Overridable Property ProfileName As String
Public Overridable Property RouteShape As String
Public Overridable Property UnitOne As String
Public Overridable Property UnitMany As String
Public Overridable Property CourierFacilityId As Integer?
Public Overridable Property FacilityName As String
Public Overridable Property ServiceLevelCode As String
Public Overridable Property LevelName As String
Public Overridable Property Source As String
Public Overridable Property Address As String
Public Overridable Property Unit As String
Public Overridable Property City As String
Public Overridable Property Zip As String
Public Overridable Property Zone As String
Public Overridable Property PickupContactName As String
Public Overridable Property DropoffAddress As String
Public Overridable Property DropoffUnit As String
Public Overridable Property DropoffCity As String
Public Overridable Property DropoffZip As String
Public Overridable Property DropoffContactName As String
Public Overridable Property Miles As Decimal?
Public Overridable Property Units As Integer
Public Overridable Property UnitsFound As Integer?
Public Overridable Property Stage As String
Public Overridable Property CourierStep As String
Public Overridable Property StepLabel As String
Public Overridable Property DriverCode As String
Public Overridable Property DriverName As String
Public Overridable Property DriverContactId As Integer?
Public Overridable Property CourierRunId As Integer?
Public Overridable Property RunCode As String
Public Overridable Property StopSequence As Integer?
Public Overridable Property QueueSequence As Integer?
Public Overridable Property IsAsap As Boolean
Public Overridable Property WindowStartUtc As Date?
Public Overridable Property WindowEndUtc As Date?
Public Overridable Property WindowText As String
Public Overridable Property DueUtc As Date?
Public Overridable Property DueText As String
Public Overridable Property PingAfterUtc As Date?
Public Overridable Property PingExpiresUtc As Date?
Public Overridable Property CandidateCode As String
Public Overridable Property HeldReason As String
Public Overridable Property HeldUtc As Date?
Public Overridable Property CustomerName As String
Public Overridable Property CustomerPhone As String
Public Overridable Property Handoff As String
Public Overridable Property GateCode As String
Public Overridable Property Instructions As String
Public Overridable Property DamageNote As String
Public Overridable Property DeliveredToName As String
Public Overridable Property PayMode As String
Public Overridable Property Fare As Decimal?
Public Overridable Property FinalPrice As Decimal?
Public Overridable Property TipAmount As Decimal?
Public Overridable Property CancelledBy As String
Public Overridable Property CancelReason As String
Public Overridable Property CancelFeeApplied As Decimal?
Public Overridable Property MissedFeeApplied As Decimal?
Public Overridable Property CaptureMode As String
Public Overridable Property AuthorizedAmount As Decimal?
Public Overridable Property CapturedAmount As Decimal?
Public Overridable Property RefundedAmount As Decimal
Public Overridable Property ChargeError As String
Public Overridable Property CreatedAt As Date?
Public Overridable Property ArrivedUtc As Date?
Public Overridable Property PickedUpUtc As Date?
Public Overridable Property IntakeUtc As Date?
Public Overridable Property ReadyUtc As Date?
Public Overridable Property OutForDeliveryUtc As Date?
Public Overridable Property DeliveredUtc As Date?
Public Overridable Property MissedUtc As Date?
Public Overridable Property CancelledUtc As Date?
Public Overridable Property IsClosed As Boolean
Public Overridable Property RebookOfId As Integer?
Public Overridable Property RecurrenceId As Integer?
Public Overridable Property PickupLoadId As Integer?
Public Overridable Property Rule As CourierOrderRuleView
Public Overridable Property Items As List(Of CourierItemView) = New List(Of CourierItemView)
Public Overridable Property Scans As List(Of CourierScanView) = New List(Of CourierScanView)
Public Overridable Property Proof As List(Of CourierProofResultView) = New List(Of CourierProofResultView)
Public Overridable Property Events As List(Of CourierEventView) = New List(Of CourierEventView)
Public Overridable Property Photos As List(Of CourierPhotoView) = New List(Of CourierPhotoView)
Public Overridable Property PayLines As List(Of CourierPayLineView) = New List(Of CourierPayLineView)
End Class
Public Partial Class CourierPayLineView
Public Overridable Property DispatchLoadID As Integer
Public Overridable Property Kind As String
Public Overridable Property Label As String
Public Overridable Property Qty As Decimal?
Public Overridable Property Rate As Decimal?
Public Overridable Property Amount As Decimal
End Class
Public Partial Class CourierPhotoView
Public Overridable Property PhotoId As Integer
Public Overridable Property Kind As String
Public Overridable Property FileName As String
Public Overridable Property Url As String
Public Overridable Property TakenUtc As Date?
End Class
Public Partial Class CourierProofResultView
Public Overridable Property Stage As String
Public Overridable Property StepKey As String
Public Overridable Property Value As String
Public Overridable Property AtUtc As Date
End Class
Public Partial Class CourierScanView
Public Overridable Property TagCode As String
Public Overridable Property Stage As String
Public Overridable Property Result As String
Public Overridable Property AtUtc As Date
End Class
End Namespace
End Namespace
VB.NET CourierHeldPingsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/dispatch/courier/held-pings HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length
{"Orders":[{"DispatchOdRequestID":0,"Code":"String","CourierProfileId":0,"ProfileName":"String","RouteShape":"String","UnitOne":"String","UnitMany":"String","CourierFacilityId":0,"FacilityName":"String","ServiceLevelCode":"String","LevelName":"String","Source":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Zone":"String","PickupContactName":"String","DropoffAddress":"String","DropoffUnit":"String","DropoffCity":"String","DropoffZip":"String","DropoffContactName":"String","Miles":0,"Units":0,"UnitsFound":0,"Stage":"String","CourierStep":"String","StepLabel":"String","DriverCode":"String","DriverName":"String","DriverContactId":0,"CourierRunId":0,"RunCode":"String","StopSequence":0,"QueueSequence":0,"IsAsap":false,"WindowStartUtc":"0001-01-01T00:00:00.0000000","WindowEndUtc":"0001-01-01T00:00:00.0000000","WindowText":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","PingAfterUtc":"0001-01-01T00:00:00.0000000","PingExpiresUtc":"0001-01-01T00:00:00.0000000","CandidateCode":"String","HeldReason":"String","HeldUtc":"0001-01-01T00:00:00.0000000","CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","DamageNote":"String","DeliveredToName":"String","PayMode":"String","Fare":0,"FinalPrice":0,"TipAmount":0,"CancelledBy":"String","CancelReason":"String","CancelFeeApplied":0,"MissedFeeApplied":0,"CaptureMode":"String","AuthorizedAmount":0,"CapturedAmount":0,"RefundedAmount":0,"ChargeError":"String","CreatedAt":"0001-01-01T00:00:00.0000000","ArrivedUtc":"0001-01-01T00:00:00.0000000","PickedUpUtc":"0001-01-01T00:00:00.0000000","IntakeUtc":"0001-01-01T00:00:00.0000000","ReadyUtc":"0001-01-01T00:00:00.0000000","OutForDeliveryUtc":"0001-01-01T00:00:00.0000000","DeliveredUtc":"0001-01-01T00:00:00.0000000","MissedUtc":"0001-01-01T00:00:00.0000000","CancelledUtc":"0001-01-01T00:00:00.0000000","IsClosed":false,"RebookOfId":0,"RecurrenceId":0,"PickupLoadId":0,"Rule":{"PingSecs":0,"MissedWaitMin":0,"MissedFee":0,"CancelFee":0,"MissedAutoRebook":false,"MissedRequireContact":false,"MissedRequirePhoto":false,"PayTiming":"String","FinalPriceAfterCount":false,"PayPlanName":"String","PerPickup":0,"PerStop":0,"PerMissed":0,"PerCancel":0,"AcceptedUtc":"0001-01-01T00:00:00.0000000","Proof":{"String":"String"}},"Items":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}],"Scans":[{"TagCode":"String","Stage":"String","Result":"String","AtUtc":"0001-01-01T00:00:00.0000000"}],"Proof":[{"Stage":"String","StepKey":"String","Value":"String","AtUtc":"0001-01-01T00:00:00.0000000"}],"Events":[{"Kind":"String","Party":"String","Body":"String","AtUtc":"0001-01-01T00:00:00.0000000"}],"Photos":[{"PhotoId":0,"Kind":"String","FileName":"String","Url":"String","TakenUtc":"0001-01-01T00:00:00.0000000"}],"PayLines":[{"DispatchLoadID":0,"Kind":"String","Label":"String","Qty":0,"Rate":0,"Amount":0}]}],"Order":{"DispatchOdRequestID":0,"Code":"String","CourierProfileId":0,"ProfileName":"String","RouteShape":"String","UnitOne":"String","UnitMany":"String","CourierFacilityId":0,"FacilityName":"String","ServiceLevelCode":"String","LevelName":"String","Source":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Zone":"String","PickupContactName":"String","DropoffAddress":"String","DropoffUnit":"String","DropoffCity":"String","DropoffZip":"String","DropoffContactName":"String","Miles":0,"Units":0,"UnitsFound":0,"Stage":"String","CourierStep":"String","StepLabel":"String","DriverCode":"String","DriverName":"String","DriverContactId":0,"CourierRunId":0,"RunCode":"String","StopSequence":0,"QueueSequence":0,"IsAsap":false,"WindowStartUtc":"0001-01-01T00:00:00.0000000","WindowEndUtc":"0001-01-01T00:00:00.0000000","WindowText":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","PingAfterUtc":"0001-01-01T00:00:00.0000000","PingExpiresUtc":"0001-01-01T00:00:00.0000000","CandidateCode":"String","HeldReason":"String","HeldUtc":"0001-01-01T00:00:00.0000000","CustomerName":"String","CustomerPhone":"String","Handoff":"String","GateCode":"String","Instructions":"String","DamageNote":"String","DeliveredToName":"String","PayMode":"String","Fare":0,"FinalPrice":0,"TipAmount":0,"CancelledBy":"String","CancelReason":"String","CancelFeeApplied":0,"MissedFeeApplied":0,"CaptureMode":"String","AuthorizedAmount":0,"CapturedAmount":0,"RefundedAmount":0,"ChargeError":"String","CreatedAt":"0001-01-01T00:00:00.0000000","ArrivedUtc":"0001-01-01T00:00:00.0000000","PickedUpUtc":"0001-01-01T00:00:00.0000000","IntakeUtc":"0001-01-01T00:00:00.0000000","ReadyUtc":"0001-01-01T00:00:00.0000000","OutForDeliveryUtc":"0001-01-01T00:00:00.0000000","DeliveredUtc":"0001-01-01T00:00:00.0000000","MissedUtc":"0001-01-01T00:00:00.0000000","CancelledUtc":"0001-01-01T00:00:00.0000000","IsClosed":false,"RebookOfId":0,"RecurrenceId":0,"PickupLoadId":0,"Rule":{"PingSecs":0,"MissedWaitMin":0,"MissedFee":0,"CancelFee":0,"MissedAutoRebook":false,"MissedRequireContact":false,"MissedRequirePhoto":false,"PayTiming":"String","FinalPriceAfterCount":false,"PayPlanName":"String","PerPickup":0,"PerStop":0,"PerMissed":0,"PerCancel":0,"AcceptedUtc":"0001-01-01T00:00:00.0000000","Proof":{"String":"String"}},"Items":[{"CourierItemID":0,"DispatchOdRequestID":0,"Seq":0,"TagCode":"String","Custody":"String","IsOpen":false,"IsMissing":false,"MissingReason":"String","IsManual":false,"ReTagFlag":false,"Scanned":false}],"Scans":[{"TagCode":"String","Stage":"String","Result":"String","AtUtc":"0001-01-01T00:00:00.0000000"}],"Proof":[{"Stage":"String","StepKey":"String","Value":"String","AtUtc":"0001-01-01T00:00:00.0000000"}],"Events":[{"Kind":"String","Party":"String","Body":"String","AtUtc":"0001-01-01T00:00:00.0000000"}],"Photos":[{"PhotoId":0,"Kind":"String","FileName":"String","Url":"String","TakenUtc":"0001-01-01T00:00:00.0000000"}],"PayLines":[{"DispatchLoadID":0,"Kind":"String","Label":"String","Qty":0,"Rate":0,"Amount":0}]},"Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}