| POST,OPTIONS | /v1/worker/dispatch/od/{Code}/scan |
|---|
namespace CRM.AgencyPlatform.API.Internal
open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations
[<AllowNullLiteral>]
type CourierVanView() =
member val State:String = null with get,set
member val LeaveByUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val LeaveByText:String = null with get,set
member val SlackMin:Nullable<Int32> = new Nullable<Int32>() with get,set
member val InVan:Int32 = new Int32() with get,set
member val Committed:Int32 = new Int32() with get,set
member val Cap:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val CapUnit:String = null with get,set
member val VehicleUnit:String = null with get,set
member val CriticalCode:String = null with get,set
member val DriveMin:Int32 = new Int32() with get,set
member val FacilityName:String = null with get,set
member val SendNote:String = null with get,set
[<AllowNullLiteral>]
type CourierItemView() =
member val CourierItemID:Int32 = new Int32() with get,set
member val DispatchOdRequestID:Int32 = new Int32() with get,set
member val Seq:Int32 = new Int32() with get,set
member val TagCode:String = null with get,set
member val Custody:String = null with get,set
member val IsOpen:Boolean = new Boolean() with get,set
member val IsMissing:Boolean = new Boolean() with get,set
member val MissingReason:String = null with get,set
member val IsManual:Boolean = new Boolean() with get,set
member val ReTagFlag:Boolean = new Boolean() with get,set
member val Scanned:Boolean = new Boolean() with get,set
[<AllowNullLiteral>]
type CourierDriverOrder() =
member val Code:String = null with get,set
member val CourierStep:String = null with get,set
member val RouteShape:String = null with get,set
member val ProfileName:String = null with get,set
member val UnitOne:String = null with get,set
member val UnitMany:String = null with get,set
member val FacilityNoun:String = null with get,set
member val FacilityName:String = null with get,set
member val LevelName:String = null with get,set
member val DueUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val DueText:String = null with get,set
member val Units:Int32 = new Int32() with get,set
member val UnitsFound:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Area:String = null with get,set
member val Minutes:Nullable<Int32> = new Nullable<Int32>() with get,set
member val Address:String = null with get,set
member val Unit:String = null with get,set
member val City:String = null with get,set
member val Lat:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Lng:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val CustomerName:String = null with get,set
member val CustomerPhone:String = null with get,set
member val Handoff:String = null with get,set
member val GateCode:String = null with get,set
member val Instructions:String = null with get,set
member val DropoffAddress:String = null with get,set
member val DropoffContactName:String = null with get,set
member val DropLat:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val DropLng:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val ArrivedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val Tags:ResizeArray<CourierItemView> = new ResizeArray<CourierItemView>() with get,set
member val Proof:Dictionary<String, String> = new Dictionary<String, String>() with get,set
member val Photos:Dictionary<String, Int32> = new Dictionary<String, Int32>() with get,set
member val Needs:ResizeArray<String> = new ResizeArray<String>() with get,set
member val MissedWaitMin:Int32 = new Int32() with get,set
member val MissedRequireContact:Boolean = new Boolean() with get,set
member val MissedRequirePhoto:Boolean = new Boolean() with get,set
member val MissedFee:Decimal = new Decimal() with get,set
[<AllowNullLiteral>]
type CourierStopView() =
member val Sequence:Int32 = new Int32() with get,set
member val Status:String = null with get,set
member val DispatchOdRequestID:Int32 = new Int32() with get,set
member val Code:String = null with get,set
member val CourierStep:String = null with get,set
member val Address:String = null with get,set
member val Unit:String = null with get,set
member val City:String = null with get,set
member val Zip:String = null with get,set
member val Lat:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Lng:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val CustomerName:String = null with get,set
member val CustomerPhone:String = null with get,set
member val Handoff:String = null with get,set
member val GateCode:String = null with get,set
member val Instructions:String = null with get,set
member val Units:Int32 = new Int32() with get,set
member val DueText:String = null with get,set
member val Note:String = null with get,set
member val Needs:ResizeArray<String> = new ResizeArray<String>() with get,set
member val Items:ResizeArray<CourierItemView> = new ResizeArray<CourierItemView>() with get,set
[<AllowNullLiteral>]
type CourierRunView() =
member val CourierRunID:Int32 = new Int32() with get,set
member val Code:String = null with get,set
member val Status:String = null with get,set
member val CourierProfileId:Int32 = new Int32() with get,set
member val ProfileName:String = null with get,set
member val CourierFacilityId:Int32 = new Int32() with get,set
member val FacilityName:String = null with get,set
member val FacilityAddress:String = null with get,set
member val DriverContactId:Nullable<Int32> = new Nullable<Int32>() with get,set
member val DriverName:String = null with get,set
member val EquipmentID:Nullable<Int32> = new Nullable<Int32>() with get,set
member val VehicleUnit:String = null with get,set
member val UnitOne:String = null with get,set
member val UnitMany:String = null with get,set
member val Units:Int32 = new Int32() with get,set
member val StopCount:Int32 = new Int32() with get,set
member val StopsDone:Int32 = new Int32() with get,set
member val Pay:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val BuiltUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val StartedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val CompletedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
member val ToLoad:Int32 = new Int32() with get,set
member val ToReturn:Int32 = new Int32() with get,set
member val Stops:ResizeArray<CourierStopView> = new ResizeArray<CourierStopView>() with get,set
[<AllowNullLiteral>]
type CourierDriverView() =
member val DriverCode:String = null with get,set
member val Name:String = null with get,set
member val Online:Boolean = new Boolean() with get,set
member val OnRoster:Boolean = new Boolean() with get,set
member val Van:CourierVanView = null with get,set
member val Current:CourierDriverOrder = null with get,set
member val Queue:ResizeArray<CourierDriverOrder> = new ResizeArray<CourierDriverOrder>() with get,set
member val Aboard:ResizeArray<CourierDriverOrder> = new ResizeArray<CourierDriverOrder>() with get,set
member val Runs:ResizeArray<CourierRunView> = new ResizeArray<CourierRunView>() with get,set
member val UpNext:CourierDriverOrder = null with get,set
[<AllowNullLiteral>]
type CourierDriverResponse() =
member val Courier:CourierDriverView = null with get,set
member val Result:String = null with get,set
member val Detail:String = null with get,set
member val Message:String = null with get,set
member val ResponseStatus:ResponseStatus = null with get,set
[<AllowNullLiteral>]
type CourierDirectScanRequest() =
member val Code:String = null with get,set
member val TagCode:String = null with get,set
member val Lat:Nullable<Decimal> = new Nullable<Decimal>() with get,set
member val Lng:Nullable<Decimal> = new Nullable<Decimal>() with get,set
F# CourierDirectScanRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/worker/dispatch/od/{Code}/scan HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: application/xml
Content-Type: application/xml
Content-Length: length
<CourierDirectScanRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Code>String</Code>
<Lat>0</Lat>
<Lng>0</Lng>
<TagCode>String</TagCode>
</CourierDirectScanRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CourierDriverResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Courier>
<Aboard>
<CourierDriverOrder>
<Address>String</Address>
<Area>String</Area>
<ArrivedUtc>0001-01-01T00:00:00</ArrivedUtc>
<City>String</City>
<Code>String</Code>
<CourierStep>String</CourierStep>
<CustomerName>String</CustomerName>
<CustomerPhone>String</CustomerPhone>
<DropLat>0</DropLat>
<DropLng>0</DropLng>
<DropoffAddress>String</DropoffAddress>
<DropoffContactName>String</DropoffContactName>
<DueText>String</DueText>
<DueUtc>0001-01-01T00:00:00</DueUtc>
<FacilityName>String</FacilityName>
<FacilityNoun>String</FacilityNoun>
<GateCode>String</GateCode>
<Handoff>String</Handoff>
<Instructions>String</Instructions>
<Lat>0</Lat>
<LevelName>String</LevelName>
<Lng>0</Lng>
<Minutes>0</Minutes>
<MissedFee>0</MissedFee>
<MissedRequireContact>false</MissedRequireContact>
<MissedRequirePhoto>false</MissedRequirePhoto>
<MissedWaitMin>0</MissedWaitMin>
<Needs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</Needs>
<Photos xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringint>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>0</d5p1:Value>
</d5p1:KeyValueOfstringint>
</Photos>
<ProfileName>String</ProfileName>
<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>
<RouteShape>String</RouteShape>
<Tags>
<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>
</Tags>
<Unit>String</Unit>
<UnitMany>String</UnitMany>
<UnitOne>String</UnitOne>
<Units>0</Units>
<UnitsFound>0</UnitsFound>
</CourierDriverOrder>
</Aboard>
<Current>
<Address>String</Address>
<Area>String</Area>
<ArrivedUtc>0001-01-01T00:00:00</ArrivedUtc>
<City>String</City>
<Code>String</Code>
<CourierStep>String</CourierStep>
<CustomerName>String</CustomerName>
<CustomerPhone>String</CustomerPhone>
<DropLat>0</DropLat>
<DropLng>0</DropLng>
<DropoffAddress>String</DropoffAddress>
<DropoffContactName>String</DropoffContactName>
<DueText>String</DueText>
<DueUtc>0001-01-01T00:00:00</DueUtc>
<FacilityName>String</FacilityName>
<FacilityNoun>String</FacilityNoun>
<GateCode>String</GateCode>
<Handoff>String</Handoff>
<Instructions>String</Instructions>
<Lat>0</Lat>
<LevelName>String</LevelName>
<Lng>0</Lng>
<Minutes>0</Minutes>
<MissedFee>0</MissedFee>
<MissedRequireContact>false</MissedRequireContact>
<MissedRequirePhoto>false</MissedRequirePhoto>
<MissedWaitMin>0</MissedWaitMin>
<Needs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Needs>
<Photos xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringint>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>0</d4p1:Value>
</d4p1:KeyValueOfstringint>
</Photos>
<ProfileName>String</ProfileName>
<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>
<RouteShape>String</RouteShape>
<Tags>
<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>
</Tags>
<Unit>String</Unit>
<UnitMany>String</UnitMany>
<UnitOne>String</UnitOne>
<Units>0</Units>
<UnitsFound>0</UnitsFound>
</Current>
<DriverCode>String</DriverCode>
<Name>String</Name>
<OnRoster>false</OnRoster>
<Online>false</Online>
<Queue>
<CourierDriverOrder>
<Address>String</Address>
<Area>String</Area>
<ArrivedUtc>0001-01-01T00:00:00</ArrivedUtc>
<City>String</City>
<Code>String</Code>
<CourierStep>String</CourierStep>
<CustomerName>String</CustomerName>
<CustomerPhone>String</CustomerPhone>
<DropLat>0</DropLat>
<DropLng>0</DropLng>
<DropoffAddress>String</DropoffAddress>
<DropoffContactName>String</DropoffContactName>
<DueText>String</DueText>
<DueUtc>0001-01-01T00:00:00</DueUtc>
<FacilityName>String</FacilityName>
<FacilityNoun>String</FacilityNoun>
<GateCode>String</GateCode>
<Handoff>String</Handoff>
<Instructions>String</Instructions>
<Lat>0</Lat>
<LevelName>String</LevelName>
<Lng>0</Lng>
<Minutes>0</Minutes>
<MissedFee>0</MissedFee>
<MissedRequireContact>false</MissedRequireContact>
<MissedRequirePhoto>false</MissedRequirePhoto>
<MissedWaitMin>0</MissedWaitMin>
<Needs xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:string>String</d5p1:string>
</Needs>
<Photos xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringint>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>0</d5p1:Value>
</d5p1:KeyValueOfstringint>
</Photos>
<ProfileName>String</ProfileName>
<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>
<RouteShape>String</RouteShape>
<Tags>
<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>
</Tags>
<Unit>String</Unit>
<UnitMany>String</UnitMany>
<UnitOne>String</UnitOne>
<Units>0</Units>
<UnitsFound>0</UnitsFound>
</CourierDriverOrder>
</Queue>
<Runs>
<CourierRunView>
<BuiltUtc>0001-01-01T00:00:00</BuiltUtc>
<Code>String</Code>
<CompletedUtc>0001-01-01T00:00:00</CompletedUtc>
<CourierFacilityId>0</CourierFacilityId>
<CourierProfileId>0</CourierProfileId>
<CourierRunID>0</CourierRunID>
<DriverContactId>0</DriverContactId>
<DriverName>String</DriverName>
<EquipmentID>0</EquipmentID>
<FacilityAddress>String</FacilityAddress>
<FacilityName>String</FacilityName>
<Pay>0</Pay>
<ProfileName>String</ProfileName>
<StartedUtc>0001-01-01T00:00:00</StartedUtc>
<Status>String</Status>
<StopCount>0</StopCount>
<Stops>
<CourierStopView>
<Address>String</Address>
<City>String</City>
<Code>String</Code>
<CourierStep>String</CourierStep>
<CustomerName>String</CustomerName>
<CustomerPhone>String</CustomerPhone>
<DispatchOdRequestID>0</DispatchOdRequestID>
<DueText>String</DueText>
<GateCode>String</GateCode>
<Handoff>String</Handoff>
<Instructions>String</Instructions>
<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>
<Lat>0</Lat>
<Lng>0</Lng>
<Needs xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d7p1:string>String</d7p1:string>
</Needs>
<Note>String</Note>
<Sequence>0</Sequence>
<Status>String</Status>
<Unit>String</Unit>
<Units>0</Units>
<Zip>String</Zip>
</CourierStopView>
</Stops>
<StopsDone>0</StopsDone>
<ToLoad>0</ToLoad>
<ToReturn>0</ToReturn>
<UnitMany>String</UnitMany>
<UnitOne>String</UnitOne>
<Units>0</Units>
<VehicleUnit>String</VehicleUnit>
</CourierRunView>
</Runs>
<UpNext>
<Address>String</Address>
<Area>String</Area>
<ArrivedUtc>0001-01-01T00:00:00</ArrivedUtc>
<City>String</City>
<Code>String</Code>
<CourierStep>String</CourierStep>
<CustomerName>String</CustomerName>
<CustomerPhone>String</CustomerPhone>
<DropLat>0</DropLat>
<DropLng>0</DropLng>
<DropoffAddress>String</DropoffAddress>
<DropoffContactName>String</DropoffContactName>
<DueText>String</DueText>
<DueUtc>0001-01-01T00:00:00</DueUtc>
<FacilityName>String</FacilityName>
<FacilityNoun>String</FacilityNoun>
<GateCode>String</GateCode>
<Handoff>String</Handoff>
<Instructions>String</Instructions>
<Lat>0</Lat>
<LevelName>String</LevelName>
<Lng>0</Lng>
<Minutes>0</Minutes>
<MissedFee>0</MissedFee>
<MissedRequireContact>false</MissedRequireContact>
<MissedRequirePhoto>false</MissedRequirePhoto>
<MissedWaitMin>0</MissedWaitMin>
<Needs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:string>String</d4p1:string>
</Needs>
<Photos xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d4p1:KeyValueOfstringint>
<d4p1:Key>String</d4p1:Key>
<d4p1:Value>0</d4p1:Value>
</d4p1:KeyValueOfstringint>
</Photos>
<ProfileName>String</ProfileName>
<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>
<RouteShape>String</RouteShape>
<Tags>
<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>
</Tags>
<Unit>String</Unit>
<UnitMany>String</UnitMany>
<UnitOne>String</UnitOne>
<Units>0</Units>
<UnitsFound>0</UnitsFound>
</UpNext>
<Van>
<Cap>0</Cap>
<CapUnit>String</CapUnit>
<Committed>0</Committed>
<CriticalCode>String</CriticalCode>
<DriveMin>0</DriveMin>
<FacilityName>String</FacilityName>
<InVan>0</InVan>
<LeaveByText>String</LeaveByText>
<LeaveByUtc>0001-01-01T00:00:00</LeaveByUtc>
<SendNote>String</SendNote>
<SlackMin>0</SlackMin>
<State>String</State>
<VehicleUnit>String</VehicleUnit>
</Van>
</Courier>
<Detail>String</Detail>
<Message>String</Message>
<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>
<Result>String</Result>
</CourierDriverResponse>