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 java.math.*
import java.util.*
import net.servicestack.client.*


/**
* Represents a single asset type.
*/
open class AssetType
{
    var Workspace:String? = null
    var Type:String? = null
    var IsActive:Boolean? = null
    var Name:String? = null
    var Make:String? = null
    var Model:String? = null
    var Manuf:String? = null
    var Barcode:String? = null
    var Symbol:String? = null
    var Color:String? = null
    var LineThickness:Double? = null
    var Scale:Double? = null
    var VisibilityMin:Double? = null
    var VisibilityMax:Double? = null
    var SyncNode:Boolean? = null
    var CustomFields:ArrayList<CustomField> = ArrayList<CustomField>()
    var AllowedParentTypes:ArrayList<String> = ArrayList<String>()
    var AllowedChildTypes:ArrayList<String> = ArrayList<String>()
    var UseLocationHistory:Boolean? = null
    var IsMobileAsset:Boolean? = null
    var Data:HashMap<String,String> = HashMap<String,String>()
    var GeomType:String? = null
    var DocFilter:Boolean? = null
    var ShowRelatedDocs:Boolean? = null
    var AllowedDocTypes:ArrayList<String> = ArrayList<String>()
    var TLA:String? = null
    var UseTLAOnMap:Boolean? = null
    var RoutingLocation:String? = null
    var Fill:String? = null
    var FillOpacity:Double? = null
    var ShowAnno:Boolean? = null
    var AnnoColor:String? = null
    var MaxAnnoVisibility:Double? = null
    var AnnoFont:String? = null
    var HideTypeLabel:Boolean? = null
    var UseAddress:Boolean? = null
    var UseFullScreen:Boolean? = null
    var TimeSeries:Int? = null
    var IsUnselectable:Boolean? = null
    var EditTeams:ArrayList<String> = ArrayList<String>()
    var IsWarehouse:Boolean? = null
    var IsVehicle:Boolean? = null
    var CustomSymbol:HashMap<String,Object> = HashMap<String,Object>()
    var TaskSeriesTemplates:ArrayList<String> = ArrayList<String>()
}

open class CustomField
{
    var Key:String? = null
    var Label:String? = null
    var IsActive:Boolean? = null
    var IsReadOnly:Boolean? = null
    var IsHidden:Boolean? = null
    var IsMandatory:Boolean? = null
    var DisplayOnMap:Boolean? = null
    var CustomFieldDataType:CustomFieldDataType? = null
    var Values:String? = null
    var Prompt:String? = null
    var Default:String? = null
    var DefaultAutoUpdate:Boolean? = null
    var RequiredIf:String? = null
    var Hidden:ArrayList<String> = ArrayList<String>()
    var ReadOnly:ArrayList<String> = ArrayList<String>()
    var ControlArgs:HashMap<String,Object> = HashMap<String,Object>()
    var IndexSlot:String? = null
    var Index:String? = null
}

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

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

<AssetType xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Assets">
  <AllowedChildTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AllowedChildTypes>
  <AllowedDocTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AllowedDocTypes>
  <AllowedParentTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </AllowedParentTypes>
  <AnnoColor>String</AnnoColor>
  <AnnoFont>String</AnnoFont>
  <Barcode>String</Barcode>
  <Color>String</Color>
  <CustomFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">
    <d2p1:CustomField>
      <d2p1:ControlArgs xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringstring>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value>String</d4p1:Value>
        </d4p1:KeyValueOfstringstring>
      </d2p1:ControlArgs>
      <d2p1:CustomFieldDataType>Text</d2p1:CustomFieldDataType>
      <d2p1:Default>String</d2p1:Default>
      <d2p1:DefaultAutoUpdate>false</d2p1:DefaultAutoUpdate>
      <d2p1:DisplayOnMap>false</d2p1:DisplayOnMap>
      <d2p1:Hidden xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Hidden>
      <d2p1:Index>String</d2p1:Index>
      <d2p1:IndexSlot>String</d2p1:IndexSlot>
      <d2p1:IsActive>false</d2p1:IsActive>
      <d2p1:IsHidden>false</d2p1:IsHidden>
      <d2p1:IsMandatory>false</d2p1:IsMandatory>
      <d2p1:IsReadOnly>false</d2p1:IsReadOnly>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Label>String</d2p1:Label>
      <d2p1:Prompt>String</d2p1:Prompt>
      <d2p1:ReadOnly xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:ReadOnly>
      <d2p1:RequiredIf>String</d2p1:RequiredIf>
      <d2p1:Values>String</d2p1:Values>
    </d2p1:CustomField>
  </CustomFields>
  <CustomSymbol xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </CustomSymbol>
  <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>
  <DocFilter>false</DocFilter>
  <EditTeams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </EditTeams>
  <Fill>String</Fill>
  <FillOpacity>0</FillOpacity>
  <GeomType>String</GeomType>
  <HideTypeLabel>false</HideTypeLabel>
  <IsActive>false</IsActive>
  <IsMobileAsset>false</IsMobileAsset>
  <IsUnselectable>false</IsUnselectable>
  <IsVehicle>false</IsVehicle>
  <IsWarehouse>false</IsWarehouse>
  <LineThickness>0</LineThickness>
  <Make>String</Make>
  <Manuf>String</Manuf>
  <MaxAnnoVisibility>0</MaxAnnoVisibility>
  <Model>String</Model>
  <Name>String</Name>
  <RoutingLocation>String</RoutingLocation>
  <Scale>0</Scale>
  <ShowAnno>false</ShowAnno>
  <ShowRelatedDocs>false</ShowRelatedDocs>
  <Symbol>String</Symbol>
  <SyncNode>false</SyncNode>
  <TLA>String</TLA>
  <TaskSeriesTemplates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TaskSeriesTemplates>
  <TimeSeries>0</TimeSeries>
  <Type>String</Type>
  <UseAddress>false</UseAddress>
  <UseFullScreen>false</UseFullScreen>
  <UseLocationHistory>false</UseLocationHistory>
  <UseTLAOnMap>false</UseTLAOnMap>
  <VisibilityMax>0</VisibilityMax>
  <VisibilityMin>0</VisibilityMin>
  <Workspace>String</Workspace>
</AssetType>