Trendsic Platform Service

<back to all web services

DriverPingAnswerRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/worker/dispatch/ping/{Code}/answer
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class DriverPingAnswerRequest
{
    open var Code:String? = null
    open var Accept:Boolean? = null
}

open class DriverMeResponse
{
    open var ContactId:Int? = null
    open var Name:String? = null
    open var Phone:String? = null
    open var PayPlanName:String? = null
    open var PayPlanBasis:String? = null
    open var PayPlanRate:BigDecimal? = null
    open var Truck:DriverTruckView? = null
    open var Rig:DriverRigView? = null
    open var Jobs:ArrayList<DriverJobView> = ArrayList<DriverJobView>()
    open var Od:DriverOdView? = null
    open var Incidents:ArrayList<DriverIncidentView> = ArrayList<DriverIncidentView>()
    open var Pay:ArrayList<DriverPayLineView> = ArrayList<DriverPayLineView>()
    open var ServerUtc:Date? = null
    open var Message:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class DriverTruckView
{
    open var Code:String? = null
    open var Stage:String? = null
    open var StageSinceUtc:Date? = null
    open var LoadsToday:Int? = null
    open var NetToday:BigDecimal? = null
    open var EstLoad:BigDecimal? = null
    open var Slot:String? = null
    open var SiteName:String? = null
    open var SupplierName:String? = null
    open var NextSiteName:String? = null
    open var Facility:String? = null
    open var FacilityShort:String? = null
    open var Unit:String? = null
    open var QueuePosition:Int? = null
    open var HoldCode:String? = null
    open var HoldReason:String? = null
    open var HoldEndUtc:Date? = null
    open var OpenLoadId:Int? = null
    open var OpenLoadCode:String? = null
    open var OpenLoadPhotos:Int? = null
    open var Stamps:ArrayList<DriverStampView> = ArrayList<DriverStampView>()
}

open class DriverStampView
{
    open var Stage:String? = null
    open var AtUtc:Date? = null
    open var Note:String? = null
}

open class DriverRigView
{
    open var Code:String? = null
    open var Name:String? = null
    open var RigType:String? = null
    open var IsFree:Boolean? = null
    open var HoldCode:String? = null
    open var HoldReason:String? = null
    open var HoldEndUtc:Date? = null
}

open class DriverJobView
{
    open var Kind:String? = null
    open var Code:String? = null
    open var Cargo:String? = null
    open var Customer:String? = null
    open var CustomerPhone:String? = null
    open var HoldContact:String? = null
    open var HoldPhone:String? = null
    open var FromLoc:String? = null
    open var ToLoc:String? = null
    open var Miles:Int? = null
    open var WindowText:String? = null
    open var Stage:String? = null
    open var Rate:BigDecimal? = null
    open var RequiredRig:String? = null
    open var EtaText:String? = null
    open var OfferExpiresUtc:Date? = null
    open var RequestId:Int? = null
    open var LoadId:Int? = null
    open var LoadCode:String? = null
    open var LoadPay:BigDecimal? = null
    open var Photos:Int? = null
    open var Stamps:ArrayList<DriverStampView> = ArrayList<DriverStampView>()
}

open class DriverOdView
{
    open var Code:String? = null
    open var Name:String? = null
    open var Zone:String? = null
    open var Status:String? = null
    open var Tier:String? = null
    open var Capabilities:String? = null
    open var PingCode:String? = null
    open var PingAddress:String? = null
    open var PingZone:String? = null
    open var PingBags:Int? = null
    open var PingNeeds:String? = null
    open var PingNote:String? = null
    open var PingExpiresUtc:Date? = null
    open var RunCode:String? = null
    open var RunAddress:String? = null
    open var RunZone:String? = null
    open var RunBags:Int? = null
    open var RunStage:String? = null
    open var RunNeeds:String? = null
    open var RunNote:String? = null
    open var RunEta:String? = null
    open var OdBase:BigDecimal? = null
    open var OdPerBag:BigDecimal? = null
    open var HoldCode:String? = null
    open var HoldReason:String? = null
    open var HoldEndUtc:Date? = null
}

open class DriverIncidentView
{
    open var IncidentId:Int? = null
    open var Code:String? = null
    open var Kind:String? = null
    open var KindDetail:String? = null
    open var Status:String? = null
    open var LoadCode:String? = null
    open var TruckCode:String? = null
    open var LocationText:String? = null
    open var DriverPref:String? = null
    open var TruckRecovery:String? = null
    open var LoadRecovery:String? = null
    open var TransloadTruckCode:String? = null
    open var HoldCode:String? = null
    open var OpenedUtc:Date? = null
    open var ResolvedUtc:Date? = null
    open var Messages:ArrayList<DispatchIncidentMessageView> = ArrayList<DispatchIncidentMessageView>()
}

open class DispatchIncidentMessageView
{
    open var MessageId:Int? = null
    open var Who:String? = null
    open var Role:String? = null
    open var Msg:String? = null
    open var AtUtc:Date? = null
}

open class DriverPayLineView
{
    open var Code:String? = null
    open var Module:String? = null
    open var SourceLabel:String? = null
    open var DestinationLabel:String? = null
    open var QtyText:String? = null
    open var Pay:BigDecimal? = null
    open var PayPlanLabel:String? = null
    open var Status:String? = null
    open var ClosedUtc:Date? = null
    open var OpenedUtc:Date? = null
    open var TicketCode:String? = null
}

Kotlin DriverPingAnswerRequest 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/ping/{Code}/answer HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Code":"String","Accept":false}

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"}}}