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
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Assets;
using Field2Office.API.Model.Workspaces;
using Field2Office.DomainObjects;

namespace Field2Office.API.Model.Assets
{
    ///<summary>
    ///Represents a single asset type.
    ///</summary>
    public partial class AssetType
    {
        public AssetType()
        {
            CustomFields = new List<CustomField>{};
            AllowedParentTypes = new List<string>{};
            AllowedChildTypes = new List<string>{};
            Data = new Dictionary<string, string>{};
            AllowedDocTypes = new List<string>{};
            EditTeams = new List<string>{};
            CustomSymbol = new Dictionary<string, Object>{};
            TaskSeriesTemplates = new List<string>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string Type { get; set; }
        public virtual bool IsActive { get; set; }
        public virtual string Name { get; set; }
        public virtual string Make { get; set; }
        public virtual string Model { get; set; }
        public virtual string Manuf { get; set; }
        public virtual string Barcode { get; set; }
        public virtual string Symbol { get; set; }
        public virtual string Color { get; set; }
        public virtual double LineThickness { get; set; }
        public virtual double Scale { get; set; }
        public virtual double VisibilityMin { get; set; }
        public virtual double VisibilityMax { get; set; }
        public virtual bool SyncNode { get; set; }
        public virtual List<CustomField> CustomFields { get; set; }
        public virtual List<string> AllowedParentTypes { get; set; }
        public virtual List<string> AllowedChildTypes { get; set; }
        public virtual bool UseLocationHistory { get; set; }
        public virtual bool IsMobileAsset { get; set; }
        public virtual Dictionary<string, string> Data { get; set; }
        public virtual string GeomType { get; set; }
        public virtual bool DocFilter { get; set; }
        public virtual bool ShowRelatedDocs { get; set; }
        public virtual List<string> AllowedDocTypes { get; set; }
        public virtual string TLA { get; set; }
        public virtual bool UseTLAOnMap { get; set; }
        public virtual string RoutingLocation { get; set; }
        public virtual string Fill { get; set; }
        public virtual double FillOpacity { get; set; }
        public virtual bool ShowAnno { get; set; }
        public virtual string AnnoColor { get; set; }
        public virtual double MaxAnnoVisibility { get; set; }
        public virtual string AnnoFont { get; set; }
        public virtual bool HideTypeLabel { get; set; }
        public virtual bool UseAddress { get; set; }
        public virtual bool UseFullScreen { get; set; }
        public virtual int TimeSeries { get; set; }
        public virtual bool IsUnselectable { get; set; }
        public virtual List<string> EditTeams { get; set; }
        public virtual bool IsWarehouse { get; set; }
        public virtual bool IsVehicle { get; set; }
        public virtual Dictionary<string, Object> CustomSymbol { get; set; }
        public virtual List<string> TaskSeriesTemplates { get; set; }
    }

}

namespace Field2Office.API.Model.Workspaces
{
    public partial class CustomField
    {
        public CustomField()
        {
            Hidden = new List<string>{};
            ReadOnly = new List<string>{};
            ControlArgs = new Dictionary<string, Object>{};
        }

        public virtual string Key { get; set; }
        public virtual string Label { get; set; }
        public virtual bool IsActive { get; set; }
        public virtual bool IsReadOnly { get; set; }
        public virtual bool IsHidden { get; set; }
        public virtual bool IsMandatory { get; set; }
        public virtual bool DisplayOnMap { get; set; }
        public virtual CustomFieldDataType CustomFieldDataType { get; set; }
        public virtual string Values { get; set; }
        public virtual string Prompt { get; set; }
        public virtual string Default { get; set; }
        public virtual bool DefaultAutoUpdate { get; set; }
        public virtual string RequiredIf { get; set; }
        public virtual List<string> Hidden { get; set; }
        public virtual List<string> ReadOnly { get; set; }
        public virtual Dictionary<string, Object> ControlArgs { get; set; }
        public virtual string IndexSlot { get; set; }
        public virtual string Index { get; set; }
    }

}

namespace Field2Office.DomainObjects
{
    public enum 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,
    }

}

C# 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>