Field Squared API Services

UserLocationList

Returns a list of all user's locations for the entire workspace.

The following routes are available for this service:
GET	/{Workspace}/UserLocationList

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

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.Users

        '''<Summary>
        '''Service representing a UserLocation in a workspace.
        '''</Summary>
        Public Partial Class UserLocation
            Inherits Location
            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 UserStatus As UserStatus
        End Class

        '''<Summary>
        '''Returns a list of all user's locations for the entire workspace.
        '''</Summary>
        Public Partial Class UserLocationList
            Public Sub New()
                UserLocations = New List(Of UserLocation)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property DateGenerated As String
            Public Overridable Property UserLocations As List(Of UserLocation)
        End Class
    End Namespace

    Namespace Field2Office.DomainObjects

        Public Enum UserStatus
            NotStarted
            Driving
            InProgress
            Complete
            Blocked
        End Enum
    End Namespace
End Namespace

VB.NET UserLocationList 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.

GET /{Workspace}/UserLocationList HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json