Trendsic Platform Service

<back to all web services

RoutePlanWeekRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/routeplan/week
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class RoutePlanCrew
            Public Overridable Property CrewID As Integer
            Public Overridable Property CrewName As String
            Public Overridable Property CrewColor As String
            Public Overridable Property HomeZip As String
            Public Overridable Property YardLat As Double?
            Public Overridable Property YardLng As Double?
            Public Overridable Property DailyCapacityMin As Integer
            Public Overridable Property WeeklyCapacityMin As Integer
            Public Overridable Property Specialist As Boolean
        End Class

        Public Partial Class RoutePlanSkippedVisit
            Public Overridable Property AgreementJobID As Integer
            Public Overridable Property AgreementID As Integer
            Public Overridable Property Name As String
            Public Overridable Property DateIso As String
            Public Overridable Property Reason As String
            Public Overridable Property CreditAmount As Decimal
        End Class

        Public Partial Class RoutePlanVisit
            Public Overridable Property AgreementID As Integer
            Public Overridable Property AgreementJobID As Integer?
            Public Overridable Property Name As String
            Public Overridable Property [Sub] As String
            Public Overridable Property ServiceType As String
            Public Overridable Property Zip As String
            Public Overridable Property Area As String
            Public Overridable Property Lat As Double?
            Public Overridable Property Lng As Double?
            Public Overridable Property DurationMin As Integer
            Public Overridable Property DueIso As String
            Public Overridable Property DueLabel As String
            Public Overridable Property Overdue As Boolean
            Public Overridable Property DefaultCrewID As Integer?
            Public Overridable Property RouteCrewID As Integer?
            Public Overridable Property RouteSeq As Integer?
            Public Overridable Property RouteDateIso As String
            Public Overridable Property LateDays As Integer
            Public Overridable Property AutoPay As Boolean
            Public Overridable Property SkipPolicy As String
            Public Overridable Property SkipCreditAmount As Decimal
        End Class

        Public Partial Class RoutePlanWeekRequest
            Public Overridable Property From As String
        End Class

        Public Partial Class RoutePlanWeekResponse
            Public Overridable Property FromIso As String
            Public Overridable Property ToIso As String
            Public Overridable Property Crews As List(Of RoutePlanCrew) = New List(Of RoutePlanCrew)
            Public Overridable Property Visits As List(Of RoutePlanVisit) = New List(Of RoutePlanVisit)
            Public Overridable Property Skipped As List(Of RoutePlanSkippedVisit) = New List(Of RoutePlanSkippedVisit)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET RoutePlanWeekRequest 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/routeplan/week HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}