Field Squared API Services

<back to all web services

RouteList

export class Location
{
    public y: number;
    public x: number;

    public constructor(init?: Partial<Location>) { (Object as any).assign(this, init); }
}

export class ClassedItem
{
    public ObjectId: string;
    public Class: string;
    public VersionId: string;
    public Ancestors: string[];
    public Type: string;

    public constructor(init?: Partial<ClassedItem>) { (Object as any).assign(this, init); }
}

export class Schedule
{
    public Workspace: string;
    public ObjectId: string;
    public VersionId: string;
    public BasedOn: string;
    public Start: string;
    public End: string;
    public TimeZone: string;
    public Users: string[];
    public Teams: string[];
    public Data: { [index: string]: Object; };

    public constructor(init?: Partial<Schedule>) { (Object as any).assign(this, init); }
}

export class RouteNode extends ClassedItem
{
    public Location: Location;
    public StopTime: number;
    public Schedule: Schedule;
    public Name: string;

    public constructor(init?: Partial<RouteNode>) { super(init); (Object as any).assign(this, init); }
}

export class RouteSegment
{
    public Time: number;
    public Distance: number;
    public Start: string;
    public End: string;
    public Geometry: Location[];
    public DrivingDirections: string[];
    public EndNode: RouteNode;

    public constructor(init?: Partial<RouteSegment>) { (Object as any).assign(this, init); }
}

/** @description Contains the data for a route within the system. */
export class Route
{
    public Workspace: string;
    public AssignedWorkspace: string;
    public ObjectId: string;
    public VersionId: string;
    public BasedOn: string;
    public Created: string;
    public LastUpdated: string;
    public Date: string;
    public StartTime: string;
    public EndTime: string;
    public UserId: string;
    public Name: string;
    public Type: string;
    public Segments: RouteSegment[];
    public TotalTime: number;
    public TotalDistance: number;
    public Nodes: RouteNode[];

    public constructor(init?: Partial<Route>) { (Object as any).assign(this, init); }
}

export class RouteList
{
    public Workspace: string;
    public DateGenerated: string;
    public Routes: Route[];
    public RecordsAvailable: number;

    public constructor(init?: Partial<RouteList>) { (Object as any).assign(this, init); }
}

TypeScript RouteList DTOs

GET /{Workspace}/RouteList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml