Trendsic Platform Service

<back to all web services

DriverPhotoRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/worker/dispatch/photo
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 DriverStampView() = 
        member val Stage:String = null with get,set
        member val AtUtc:DateTime = new DateTime() with get,set
        member val Note:String = null with get,set

    [<AllowNullLiteral>]
    type DriverTruckView() = 
        member val Code:String = null with get,set
        member val Stage:String = null with get,set
        member val StageSinceUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val LoadsToday:Int32 = new Int32() with get,set
        member val NetToday:Decimal = new Decimal() with get,set
        member val EstLoad:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Slot:String = null with get,set
        member val SiteName:String = null with get,set
        member val SupplierName:String = null with get,set
        member val NextSiteName:String = null with get,set
        member val Facility:String = null with get,set
        member val FacilityShort:String = null with get,set
        member val Unit:String = null with get,set
        member val QueuePosition:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val HoldCode:String = null with get,set
        member val HoldReason:String = null with get,set
        member val HoldEndUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val OpenLoadId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val OpenLoadCode:String = null with get,set
        member val OpenLoadPhotos:Int32 = new Int32() with get,set
        member val Stamps:ResizeArray<DriverStampView> = new ResizeArray<DriverStampView>() with get,set

    [<AllowNullLiteral>]
    type DriverRigView() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val RigType:String = null with get,set
        member val IsFree:Boolean = new Boolean() with get,set
        member val HoldCode:String = null with get,set
        member val HoldReason:String = null with get,set
        member val HoldEndUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type DriverJobView() = 
        member val Kind:String = null with get,set
        member val Code:String = null with get,set
        member val Cargo:String = null with get,set
        member val Customer:String = null with get,set
        member val CustomerPhone:String = null with get,set
        member val HoldContact:String = null with get,set
        member val HoldPhone:String = null with get,set
        member val FromLoc:String = null with get,set
        member val ToLoc:String = null with get,set
        member val Miles:Int32 = new Int32() with get,set
        member val WindowText:String = null with get,set
        member val Stage:String = null with get,set
        member val Rate:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val RequiredRig:String = null with get,set
        member val EtaText:String = null with get,set
        member val OfferExpiresUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val RequestId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LoadId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val LoadCode:String = null with get,set
        member val LoadPay:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Photos:Int32 = new Int32() with get,set
        member val Stamps:ResizeArray<DriverStampView> = new ResizeArray<DriverStampView>() with get,set

    [<AllowNullLiteral>]
    type DriverOdView() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Zone:String = null with get,set
        member val Status:String = null with get,set
        member val Tier:String = null with get,set
        member val Capabilities:String = null with get,set
        member val PingCode:String = null with get,set
        member val PingAddress:String = null with get,set
        member val PingZone:String = null with get,set
        member val PingBags:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val PingNeeds:String = null with get,set
        member val PingNote:String = null with get,set
        member val PingExpiresUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val RunCode:String = null with get,set
        member val RunAddress:String = null with get,set
        member val RunZone:String = null with get,set
        member val RunBags:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RunStage:String = null with get,set
        member val RunNeeds:String = null with get,set
        member val RunNote:String = null with get,set
        member val RunEta:String = null with get,set
        member val OdBase:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OdPerBag:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val HoldCode:String = null with get,set
        member val HoldReason:String = null with get,set
        member val HoldEndUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type DispatchIncidentMessageView() = 
        member val MessageId:Int32 = new Int32() with get,set
        member val Who:String = null with get,set
        member val Role:String = null with get,set
        member val Msg:String = null with get,set
        member val AtUtc:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type DriverIncidentView() = 
        member val IncidentId:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val Kind:String = null with get,set
        member val KindDetail:String = null with get,set
        member val Status:String = null with get,set
        member val LoadCode:String = null with get,set
        member val TruckCode:String = null with get,set
        member val LocationText:String = null with get,set
        member val DriverPref:String = null with get,set
        member val TruckRecovery:String = null with get,set
        member val LoadRecovery:String = null with get,set
        member val TransloadTruckCode:String = null with get,set
        member val HoldCode:String = null with get,set
        member val OpenedUtc:DateTime = new DateTime() with get,set
        member val ResolvedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Messages:ResizeArray<DispatchIncidentMessageView> = new ResizeArray<DispatchIncidentMessageView>() with get,set

    [<AllowNullLiteral>]
    type DriverPayLineView() = 
        member val Code:String = null with get,set
        member val Module:String = null with get,set
        member val SourceLabel:String = null with get,set
        member val DestinationLabel:String = null with get,set
        member val QtyText:String = null with get,set
        member val Pay:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val PayPlanLabel:String = null with get,set
        member val Status:String = null with get,set
        member val ClosedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val OpenedUtc:DateTime = new DateTime() with get,set
        member val TicketCode:String = null with get,set

    [<AllowNullLiteral>]
    type DriverMeResponse() = 
        member val ContactId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Phone:String = null with get,set
        member val PayPlanName:String = null with get,set
        member val PayPlanBasis:String = null with get,set
        member val PayPlanRate:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Truck:DriverTruckView = null with get,set
        member val Rig:DriverRigView = null with get,set
        member val Jobs:ResizeArray<DriverJobView> = new ResizeArray<DriverJobView>() with get,set
        member val Od:DriverOdView = null with get,set
        member val Incidents:ResizeArray<DriverIncidentView> = new ResizeArray<DriverIncidentView>() with get,set
        member val Pay:ResizeArray<DriverPayLineView> = new ResizeArray<DriverPayLineView>() with get,set
        member val ServerUtc:DateTime = new DateTime() with get,set
        member val Message:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type DriverPhotoRequest() = 
        member val LoadId:Int32 = new Int32() with get,set
        member val Kind:String = null with get,set

