Trendsic Platform Service

<back to all web services

RoutePlanWeekRequest

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

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class RoutePlanCrew
    {
        public virtual int CrewID { get; set; }
        public virtual string CrewName { get; set; }
        public virtual string CrewColor { get; set; }
        public virtual string HomeZip { get; set; }
        public virtual double? YardLat { get; set; }
        public virtual double? YardLng { get; set; }
        public virtual int DailyCapacityMin { get; set; }
        public virtual int WeeklyCapacityMin { get; set; }
        public virtual bool Specialist { get; set; }
    }

    public partial class RoutePlanSkippedVisit
    {
        public virtual int AgreementJobID { get; set; }
        public virtual int AgreementID { get; set; }
        public virtual string Name { get; set; }
        public virtual string DateIso { get; set; }
        public virtual string Reason { get; set; }
        public virtual decimal CreditAmount { get; set; }
    }

    public partial class RoutePlanVisit
    {
        public virtual int AgreementID { get; set; }
        public virtual int? AgreementJobID { get; set; }
        public virtual string Name { get; set; }
        public virtual string Sub { get; set; }
        public virtual string ServiceType { get; set; }
        public virtual string Zip { get; set; }
        public virtual string Area { get; set; }
        public virtual double? Lat { get; set; }
        public virtual double? Lng { get; set; }
        public virtual int DurationMin { get; set; }
        public virtual string DueIso { get; set; }
        public virtual string DueLabel { get; set; }
        public virtual bool Overdue { get; set; }
        public virtual int? DefaultCrewID { get; set; }
        public virtual int? RouteCrewID { get; set; }
        public virtual int? RouteSeq { get; set; }
        public virtual string RouteDateIso { get; set; }
        public virtual int LateDays { get; set; }
        public virtual bool AutoPay { get; set; }
        public virtual string SkipPolicy { get; set; }
        public virtual decimal SkipCreditAmount { get; set; }
    }

    public partial class RoutePlanWeekRequest
    {
        public virtual string From { get; set; }
    }

    public partial class RoutePlanWeekResponse
    {
        public virtual string FromIso { get; set; }
        public virtual string ToIso { get; set; }
        public virtual List<RoutePlanCrew> Crews { get; set; } = [];
        public virtual List<RoutePlanVisit> Visits { get; set; } = [];
        public virtual List<RoutePlanSkippedVisit> Skipped { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

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