Trendsic Platform Service

<back to all web services

RoutePlanOptimizeRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/routeplan/optimize

export class RoutePlanOptimizeAssignment
{
    public AgreementID: number;
    public CrewID: number;
    public Seq: number;

    public constructor(init?: Partial<RoutePlanOptimizeAssignment>) { (Object as any).assign(this, init); }
}

export class RoutePlanOptimizeResponse
{
    public Assignments: RoutePlanOptimizeAssignment[] = [];
    public ByDefaultCrew: number;
    public ByTerritory: number;
    public SkippedHeld: number;
    public Engine: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<RoutePlanOptimizeResponse>) { (Object as any).assign(this, init); }
}

export class RoutePlanOptimizeRequest
{
    public DateIso: string;
    public HoldDays: number;

    public constructor(init?: Partial<RoutePlanOptimizeRequest>) { (Object as any).assign(this, init); }
}

TypeScript RoutePlanOptimizeRequest 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.

POST /v1/routeplan/optimize HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"DateIso":"String","HoldDays":0}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Assignments":[{"AgreementID":0,"CrewID":0,"Seq":0}],"ByDefaultCrew":0,"ByTerritory":0,"SkippedHeld":0,"Engine":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}