Field Squared API Services

<back to all web services

PublicUser

import Foundation
import ServiceStack

// @DataContract
public class PublicUser : Codable
{
    // @DataMember
    public var id:String

    // @DataMember
    public var workspace:String

    // @DataMember
    public var user:User

    // @DataMember
    public var users:[User] = []

    required public init(){}
}

/**
* Represents a DTO for a user in a workspace. Calls without an ObjectId will retrieve an array of all user objects for the workspace.
*/
public class User : Codable
{
    public var workspace:String
    public var timeZone:String
    public var objectId:String
    public var versionId:String
    public var created:String
    public var lastUpdated:String
    public var basedOn:String
    public var externalId:String
    public var name:String
    public var initials:String
    public var phone:String
    public var email:String
    public var password:String
    public var requestUser:String
    public var location:Location
    public var userType:String
    public var proposedRoute:[Location] = []
    public var actualRoute:[Location] = []
    public var image:String
    public var userStatus:UserStatus
    public var recordStatus:String
    public var documents:[String] = []
    public var subscribeToEmails:Bool
    public var address:Address
    public var skillTags:[String] = []
    public var enabled:Bool
    public var uiPrefTaskColumnsOff:[String] = []
    public var uiPrefTaskColumns:[UIColumnPref] = []
    public var data:[String:String] = [:]
    public var teams:[String] = []
    public var events:[EventItem] = []
    public var color:String
    public var vehicleAsset:String
    public var externalAuth:Bool
    public var createdBy:String
    public var serviceAccount:Bool
    public var assets:[String] = []
    public var tfaRequired:Bool
    public var tfaPreference:String
    public var workWeek:[WorkDay] = []
    public var customSchedulesEnabled:Bool
    public var customSchedules:[CustomSchedule] = []
    public var overrideSso:Bool

    required public init(){}
}

public class Location : Codable
{
    public var y:Double
    public var x:Double

    required public init(){}
}

public enum UserStatus : String, Codable
{
    case NotStarted
    case Driving
    case InProgress
    case Complete
    case Blocked
}

public class Address : Codable
{
    public var street:String
    public var unit:String
    public var city:String
    public var state:String
    public var zip:String
    public var contactTitle:String
    public var contactName:String
    public var contactPhone:String
    public var contactEmail:String
    public var location:Location
    public var siteName:String
    public var geocodeFailed:Bool
    public var country:String

    required public init(){}
}

public class UIColumnPref : Codable
{
    public var name:String
    public var width:Double

    required public init(){}
}

public class EventItem : Codable
{
    public var objectId:String
    public var date:String
    public var location:Location
    public var barcode:String
    public var details:String
    public var type:String
    public var isScan:Bool
    public var user:String
    public var selectedBy:String
    public var status:String
    public var statusType:String
    public var dateCreated:String
    public var automatic:Bool

    required public init(){}
}

public class WorkDay : Codable
{
    public var dayOfWeek:Int
    public var start:Int
    public var end:Int
    public var lunch:Int

    required public init(){}
}

public class CustomSchedule : Codable
{
    public var date:String
    public var start:Int
    public var end:Int
    public var type:String

    required public init(){}
}

Swift PublicUser DTOs

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

<PublicUser xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.PublicApi.Users">
  <Id>String</Id>
  <User>
    <City>String</City>
    <Country>String</Country>
    <Created>String</Created>
    <Data xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringanyType>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value />
      </d3p1:KeyValueOfstringanyType>
    </Data>
    <Email>String</Email>
    <Enabled>false</Enabled>
    <ExternalId>String</ExternalId>
    <Image>String</Image>
    <Initials>String</Initials>
    <LastUpdated>String</LastUpdated>
    <Lat>0</Lat>
    <Lon>0</Lon>
    <Name>String</Name>
    <Phone>String</Phone>
    <SkillTags xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </SkillTags>
    <State>String</State>
    <StreetAddress>String</StreetAddress>
    <Teams xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Teams>
    <Unit>String</Unit>
    <UserType>String</UserType>
    <Zip>String</Zip>
  </User>
  <Users>
    <User>
      <City>String</City>
      <Country>String</Country>
      <Created>String</Created>
      <Data xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </Data>
      <Email>String</Email>
      <Enabled>false</Enabled>
      <ExternalId>String</ExternalId>
      <Image>String</Image>
      <Initials>String</Initials>
      <LastUpdated>String</LastUpdated>
      <Lat>0</Lat>
      <Lon>0</Lon>
      <Name>String</Name>
      <Phone>String</Phone>
      <SkillTags xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </SkillTags>
      <State>String</State>
      <StreetAddress>String</StreetAddress>
      <Teams xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Teams>
      <Unit>String</Unit>
      <UserType>String</UserType>
      <Zip>String</Zip>
    </User>
  </Users>
  <Workspace>String</Workspace>
</PublicUser>