Field Squared API Services

<back to all web services

UserLocation

Service representing a UserLocation in a workspace.

The following routes are available for this service:
POST/{Workspace}/UserLocation/{ObjectId}
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

F# UserLocation DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

POST /{Workspace}/UserLocation/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<UserLocation xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Users">
  <x xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">0</x>
  <y xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">0</y>
  <BasedOn>String</BasedOn>
  <ObjectId>String</ObjectId>
  <UserStatus>NotStarted</UserStatus>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
</UserLocation>