Field Squared API Services

<back to all web services

RouteList

The following routes are available for this service:
GET/{Workspace}/RouteList
GET/{Workspace}/RouteList/Count
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.API.Model;
using Field2Office.DomainObjects.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
{
    ///<summary>
    ///Contains the data for a route within the system.
    ///</summary>
    public partial class Route
    {
        public Route()
        {
            Segments = new List<RouteSegment>{};
            Nodes = new List<RouteNode>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string AssignedWorkspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string Created { get; set; }
        public virtual string LastUpdated { get; set; }
        public virtual string Date { get; set; }
        public virtual string StartTime { get; set; }
        public virtual string EndTime { get; set; }
        public virtual string UserId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Type { get; set; }
        public virtual List<RouteSegment> Segments { get; set; }
        public virtual int TotalTime { get; set; }
        public virtual double TotalDistance { get; set; }
        public virtual List<RouteNode> Nodes { get; set; }
    }

    public partial class RouteList
    {
        public RouteList()
        {
            Routes = new List<Route>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string DateGenerated { get; set; }
        public virtual List<Route> Routes { get; set; }
        public virtual long RecordsAvailable { 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; }
    }

    public partial class RouteSegment
    {
        public RouteSegment()
        {
            Geometry = new List<Location>{};
            DrivingDirections = new List<string>{};
        }

        public virtual int Time { get; set; }
        public virtual double Distance { get; set; }
        public virtual string Start { get; set; }
        public virtual string End { get; set; }
        public virtual List<Location> Geometry { get; set; }
        public virtual List<string> DrivingDirections { get; set; }
        public virtual RouteNode EndNode { 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# RouteList DTOs

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

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /{Workspace}/RouteList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv