Trendsic Platform Service

<back to all web services

RoutePlanOptimizeRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/routeplan/optimize
"use strict";
export class RoutePlanOptimizeAssignment {
    /** @param {{AgreementID?:number,CrewID?:number,Seq?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    AgreementID;
    /** @type {number} */
    CrewID;
    /** @type {number} */
    Seq;
}
export class RoutePlanOptimizeResponse {
    /** @param {{Assignments?:RoutePlanOptimizeAssignment[],ByDefaultCrew?:number,ByTerritory?:number,SkippedHeld?:number,Engine?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {RoutePlanOptimizeAssignment[]} */
    Assignments = [];
    /** @type {number} */
    ByDefaultCrew;
    /** @type {number} */
    ByTerritory;
    /** @type {number} */
    SkippedHeld;
    /** @type {string} */
    Engine;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class RoutePlanOptimizeRequest {
    /** @param {{DateIso?:string,HoldDays?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    DateIso;
    /** @type {number} */
    HoldDays;
}

JavaScript RoutePlanOptimizeRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
Content-Length: length

{"DateIso":"String","HoldDays":0}

HTTP/1.1 200 OK
Content-Type: application/json
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"}}}