Field Squared API Services

<back to all web services

ProposeRouteRequest

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.MapRoute;
using Field2Office.DomainObjects.Model;
using Field2Office.API.Model;
using Field2Office.API.Model.Schedules;

namespace Field2Office.API.Model
{
    public partial class Location
    {
        public virtual double y { get; set; }
        public virtual double x { get; set; }
    }

}

namespace Field2Office.API.Model.MapRoute
{
    public partial class ProposeRouteRequest
    {
        public ProposeRouteRequest()
        {
            Nodes = new List<RouteNode>{};
        }

        public virtual string Workspace { get; set; }
        public virtual List<RouteNode> Nodes { get; set; }
        public virtual bool AllowReorder { get; set; }
        public virtual Location StartLocation { get; set; }
        public virtual Location EndLocation { get; set; }
        public virtual bool ShortestDistance { get; set; }
        public virtual string StartTime { get; set; }
        public virtual bool StartClockAtFirstNode { get; set; }
        public virtual int RoundStartTimes { get; set; }
        public virtual int TransitionTime { get; set; }
        public virtual string LunchStart { get; set; }
        public virtual int LunchDuration { get; set; }
        public virtual int Time { get; set; }
        public virtual int RealTime { get; set; }
        public virtual double Distance { get; set; }
    }

    public partial class RouteNode
        : ClassedItem
    {
        public virtual Location Location { get; set; }
        public virtual int StopTime { get; set; }
        public virtual Schedule Schedule { get; set; }
        public virtual string Name { get; set; }
    }

}

namespace Field2Office.API.Model.Schedules
{
    public partial class Schedule
    {
        public Schedule()
        {
            Users = new List<string>{};
            Teams = new List<string>{};
            Data = new Dictionary<string, Object>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string Start { get; set; }
        public virtual string End { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual List<string> Users { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual Dictionary<string, Object> Data { get; set; }
    }

}

namespace Field2Office.DomainObjects.Model
{
    public partial class ClassedItem
    {
        public ClassedItem()
        {
            Ancestors = new List<string>{};
        }

        public virtual string ObjectId { get; set; }
        public virtual string Class { get; set; }
        public virtual string VersionId { get; set; }
        public virtual List<string> Ancestors { get; set; }
        public virtual string Type { get; set; }
    }

}

C# ProposeRouteRequest DTOs

POST /{Workspace}/ProposeRoute HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Workspace: String,
	Nodes: 
	[
		{
			Location: 
			{
				y: 0,
				x: 0
			},
			StopTime: 0,
			Schedule: 
			{
				Workspace: String,
				ObjectId: String,
				VersionId: String,
				BasedOn: String,
				Start: String,
				End: String,
				TimeZone: String,
				Users: 
				[
					String
				],
				Teams: 
				[
					String
				],
				Data: 
				{
					String: {}
				}
			},
			Name: String,
			ObjectId: String,
			Class: String,
			VersionId: String,
			Ancestors: 
			[
				String
			],
			Type: String
		}
	],
	AllowReorder: False,
	StartLocation: 
	{
		y: 0,
		x: 0
	},
	EndLocation: 
	{
		y: 0,
		x: 0
	},
	ShortestDistance: False,
	StartTime: String,
	StartClockAtFirstNode: False,
	RoundStartTimes: 0,
	TransitionTime: 0,
	LunchStart: String,
	LunchDuration: 0,
	Time: 0,
	RealTime: 0,
	Distance: 0
}