Field Squared API Services

Team

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

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

import Foundation
import ServiceStack

/**
* Represents a DTO for a team in a workspace. Calls without an ObjectId will retrieve an array of all team objects for the workspace.
*/
public class Team : Codable
{
    public var workspace:String
    public var timeZone:String
    public var objectId:String
    public var externalId:String
    public var versionId:String
    public var basedOn:String
    public var name:String
    public var enabled:Bool
    public var members:[DomainItem] = []
    public var lead:DomainItem
    public var parent:DomainItem
    public var address:Address
    public var data:[String:String] = [:]
    public var teams:[String] = []
    public var events:[EventItem] = []
    public var createdBy:String
    public var activeLaborTypes:[String:Object] = [:]

    required public init(){}
}

public class DomainItem : Codable
{
    public var workspace:String
    public var objectId:String
    public var versionId:String
    public var lastUpdated:String

    required public init(){}
}

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 Location : Codable
{
    public var y:Double
    public var x: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(){}
}

Swift Team 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.

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

{"Workspace":"String","TimeZone":"String","ObjectId":"String","ExternalId":"String","VersionId":"String","BasedOn":"String","Name":"String","Enabled":false,"Members":[{"Workspace":"String","ObjectId":"String","VersionId":"String","LastUpdated":"String"}],"Lead":{"Workspace":"String","ObjectId":"String","VersionId":"String","LastUpdated":"String"},"Parent":{"Workspace":"String","ObjectId":"String","VersionId":"String","LastUpdated":"String"},"Address":{"Street":"String","Unit":"String","City":"String","State":"String","Zip":"String","ContactTitle":"String","ContactName":"String","ContactPhone":"String","ContactEmail":"String","Location":{"y":0,"x":0},"SiteName":"String","GeocodeFailed":false,"Country":"String"},"Data":{"String":"String"},"Teams":["String"],"Events":[{"ObjectId":"String","Date":"String","Location":{"y":0,"x":0},"Barcode":"String","Details":"String","Type":"String","IsScan":false,"User":"String","SelectedBy":"String","Status":"String","StatusType":"String","DateCreated":"String","Automatic":false}],"CreatedBy":"String","ActiveLaborTypes":{"String":{}}}