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
import java.math.*;
import java.util.*;
import net.servicestack.client.*;

public class dtos
{

    /**
    * Returns a list of all user's locations for the entire workspace.
    */
    public static class UserLocationList
    {
        public String Workspace = null;
        public String DateGenerated = null;
        public ArrayList<UserLocation> UserLocations = null;
        
        public String getWorkspace() { return Workspace; }
        public UserLocationList setWorkspace(String value) { this.Workspace = value; return this; }
        public String getDateGenerated() { return DateGenerated; }
        public UserLocationList setDateGenerated(String value) { this.DateGenerated = value; return this; }
        public ArrayList<UserLocation> getUserLocations() { return UserLocations; }
        public UserLocationList setUserLocations(ArrayList<UserLocation> value) { this.UserLocations = value; return this; }
    }

    /**
    * Service representing a UserLocation in a workspace.
    */
    public static class UserLocation extends Location
    {
        public String Workspace = null;
        public String ObjectId = null;
        public String VersionId = null;
        public String BasedOn = null;
        public UserStatus UserStatus = null;
        
        public String getWorkspace() { return Workspace; }
        public UserLocation setWorkspace(String value) { this.Workspace = value; return this; }
        public String getObjectId() { return ObjectId; }
        public UserLocation setObjectId(String value) { this.ObjectId = value; return this; }
        public String getVersionId() { return VersionId; }
        public UserLocation setVersionId(String value) { this.VersionId = value; return this; }
        public String getBasedOn() { return BasedOn; }
        public UserLocation setBasedOn(String value) { this.BasedOn = value; return this; }
        public UserStatus getUserStatus() { return UserStatus; }
        public UserLocation setUserStatus(UserStatus value) { this.UserStatus = value; return this; }
    }

    public static class Location
    {
        public Double y = null;
        public Double x = null;
        
        public Double getY() { return y; }
        public Location setY(Double value) { this.y = value; return this; }
        public Double getX() { return x; }
        public Location setX(Double value) { this.x = value; return this; }
    }

    public static enum UserStatus
    {
        NotStarted,
        Driving,
        InProgress,
        Complete,
        Blocked;
    }

}

Java 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