Field Squared API Services

<back to all web services

PublicAsset

The following routes are available for this service:
GET/{Workspace}/API/Asset/Schema
GET, PUT, POST, DELETE/{Workspace}/API/Asset/{Id}
GET, PUT, POST, DELETE/{Workspace}/API/Asset
GET/{Workspace}/API/Asset/Schema/{AssetType}
import Foundation
import ServiceStack

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

    // @DataMember
    public var workspace:String

    // @DataMember
    public var assetType:String

    // @DataMember
    public var asset:Asset

    // @DataMember
    public var assets:[Asset] = []

    required public init(){}
}

/**
* Contains the data for an asset within the system.
*/
public class Asset : Codable
{
    public var workspace:String
    public var timeZone:String
    public var assignedWorkspace:String
    public var objectId:String
    public var versionId:String
    public var basedOn:String
    public var externalId:String
    public var created:String
    public var lastUpdated:String
    public var name:String
    public var schedules:[Schedule] = []
    public var documents:[DomainItem] = []
    public var tasks:[DomainItem] = []
    public var taskSeries:[String] = []
    public var taskSeriesTemplates:[String] = []
    public var users:[DomainItem] = []
    public var type:String
    public var symbol:String
    public var data:[String:String] = [:]
    public var geometry:Geometry
    public var maintenanceHistory:[MaintenanceRecord] = []
    public var parent:String
    public var ancestors:[String] = []
    public var locationHistory:[LocationHistory] = []
    public var owner:ClassedItem
    public var isParent:Bool
    public var assets:[String] = []
    public var contacts:[String] = []
    public var geometryString:String
    public var sourceProjection:String
    public var events:[EventItem] = []
    public var anno:Anno
    public var teams:[String] = []
    public var address:AddressBasic
    public var createdBy:String
    public var inventoryItems:[String] = []
    public var activeLaborTypes:[String:Object] = [:]
    public var levels:Int
    public var allAssests:Int
    public var barcode:String
    public var customDataFields:[CustomDataField] = []

    required public init(){}
}

public class Schedule : Codable
{
    public var workspace:String
    public var objectId:String
    public var versionId:String
    public var basedOn:String
    public var start:String
    public var end:String
    public var timeZone:String
    public var users:[String] = []
    public var teams:[String] = []
    public var data:[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 Geometry : Codable
{
    public var type:String
    public var coordinates:[Location] = []

    required public init(){}
}

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

    required public init(){}
}

public class MaintenanceRecord : Codable
{
    public var dateTime:String
    public var notes:String

    required public init(){}
}

public class LocationHistory : Codable
{
    public var date:String
    public var location:Location
    public var barcode:String
    public var notes:String
    public var isScan:Bool

    required public init(){}
}

public class ClassedItem : Codable
{
    public var objectId:String
    public var `class`:String
    public var versionId:String
    public var ancestors:[String] = []
    public var type:String

    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 Anno : Codable
{
    public var x:Double
    public var y:Double
    public var r:Double
    public var s:Double
    public var t:String

    required public init(){}
}

public class AddressBasic : Codable
{
    public var street:String
    public var unit:String
    public var city:String
    public var state:String
    public var zip:String
    public var country:String
    public var location:Location

    required public init(){}
}

public class CustomDataField : Codable
{
    public var binding:String
    public var label:String
    //value:Object ignored. Type could not be extended in Swift
    public var dataType:String
    public var isReadOnly:Bool
    public var isHidden:Bool
    public var values:String

    required public init(){}
}


Swift PublicAsset DTOs

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

HTTP + JSV

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

POST /{Workspace}/API/Asset/{Id} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: String,
	Workspace: String,
	AssetType: String,
	Asset: 
	{
		Name: String,
		Type: String,
		ExternalId: String,
		Parent: String,
		Lat: 0,
		Lon: 0,
		StreetAddress: String,
		Unit: String,
		City: String,
		State: String,
		Zip: String,
		Country: String,
		Data: 
		{
			String: {}
		},
		LastUpdated: String,
		Created: String,
		Tasks: 
		[
			String
		],
		Team: String
	},
	Assets: 
	[
		{
			Name: String,
			Type: String,
			ExternalId: String,
			Parent: String,
			Lat: 0,
			Lon: 0,
			StreetAddress: String,
			Unit: String,
			City: String,
			State: String,
			Zip: String,
			Country: String,
			Data: 
			{
				String: {}
			},
			LastUpdated: String,
			Created: String,
			Tasks: 
			[
				String
			],
			Team: String
		}
	]
}