Trendsic Platform Service

<back to all web services

CourierVansRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/courier/vans
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CourierVansRequest
{
}

open class CourierOfficeResponse
{
    open var Office:CourierOfficeView? = null
    open var Available:Boolean? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CourierOfficeView
{
    open var ServerUtc:Date? = null
    open var Vans:ArrayList<CourierOfficeVan> = ArrayList<CourierOfficeVan>()
    open var Held:ArrayList<CourierHeldView> = ArrayList<CourierHeldView>()
    open var Vehicles:ArrayList<CourierVehicleOption> = ArrayList<CourierVehicleOption>()
    open var Profiles:ArrayList<CourierProfileOption> = ArrayList<CourierProfileOption>()
    open var Drivers:ArrayList<CourierDriverOption> = ArrayList<CourierDriverOption>()
    open var Desk:ArrayList<CourierDeskRow> = ArrayList<CourierDeskRow>()
    open var GoCount:Int? = null
    open var HeldCount:Int? = null
    open var ReadyToOffer:Int? = null
    open var IntakeMin:Int? = null
    open var FacilityNoun:String? = null
}

open class CourierOfficeVan
{
    open var DriverContactId:Int? = null
    open var DriverCode:String? = null
    open var Name:String? = null
    open var Online:Boolean? = null
    open var Zone:String? = null
    open var VehicleUnit:String? = null
    open var FacilityName:String? = null
    open var State:String? = null
    open var LeaveByUtc:Date? = null
    open var LeaveByText:String? = null
    open var SlackMin:Int? = null
    open var InVan:Int? = null
    open var Committed:Int? = null
    open var Cap:BigDecimal? = null
    open var CapUnit:String? = null
    open var UnitMany:String? = null
    open var CriticalCode:String? = null
    open var DriveMin:Int? = null
    open var SendNote:String? = null
    open var Aboard:ArrayList<CourierVanChip> = ArrayList<CourierVanChip>()
    open var Queued:ArrayList<CourierVanChip> = ArrayList<CourierVanChip>()
}

open class CourierVanChip
{
    open var Code:String? = null
    open var CourierStep:String? = null
    open var LevelCode:String? = null
    open var LevelName:String? = null
    open var Units:Int? = null
    open var Area:String? = null
    open var DueUtc:Date? = null
    open var DueText:String? = null
    open var Movable:Boolean? = null
    open var NoMoveWhy:String? = null
    open var Targets:ArrayList<CourierMoveTarget> = ArrayList<CourierMoveTarget>()
}

open class CourierMoveTarget
{
    open var DriverContactId:Int? = null
    open var Name:String? = null
    open var Ok:Boolean? = null
    open var Why:String? = null
    open var LeaveByText:String? = null
}

open class CourierHeldView
{
    open var Code:String? = null
    open var Area:String? = null
    open var Units:Int? = null
    open var UnitMany:String? = null
    open var Miles:BigDecimal? = null
    open var LevelCode:String? = null
    open var LevelName:String? = null
    open var DueText:String? = null
    open var HeldReason:String? = null
    open var HeldMin:Int? = null
    open var Why:ArrayList<String> = ArrayList<String>()
    open var BestDriverContactId:Int? = null
    open var BestName:String? = null
    open var BestLeaveByText:String? = null
}

open class CourierVehicleOption
{
    open var CourierProfileId:Int? = null
    open var EquipmentID:Int? = null
    open var UnitNumber:String? = null
    open var VehicleType:String? = null
    open var CapacityUnit:String? = null
    open var CapacityLimit:BigDecimal? = null
    open var IsRefrigerated:Boolean? = null
    open var Status:String? = null
}

open class CourierProfileOption
{
    open var CourierProfileID:Int? = null
    open var Name:String? = null
    open var RouteShape:String? = null
    open var Enabled:Boolean? = null
    open var UnitOne:String? = null
    open var UnitMany:String? = null
    open var FacilityNoun:String? = null
    open var Facilities:ArrayList<CourierFacilityOption> = ArrayList<CourierFacilityOption>()
}

open class CourierFacilityOption
{
    open var CourierFacilityID:Int? = null
    open var Code:String? = null
    open var Name:String? = null
    open var Address:String? = null
    open var IntakeMin:Int? = null
}

open class CourierDriverOption
{
    open var ContactId:Int? = null
    open var Code:String? = null
    open var Name:String? = null
    open var Online:Boolean? = null
    open var Zone:String? = null
    open var VehicleUnit:String? = null
    open var EquipmentID:Int? = null
    open var SentToFacility:Boolean? = null
}

open class CourierDeskRow
{
    open var Code:String? = null
    open var CourierProfileId:Int? = null
    open var FacilityName:String? = null
    open var LevelCode:String? = null
    open var LevelName:String? = null
    open var DueUtc:Date? = null
    open var DueText:String? = null
    open var Units:Int? = null
    open var UnitsFound:Int? = null
    open var UnitMany:String? = null
    open var Fare:BigDecimal? = null
    open var FinalPrice:BigDecimal? = null
    open var TipAmount:BigDecimal? = null
    open var PayMode:String? = null
    open var CaptureMode:String? = null
    open var CustomerName:String? = null
    open var Area:String? = null
    open var IntakeUtc:Date? = null
    open var IntakeMinAgo:Int? = null
    open var DamageNote:String? = null
    open var FinalPriceAfterCount:Boolean? = null
    open var NeedsPrice:Boolean? = null
    open var ItemCount:Int? = null
    open var MissingCount:Int? = null
    open var PhotoCount:Int? = null
}

Kotlin CourierVansRequest DTOs

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

HTTP + OTHER

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

GET /v1/dispatch/courier/vans HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl

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

{"Office":{"ServerUtc":"0001-01-01T00:00:00.0000000","Vans":[{"DriverContactId":0,"DriverCode":"String","Name":"String","Online":false,"Zone":"String","VehicleUnit":"String","FacilityName":"String","State":"String","LeaveByUtc":"0001-01-01T00:00:00.0000000","LeaveByText":"String","SlackMin":0,"InVan":0,"Committed":0,"Cap":0,"CapUnit":"String","UnitMany":"String","CriticalCode":"String","DriveMin":0,"SendNote":"String","Aboard":[{"Code":"String","CourierStep":"String","LevelCode":"String","LevelName":"String","Units":0,"Area":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Movable":false,"NoMoveWhy":"String","Targets":[{"DriverContactId":0,"Name":"String","Ok":false,"Why":"String","LeaveByText":"String"}]}],"Queued":[{"Code":"String","CourierStep":"String","LevelCode":"String","LevelName":"String","Units":0,"Area":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Movable":false,"NoMoveWhy":"String","Targets":[{"DriverContactId":0,"Name":"String","Ok":false,"Why":"String","LeaveByText":"String"}]}]}],"Held":[{"Code":"String","Area":"String","Units":0,"UnitMany":"String","Miles":0,"LevelCode":"String","LevelName":"String","DueText":"String","HeldReason":"String","HeldMin":0,"Why":["String"],"BestDriverContactId":0,"BestName":"String","BestLeaveByText":"String"}],"Vehicles":[{"CourierProfileId":0,"EquipmentID":0,"UnitNumber":"String","VehicleType":"String","CapacityUnit":"String","CapacityLimit":0,"IsRefrigerated":false,"Status":"String"}],"Profiles":[{"CourierProfileID":0,"Name":"String","RouteShape":"String","Enabled":false,"UnitOne":"String","UnitMany":"String","FacilityNoun":"String","Facilities":[{"CourierFacilityID":0,"Code":"String","Name":"String","Address":"String","IntakeMin":0}]}],"Drivers":[{"ContactId":0,"Code":"String","Name":"String","Online":false,"Zone":"String","VehicleUnit":"String","EquipmentID":0,"SentToFacility":false}],"Desk":[{"Code":"String","CourierProfileId":0,"FacilityName":"String","LevelCode":"String","LevelName":"String","DueUtc":"0001-01-01T00:00:00.0000000","DueText":"String","Units":0,"UnitsFound":0,"UnitMany":"String","Fare":0,"FinalPrice":0,"TipAmount":0,"PayMode":"String","CaptureMode":"String","CustomerName":"String","Area":"String","IntakeUtc":"0001-01-01T00:00:00.0000000","IntakeMinAgo":0,"DamageNote":"String","FinalPriceAfterCount":false,"NeedsPrice":false,"ItemCount":0,"MissingCount":0,"PhotoCount":0}],"GoCount":0,"HeldCount":0,"ReadyToOffer":0,"IntakeMin":0,"FacilityNoun":"String"},"Available":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}