Field Squared API Services

User

Represents a DTO for a user in a workspace. Calls without an ObjectId will retrieve an array of all user objects for the workspace.

The following routes are available for this service:
GET,POST,PUT,DELETE	/{Workspace}/User/{ObjectId}
GET	/{Workspace}/User

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

    [<AllowNullLiteral>]
    type Address() = 
        member val Street:String = null with get,set
        member val Unit:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val Zip:String = null with get,set
        member val ContactTitle:String = null with get,set
        member val ContactName:String = null with get,set
        member val ContactPhone:String = null with get,set
        member val ContactEmail:String = null with get,set
        member val Location:Location = null with get,set
        member val SiteName:String = null with get,set
        member val GeocodeFailed:Boolean = new Boolean() with get,set
        member val Country:String = null with get,set

    [<AllowNullLiteral>]
    type UIColumnPref() = 
        member val Name:String = null with get,set
        member val Width:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type EventItem() = 
        member val ObjectId:String = null with get,set
        member val Date:String = null with get,set
        member val Location:Location = null with get,set
        member val Barcode:String = null with get,set
        member val Details:String = null with get,set
        member val Type:String = null with get,set
        member val IsScan:Boolean = new Boolean() with get,set
        member val User:String = null with get,set
        member val SelectedBy:String = null with get,set
        member val Status:String = null with get,set
        member val StatusType:String = null with get,set
        member val DateCreated:String = null with get,set
        member val Automatic:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type WorkDay() = 
        member val DayOfWeek:Int32 = new Int32() with get,set
        member val Start:Int32 = new Int32() with get,set
        member val End:Int32 = new Int32() with get,set
        member val Lunch:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CustomSchedule() = 
        member val Date:String = null with get,set
        member val Start:Int32 = new Int32() with get,set
        member val End:Int32 = new Int32() with get,set
        member val Type:String = null with get,set

    ///<summary>
    ///Represents a DTO for a user in a workspace. Calls without an ObjectId will retrieve an array of all user objects for the workspace.
    ///</summary>
    [<AllowNullLiteral>]
    type User() = 
        member val Workspace:String = null with get,set
        member val TimeZone:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val Created:String = null with get,set
        member val LastUpdated:String = null with get,set
        member val BasedOn:String = null with get,set
        member val ExternalId:String = null with get,set
        member val Name:String = null with get,set
        member val Initials:String = null with get,set
        member val Phone:String = null with get,set
        member val Email:String = null with get,set
        member val Password:String = null with get,set
        member val RequestUser:String = null with get,set
        member val Location:Location = null with get,set
        member val UserType:String = null with get,set
        member val ProposedRoute:ResizeArray<Location> = new ResizeArray<Location>() with get,set
        member val ActualRoute:ResizeArray<Location> = new ResizeArray<Location>() with get,set
        member val Image:String = null with get,set
        member val UserStatus:UserStatus = new UserStatus() with get,set
        member val RecordStatus:String = null with get,set
        member val Documents:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val SubscribeToEmails:Boolean = new Boolean() with get,set
        member val Address:Address = null with get,set
        member val SkillTags:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Enabled:Boolean = new Boolean() with get,set
        member val UIPrefTaskColumnsOff:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val UIPrefTaskColumns:ResizeArray<UIColumnPref> = new ResizeArray<UIColumnPref>() with get,set
        member val Data:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Events:ResizeArray<EventItem> = new ResizeArray<EventItem>() with get,set
        member val Color:String = null with get,set
        member val VehicleAsset:String = null with get,set
        member val ExternalAuth:Boolean = new Boolean() with get,set
        member val CreatedBy:String = null with get,set
        member val ServiceAccount:Boolean = new Boolean() with get,set
        member val Assets:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val TfaRequired:Boolean = new Boolean() with get,set
        member val TfaPreference:String = null with get,set
        member val WorkWeek:ResizeArray<WorkDay> = new ResizeArray<WorkDay>() with get,set
        member val CustomSchedulesEnabled:Boolean = new Boolean() with get,set
        member val CustomSchedules:ResizeArray<CustomSchedule> = new ResizeArray<CustomSchedule>() with get,set
        member val OverrideSso:Boolean = new Boolean() with get,set

