Trendsic Platform Service

<back to all web services

RoutePlanWeekRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/routeplan/week
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 RoutePlanCrew() = 
        member val CrewID:Int32 = new Int32() with get,set
        member val CrewName:String = null with get,set
        member val CrewColor:String = null with get,set
        member val HomeZip:String = null with get,set
        member val YardLat:Nullable<Double> = new Nullable<Double>() with get,set
        member val YardLng:Nullable<Double> = new Nullable<Double>() with get,set
        member val DailyCapacityMin:Int32 = new Int32() with get,set
        member val WeeklyCapacityMin:Int32 = new Int32() with get,set
        member val Specialist:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type RoutePlanVisit() = 
        member val AgreementID:Int32 = new Int32() with get,set
        member val AgreementJobID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Name:String = null with get,set
        member val Sub:String = null with get,set
        member val ServiceType:String = null with get,set
        member val Zip:String = null with get,set
        member val Area:String = null with get,set
        member val Lat:Nullable<Double> = new Nullable<Double>() with get,set
        member val Lng:Nullable<Double> = new Nullable<Double>() with get,set
        member val DurationMin:Int32 = new Int32() with get,set
        member val DueIso:String = null with get,set
        member val DueLabel:String = null with get,set
        member val Overdue:Boolean = new Boolean() with get,set
        member val DefaultCrewID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RouteCrewID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RouteSeq:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RouteDateIso:String = null with get,set
        member val LateDays:Int32 = new Int32() with get,set
        member val AutoPay:Boolean = new Boolean() with get,set
        member val SkipPolicy:String = null with get,set
        member val SkipCreditAmount:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type RoutePlanSkippedVisit() = 
        member val AgreementJobID:Int32 = new Int32() with get,set
        member val AgreementID:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val DateIso:String = null with get,set
        member val Reason:String = null with get,set
        member val CreditAmount:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type RoutePlanWeekResponse() = 
        member val FromIso:String = null with get,set
        member val ToIso:String = null with get,set
        member val Crews:ResizeArray<RoutePlanCrew> = new ResizeArray<RoutePlanCrew>() with get,set
        member val Visits:ResizeArray<RoutePlanVisit> = new ResizeArray<RoutePlanVisit>() with get,set
        member val Skipped:ResizeArray<RoutePlanSkippedVisit> = new ResizeArray<RoutePlanSkippedVisit>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type RoutePlanWeekRequest() = 
        member val From:String = null with get,set

F# RoutePlanWeekRequest DTOs

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

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}