F# DriverPhotoRequest 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/worker/dispatch/photo HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"LoadId":0,"Kind":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"ContactId":0,"Name":"String","Phone":"String","PayPlanName":"String","PayPlanBasis":"String","PayPlanRate":0,"Truck":{"Code":"String","Stage":"String","StageSinceUtc":"0001-01-01T00:00:00.0000000","LoadsToday":0,"NetToday":0,"EstLoad":0,"Slot":"String","SiteName":"String","SupplierName":"String","NextSiteName":"String","Facility":"String","FacilityShort":"String","Unit":"String","QueuePosition":0,"HoldCode":"String","HoldReason":"String","HoldEndUtc":"0001-01-01T00:00:00.0000000","OpenLoadId":0,"OpenLoadCode":"String","OpenLoadPhotos":0,"Stamps":[{"Stage":"String","AtUtc":"0001-01-01T00:00:00.0000000","Note":"String"}]},"Rig":{"Code":"String","Name":"String","RigType":"String","IsFree":false,"HoldCode":"String","HoldReason":"String","HoldEndUtc":"0001-01-01T00:00:00.0000000"},"Jobs":[{"Kind":"String","Code":"String","Cargo":"String","Customer":"String","CustomerPhone":"String","HoldContact":"String","HoldPhone":"String","FromLoc":"String","ToLoc":"String","Miles":0,"WindowText":"String","Stage":"String","Rate":0,"RequiredRig":"String","EtaText":"String","OfferExpiresUtc":"0001-01-01T00:00:00.0000000","RequestId":0,"LoadId":0,"LoadCode":"String","LoadPay":0,"Photos":0,"Stamps":[{"Stage":"String","AtUtc":"0001-01-01T00:00:00.0000000","Note":"String"}]}],"Od":{"Code":"String","Name":"String","Zone":"String","Status":"String","Tier":"String","Capabilities":"String","PingCode":"String","PingAddress":"String","PingZone":"String","PingBags":0,"PingNeeds":"String","PingNote":"String","PingExpiresUtc":"0001-01-01T00:00:00.0000000","RunCode":"String","RunAddress":"String","RunZone":"String","RunBags":0,"RunStage":"String","RunNeeds":"String","RunNote":"String","RunEta":"String","OdBase":0,"OdPerBag":0,"HoldCode":"String","HoldReason":"String","HoldEndUtc":"0001-01-01T00:00:00.0000000"},"Incidents":[{"IncidentId":0,"Code":"String","Kind":"String","KindDetail":"String","Status":"String","LoadCode":"String","TruckCode":"String","LocationText":"String","DriverPref":"String","TruckRecovery":"String","LoadRecovery":"String","TransloadTruckCode":"String","HoldCode":"String","OpenedUtc":"0001-01-01T00:00:00.0000000","ResolvedUtc":"0001-01-01T00:00:00.0000000","Messages":[{"MessageId":0,"Who":"String","Role":"String","Msg":"String","AtUtc":"0001-01-01T00:00:00.0000000"}]}],"Pay":[{"Code":"String","Module":"String","SourceLabel":"String","DestinationLabel":"String","QtyText":"String","Pay":0,"PayPlanLabel":"String","Status":"String","ClosedUtc":"0001-01-01T00:00:00.0000000","OpenedUtc":"0001-01-01T00:00:00.0000000","TicketCode":"String"}],"ServerUtc":"0001-01-01T00:00:00.0000000","Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}