Field Squared API Services

<back to all web 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
namespace Field2Office.API.Model

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Location() = 
        member val y:Double = new Double() with get,set
        member val x:Double = new Double() with get,set

    type UserStatus =
        | NotStarted = 0
        | Driving = 1
        | InProgress = 2
        | Complete = 3
        | Blocked = 4

    ///<summary>
    ///Service representing a UserLocation in a workspace.
    ///</summary>
    [<AllowNullLiteral>]
    type UserLocation() = 
        inherit Location()
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val UserStatus:UserStatus = new UserStatus() with get,set

    ///<summary>
    ///Returns a list of all user's locations for the entire workspace.
    ///</summary>
    [<AllowNullLiteral>]
    type UserLocationList() = 
        member val Workspace:String = null with get,set
        member val DateGenerated:String = null with get,set
        member val UserLocations:ResizeArray<UserLocation> = new ResizeArray<UserLocation>() with get,set

F# 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