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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Users;
using Field2Office.API.Model;
using Field2Office.DomainObjects;

namespace Field2Office.API.Model
{
    public partial class Location
    {
        public virtual double y { get; set; }
        public virtual double x { get; set; }
    }

}

namespace Field2Office.API.Model.Users
{
    ///<summary>
    ///Service representing a UserLocation in a workspace.
    ///</summary>
    public partial class UserLocation
        : Location
    {
        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual UserStatus UserStatus { get; set; }
    }

    ///<summary>
    ///Returns a list of all user's locations for the entire workspace.
    ///</summary>
    public partial class UserLocationList
    {
        public UserLocationList()
        {
            UserLocations = new List<UserLocation>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string DateGenerated { get; set; }
        public virtual List<UserLocation> UserLocations { get; set; }
    }

}

namespace Field2Office.DomainObjects
{
    public enum UserStatus
    {
        NotStarted,
        Driving,
        InProgress,
        Complete,
        Blocked,
    }

}

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