Trendsic Platform Service

<back to all web services

RoutePlanWeekRequest

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


open class RoutePlanWeekRequest
{
    open var From:String? = null
}

open class RoutePlanWeekResponse
{
    open var FromIso:String? = null
    open var ToIso:String? = null
    open var Crews:ArrayList<RoutePlanCrew> = ArrayList<RoutePlanCrew>()
    open var Visits:ArrayList<RoutePlanVisit> = ArrayList<RoutePlanVisit>()
    open var Skipped:ArrayList<RoutePlanSkippedVisit> = ArrayList<RoutePlanSkippedVisit>()
    open var ResponseStatus:ResponseStatus? = null
}

open class RoutePlanCrew
{
    open var CrewID:Int? = null
    open var CrewName:String? = null
    open var CrewColor:String? = null
    open var HomeZip:String? = null
    open var YardLat:Double? = null
    open var YardLng:Double? = null
    open var DailyCapacityMin:Int? = null
    open var WeeklyCapacityMin:Int? = null
    open var Specialist:Boolean? = null
}

open class RoutePlanVisit
{
    open var AgreementID:Int? = null
    open var AgreementJobID:Int? = null
    open var Name:String? = null
    open var Sub:String? = null
    open var ServiceType:String? = null
    open var Zip:String? = null
    open var Area:String? = null
    open var Lat:Double? = null
    open var Lng:Double? = null
    open var DurationMin:Int? = null
    open var DueIso:String? = null
    open var DueLabel:String? = null
    open var Overdue:Boolean? = null
    open var DefaultCrewID:Int? = null
    open var RouteCrewID:Int? = null
    open var RouteSeq:Int? = null
    open var RouteDateIso:String? = null
    open var LateDays:Int? = null
    open var AutoPay:Boolean? = null
    open var SkipPolicy:String? = null
    open var SkipCreditAmount:BigDecimal? = null
}

open class RoutePlanSkippedVisit
{
    open var AgreementJobID:Int? = null
    open var AgreementID:Int? = null
    open var Name:String? = null
    open var DateIso:String? = null
    open var Reason:String? = null
    open var CreditAmount:BigDecimal? = null
}

Kotlin RoutePlanWeekRequest 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.

GET /v1/routeplan/week HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"FromIso":"String","ToIso":"String","Crews":[{"CrewID":0,"CrewName":"String","CrewColor":"String","HomeZip":"String","YardLat":0,"YardLng":0,"DailyCapacityMin":0,"WeeklyCapacityMin":0,"Specialist":false}],"Visits":[{"AgreementID":0,"AgreementJobID":0,"Name":"String","Sub":"String","ServiceType":"String","Zip":"String","Area":"String","Lat":0,"Lng":0,"DurationMin":0,"DueIso":"String","DueLabel":"String","Overdue":false,"DefaultCrewID":0,"RouteCrewID":0,"RouteSeq":0,"RouteDateIso":"String","LateDays":0,"AutoPay":false,"SkipPolicy":"String","SkipCreditAmount":0}],"Skipped":[{"AgreementJobID":0,"AgreementID":0,"Name":"String","DateIso":"String","Reason":"String","CreditAmount":0}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}