Field Squared API Services

ProposeRouteRequest

The following routes are available for this service:
POST	/{Workspace}/ProposeRoute

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

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 /{Workspace}/ProposeRoute HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
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}