Field Squared API Services

<back to all web services

AssetType

Represents a single asset type
.

The following routes are available for this service:
GET,POST,DELETE/{Workspace}/AssetType/{Type}
GET/{Workspace}/AssetType
import Foundation
import ServiceStack

/**
* Represents a single asset type.
*/
public class AssetType : Codable
{
    public var workspace:String
    public var type:String
    public var isActive:Bool
    public var name:String
    public var make:String
    public var model:String
    public var manuf:String
    public var barcode:String
    public var symbol:String
    public var color:String
    public var lineThickness:Double
    public var scale:Double
    public var visibilityMin:Double
    public var visibilityMax:Double
    public var syncNode:Bool
    public var customFields:[CustomField] = []
    public var allowedParentTypes:[String] = []
    public var allowedChildTypes:[String] = []
    public var useLocationHistory:Bool
    public var isMobileAsset:Bool
    public var data:[String:String] = [:]
    public var geomType:String
    public var docFilter:Bool
    public var showRelatedDocs:Bool
    public var allowedDocTypes:[String] = []
    public var tla:String
    public var useTLAOnMap:Bool
    public var routingLocation:String
    public var fill:String
    public var fillOpacity:Double
    public var showAnno:Bool
    public var annoColor:String
    public var maxAnnoVisibility:Double
    public var annoFont:String
    public var hideTypeLabel:Bool
    public var useAddress:Bool
    public var useFullScreen:Bool
    public var timeSeries:Int
    public var isUnselectable:Bool
    public var editTeams:[String] = []
    public var isWarehouse:Bool
    public var isVehicle:Bool
    public var customSymbol:[String:Object] = [:]
    public var taskSeriesTemplates:[String] = []

    required public init(){}
}

public class CustomField : Codable
{
    public var key:String
    public var label:String
    public var isActive:Bool
    public var isReadOnly:Bool
    public var isHidden:Bool
    public var isMandatory:Bool
    public var displayOnMap:Bool
    public var customFieldDataType:CustomFieldDataType
    public var values:String
    public var prompt:String
    public var `default`:String
    public var defaultAutoUpdate:Bool
    public var requiredIf:String
    public var hidden:[String] = []
    public var readOnly:[String] = []
    public var controlArgs:[String:Object] = [:]
    public var indexSlot:String
    public var index:String

    required public init(){}
}

public enum CustomFieldDataType : String, Codable
{
    case Text
    case Number
    case Decimal
    case Money
    case PhoneNumber
    case Ssn
    case List
    case Date
    case File
    case Barcode
    case GPS
    case Photo
    case Spacer
    case Separator
    case AutoNumber
    case TextArea
    case Contact
    case User
    case Asset
    case Checkbox
    case CoreAssetList
    case CoreTaskList
    case CoreParentTask
    case CoreContactList
    case ComboBox
    case DateTime
    case Time
    case Location
    case CoreLocation
    case Label
    case EventLog
    case Address
    case Catalog
    case CoreTeamList
    case Segment
    case CoreTimeSeries
    case TimeSeries
    case Command
    case AutoNumberNumeric
    case CatalogList
    case CatalogComboBox
    case DateRange
    case DocumentGrid
    case ReportLink
    case Hyperlink
    case PercentComplete
    case Chart
    case Range
    case ExternalId
    case AssetCatalog
    case Inventory
    case CoreTaskLaborItemTypes
    case CoreTaskLaborItems
    case ObjectList
    case CoreTimeZone
}

Swift AssetType 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}/AssetType/{Type} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"Workspace":"String","Type":"String","IsActive":false,"Name":"String","Make":"String","Model":"String","Manuf":"String","Barcode":"String","Symbol":"String","Color":"String","LineThickness":0,"Scale":0,"VisibilityMin":0,"VisibilityMax":0,"SyncNode":false,"CustomFields":[{"Key":"String","Label":"String","IsActive":false,"IsReadOnly":false,"IsHidden":false,"IsMandatory":false,"DisplayOnMap":false,"CustomFieldDataType":"Text","Values":"String","Prompt":"String","Default":"String","DefaultAutoUpdate":false,"RequiredIf":"String","Hidden":["String"],"ReadOnly":["String"],"ControlArgs":{"String":"String"},"UseArrayMergeType":"Set","IndexSlot":"String","Index":"String"}],"AllowedParentTypes":["String"],"AllowedChildTypes":["String"],"UseLocationHistory":false,"IsMobileAsset":false,"Data":{"String":"String"},"GeomType":"String","DocFilter":false,"ShowRelatedDocs":false,"AllowedDocTypes":["String"],"TLA":"String","UseTLAOnMap":false,"RoutingLocation":"String","Fill":"String","FillOpacity":0,"ShowAnno":false,"AnnoColor":"String","MaxAnnoVisibility":0,"AnnoFont":"String","HideTypeLabel":false,"UseAddress":false,"UseFullScreen":false,"TimeSeries":0,"IsUnselectable":false,"EditTeams":["String"],"IsWarehouse":false,"IsVehicle":false,"CustomSymbol":{"String":{}},"TaskSeriesTemplates":["String"]}