Trendsic Platform Service

<back to all web services

VisitOptimizeRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/visits/optimize
"use strict";
export class VisitActionResponse {
    /** @param {{Success?:boolean,Message?:string,Affected?:number,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    Success;
    /** @type {string} */
    Message;
    /** @type {number} */
    Affected;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class VisitOptimizeRequest {
    /** @param {{CrewID?:number,Date?:string,StartLat?:number,StartLng?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CrewID;
    /** @type {string} */
    Date;
    /** @type {?number} */
    StartLat;
    /** @type {?number} */
    StartLng;
}

JavaScript VisitOptimizeRequest 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.

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

{
	CrewID: 0,
	Date: String,
	StartLat: 0,
	StartLng: 0
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Success: False,
	Message: String,
	Affected: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}