F# User 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}/User/{ObjectId} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<User xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Users">
  <ActualRoute xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:Location>
      <d2p1:x>0</d2p1:x>
      <d2p1:y>0</d2p1:y>
    </d2p1:Location>
  </ActualRoute>
  <Address xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:City>String</d2p1:City>
    <d2p1:ContactEmail>String</d2p1:ContactEmail>
    <d2p1:ContactName>String</d2p1:ContactName>
    <d2p1:ContactPhone>String</d2p1:ContactPhone>
    <d2p1:ContactTitle>String</d2p1:ContactTitle>
    <d2p1:Country>String</d2p1:Country>
    <d2p1:GeocodeFailed>false</d2p1:GeocodeFailed>
    <d2p1:Location>
      <d2p1:x>0</d2p1:x>
      <d2p1:y>0</d2p1:y>
    </d2p1:Location>
    <d2p1:SiteName>String</d2p1:SiteName>
    <d2p1:State>String</d2p1:State>
    <d2p1:Street>String</d2p1:Street>
    <d2p1:Unit>String</d2p1:Unit>
    <d2p1:Zip>String</d2p1:Zip>
  </Address>
  <Assets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Assets>
  <BasedOn>String</BasedOn>
  <Color>String</Color>
  <Created>String</Created>
  <CreatedBy>String</CreatedBy>
  <CustomSchedules>
    <CustomSchedule>
      <Date>String</Date>
      <End>0</End>
      <Start>0</Start>
      <Type>String</Type>
    </CustomSchedule>
  </CustomSchedules>
  <CustomSchedulesEnabled>false</CustomSchedulesEnabled>
  <Data xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringstring>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value>String</d2p1:Value>
    </d2p1:KeyValueOfstringstring>
  </Data>
  <Documents xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Documents>
  <Email>String</Email>
  <Enabled>false</Enabled>
  <Events xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:EventItem>
      <d2p1:Automatic>false</d2p1:Automatic>
      <d2p1:Barcode>String</d2p1:Barcode>
      <d2p1:Date>String</d2p1:Date>
      <d2p1:DateCreated>String</d2p1:DateCreated>
      <d2p1:Details>String</d2p1:Details>
      <d2p1:IsScan>false</d2p1:IsScan>
      <d2p1:Location>
        <d2p1:x>0</d2p1:x>
        <d2p1:y>0</d2p1:y>
      </d2p1:Location>
      <d2p1:ObjectId>String</d2p1:ObjectId>
      <d2p1:SelectedBy>String</d2p1:SelectedBy>
      <d2p1:Status>String</d2p1:Status>
      <d2p1:StatusType>String</d2p1:StatusType>
      <d2p1:Type>String</d2p1:Type>
      <d2p1:User>String</d2p1:User>
    </d2p1:EventItem>
  </Events>
  <ExternalAuth>false</ExternalAuth>
  <ExternalId>String</ExternalId>
  <Image>String</Image>
  <Initials>String</Initials>
  <LastUpdated>String</LastUpdated>
  <Location xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:x>0</d2p1:x>
    <d2p1:y>0</d2p1:y>
  </Location>
  <Name>String</Name>
  <ObjectId>String</ObjectId>
  <OverrideSso>false</OverrideSso>
  <Password>String</Password>
  <Phone>String</Phone>
  <ProposedRoute xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:Location>
      <d2p1:x>0</d2p1:x>
      <d2p1:y>0</d2p1:y>
    </d2p1:Location>
  </ProposedRoute>
  <RecordStatus>String</RecordStatus>
  <RequestUser>String</RequestUser>
  <ServiceAccount>false</ServiceAccount>
  <SkillTags xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </SkillTags>
  <SubscribeToEmails>false</SubscribeToEmails>
  <Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Teams>
  <TfaPreference>String</TfaPreference>
  <TfaRequired>false</TfaRequired>
  <TimeZone>String</TimeZone>
  <UIPrefTaskColumns xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
    <d2p1:UIColumnPref>
      <d2p1:Name>String</d2p1:Name>
      <d2p1:Width>0</d2p1:Width>
    </d2p1:UIColumnPref>
  </UIPrefTaskColumns>
  <UIPrefTaskColumnsOff xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </UIPrefTaskColumnsOff>
  <UserStatus>NotStarted</UserStatus>
  <UserType>String</UserType>
  <VehicleAsset>String</VehicleAsset>
  <VersionId>String</VersionId>
  <WorkWeek xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Workspaces">
    <d2p1:WorkDay>
      <d2p1:DayOfWeek>0</d2p1:DayOfWeek>
      <d2p1:End>0</d2p1:End>
      <d2p1:Lunch>0</d2p1:Lunch>
      <d2p1:Start>0</d2p1:Start>
    </d2p1:WorkDay>
  </WorkWeek>
  <Workspace>String</Workspace>
</User>