Field Squared API Services

<back to all web services

RouteList

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

Namespace Global

    Namespace Field2Office.API.Model

        Public Partial Class Location
            Public Overridable Property y As Double
            Public Overridable Property x As Double
        End Class
    End Namespace

    Namespace Field2Office.API.Model.MapRoute

        '''<Summary>
        '''Contains the data for a route within the system.
        '''</Summary>
        Public Partial Class Route
            Public Sub New()
                Segments = New List(Of RouteSegment)
                Nodes = New List(Of RouteNode)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property AssignedWorkspace As String
            Public Overridable Property ObjectId As String
            Public Overridable Property VersionId As String
            Public Overridable Property BasedOn As String
            Public Overridable Property Created As String
            Public Overridable Property LastUpdated As String
            Public Overridable Property [Date] As String
            Public Overridable Property StartTime As String
            Public Overridable Property EndTime As String
            Public Overridable Property UserId As String
            Public Overridable Property Name As String
            Public Overridable Property Type As String
            Public Overridable Property Segments As List(Of RouteSegment)
            Public Overridable Property TotalTime As Integer
            Public Overridable Property TotalDistance As Double
            Public Overridable Property Nodes As List(Of RouteNode)
        End Class

        Public Partial Class RouteList
            Public Sub New()
                Routes = New List(Of Route)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property DateGenerated As String
            Public Overridable Property Routes As List(Of Route)
            Public Overridable Property RecordsAvailable As Long
        End Class

        Public Partial Class RouteNode
            Inherits ClassedItem
            Public Overridable Property Location As Location
            Public Overridable Property StopTime As Integer
            Public Overridable Property Schedule As Schedule
            Public Overridable Property Name As String
        End Class

        Public Partial Class RouteSegment
            Public Sub New()
                Geometry = New List(Of Location)
                DrivingDirections = New List(Of String)
            End Sub

            Public Overridable Property Time As Integer
            Public Overridable Property Distance As Double
            Public Overridable Property Start As String
            Public Overridable Property [End] As String
            Public Overridable Property Geometry As List(Of Location)
            Public Overridable Property DrivingDirections As List(Of String)
            Public Overridable Property EndNode As RouteNode
        End Class
    End Namespace

    Namespace Field2Office.API.Model.Schedules

        Public Partial Class Schedule
            Public Sub New()
                Users = New List(Of String)
                Teams = New List(Of String)
                Data = New Dictionary(Of String, Object)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property ObjectId As String
            Public Overridable Property VersionId As String
            Public Overridable Property BasedOn As String
            Public Overridable Property Start As String
            Public Overridable Property [End] As String
            Public Overridable Property TimeZone As String
            Public Overridable Property Users As List(Of String)
            Public Overridable Property Teams As List(Of String)
            Public Overridable Property Data As Dictionary(Of String, Object)
        End Class
    End Namespace

    Namespace Field2Office.DomainObjects.Model

        Public Partial Class ClassedItem
            Public Sub New()
                Ancestors = New List(Of String)
            End Sub

            Public Overridable Property ObjectId As String
            Public Overridable Property [Class] As String
            Public Overridable Property VersionId As String
            Public Overridable Property Ancestors As List(Of String)
            Public Overridable Property Type As String
        End Class
    End Namespace
End Namespace

VB.NET RouteList DTOs

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