Trendsic Platform Service

<back to all web services

VisitOptimizeRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/visits/optimize
import 'package:servicestack/servicestack.dart';

class VisitActionResponse implements IConvertible
{
    bool? Success;
    String? Message;
    int? Affected;
    ResponseStatus? ResponseStatus;

    VisitActionResponse({this.Success,this.Message,this.Affected,this.ResponseStatus});
    VisitActionResponse.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Success = json['Success'];
        Message = json['Message'];
        Affected = json['Affected'];
        ResponseStatus = JsonConverters.fromJson(json['ResponseStatus'],'ResponseStatus',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Success': Success,
        'Message': Message,
        'Affected': Affected,
        'ResponseStatus': JsonConverters.toJson(ResponseStatus,'ResponseStatus',context!)
    };

    getTypeName() => "VisitActionResponse";
    TypeContext? context = _ctx;
}

class VisitOptimizeRequest implements IConvertible
{
    int? CrewID;
    String? Date;
    double? StartLat;
    double? StartLng;

    VisitOptimizeRequest({this.CrewID,this.Date,this.StartLat,this.StartLng});
    VisitOptimizeRequest.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        CrewID = json['CrewID'];
        Date = json['Date'];
        StartLat = JsonConverters.toDouble(json['StartLat']);
        StartLng = JsonConverters.toDouble(json['StartLng']);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'CrewID': CrewID,
        'Date': Date,
        'StartLat': StartLat,
        'StartLng': StartLng
    };

    getTypeName() => "VisitOptimizeRequest";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'api.dev.dynamics.trendsic.com', types: <String, TypeInfo> {
    'VisitActionResponse': TypeInfo(TypeOf.Class, create:() => VisitActionResponse()),
    'VisitOptimizeRequest': TypeInfo(TypeOf.Class, create:() => VisitOptimizeRequest()),
});

Dart 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
		}
	}
}