Field Squared API Services

Asset

Contains the data for an asset within the system.

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

namespace Field2Office.API.Model

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type Schedule() = 
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val Start:String = null with get,set
        member val End:String = null with get,set
        member val TimeZone:String = null with get,set
        member val Users:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Data:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set

    [<AllowNullLiteral>]
    type DomainItem() = 
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val LastUpdated:String = null with get,set

    [<AllowNullLiteral>]
    type Location() = 
        member val y:Double = new Double() with get,set
        member val x:Double = new Double() with get,set

    [<AllowNullLiteral>]
    type Geometry() = 
        member val Type:String = null with get,set
        member val Coordinates:ResizeArray<Location> = new ResizeArray<Location>() with get,set

    [<AllowNullLiteral>]
    type MaintenanceRecord() = 
        member val DateTime:String = null with get,set
        member val Notes:String = null with get,set

    [<AllowNullLiteral>]
    type LocationHistory() = 
        member val Date:String = null with get,set
        member val Location:Location = null with get,set
        member val Barcode:String = null with get,set
        member val Notes:String = null with get,set
        member val IsScan:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type ClassedItem() = 
        member val ObjectId:String = null with get,set
        member val Class:String = null with get,set
        member val VersionId:String = null with get,set
        member val Ancestors:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Type:String = null with get,set

    [<AllowNullLiteral>]
    type EventItem() = 
        member val ObjectId:String = null with get,set
        member val Date:String = null with get,set
        member val Location:Location = null with get,set
        member val Barcode:String = null with get,set
        member val Details:String = null with get,set
        member val Type:String = null with get,set
        member val IsScan:Boolean = new Boolean() with get,set
        member val User:String = null with get,set
        member val SelectedBy:String = null with get,set
        member val Status:String = null with get,set
        member val StatusType:String = null with get,set
        member val DateCreated:String = null with get,set
        member val Automatic:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type Anno() = 
        member val X:Double = new Double() with get,set
        member val Y:Double = new Double() with get,set
        member val R:Double = new Double() with get,set
        member val S:Double = new Double() with get,set
        member val T:String = null with get,set

    [<AllowNullLiteral>]
    type AddressBasic() = 
        member val Street:String = null with get,set
        member val Unit:String = null with get,set
        member val City:String = null with get,set
        member val State:String = null with get,set
        member val Zip:String = null with get,set
        member val Country:String = null with get,set
        member val Location:Location = null with get,set

    [<AllowNullLiteral>]
    type CustomDataField() = 
        member val Binding:String = null with get,set
        member val Label:String = null with get,set
        member val Value:Object = null with get,set
        member val DataType:String = null with get,set
        member val IsReadOnly:Boolean = new Boolean() with get,set
        member val IsHidden:Boolean = new Boolean() with get,set
        member val Values:String = null with get,set

    ///<summary>
    ///Contains the data for an asset within the system.
    ///</summary>
    [<AllowNullLiteral>]
    type Asset() = 
        member val Workspace:String = null with get,set
        member val TimeZone:String = null with get,set
        member val AssignedWorkspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val ExternalId:String = null with get,set
        member val Created:String = null with get,set
        member val LastUpdated:String = null with get,set
        member val Name:String = null with get,set
        member val Schedules:ResizeArray<Schedule> = new ResizeArray<Schedule>() with get,set
        member val Documents:ResizeArray<DomainItem> = new ResizeArray<DomainItem>() with get,set
        member val Tasks:ResizeArray<DomainItem> = new ResizeArray<DomainItem>() with get,set
        member val TaskSeries:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val TaskSeriesTemplates:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Users:ResizeArray<DomainItem> = new ResizeArray<DomainItem>() with get,set
        member val Type:String = null with get,set
        member val Symbol:String = null with get,set
        member val Data:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val Geometry:Geometry = null with get,set
        member val MaintenanceHistory:ResizeArray<MaintenanceRecord> = new ResizeArray<MaintenanceRecord>() with get,set
        member val Parent:String = null with get,set
        member val Ancestors:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val LocationHistory:ResizeArray<LocationHistory> = new ResizeArray<LocationHistory>() with get,set
        member val Owner:ClassedItem = null with get,set
        member val IsParent:Boolean = new Boolean() with get,set
        member val Assets:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Contacts:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val GeometryString:String = null with get,set
        member val SourceProjection:String = null with get,set
        member val Events:ResizeArray<EventItem> = new ResizeArray<EventItem>() with get,set
        member val Anno:Anno = null with get,set
        member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Address:AddressBasic = null with get,set
        member val CreatedBy:String = null with get,set
        member val InventoryItems:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val ActiveLaborTypes:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set
        member val Levels:Int32 = new Int32() with get,set
        member val AllAssests:Int32 = new Int32() with get,set
        member val Barcode:String = null with get,set
        member val CustomDataFields:ResizeArray<CustomDataField> = new ResizeArray<CustomDataField>() with get,set

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

<Asset xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model">
  <ActiveLaborTypes xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </ActiveLaborTypes>
  <Address>
    <City>String</City>
    <Country>String</Country>
    <Location>
      <x>0</x>
      <y>0</y>
    </Location>
    <State>String</State>
    <Street>String</Street>
    <Unit>String</Unit>
    <Zip>String</Zip>
  </Address>
  <AllAssests>0</AllAssests>
  <Ancestors xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Ancestors>
  <Anno>
    <R>0</R>
    <S>0</S>
    <T>String</T>
    <X>0</X>
    <Y>0</Y>
  </Anno>
  <Assets xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Assets>
  <AssignedWorkspace>String</AssignedWorkspace>
  <Barcode>String</Barcode>
  <BasedOn>String</BasedOn>
  <Contacts xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Contacts>
  <Created>String</Created>
  <CreatedBy>String</CreatedBy>
  <CustomDataFields xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.Core.Model.Task">
    <d2p1:CustomDataField>
      <d2p1:Binding>String</d2p1:Binding>
      <d2p1:DataType>String</d2p1:DataType>
      <d2p1:IsHidden>false</d2p1:IsHidden>
      <d2p1:IsReadOnly>false</d2p1:IsReadOnly>
      <d2p1:Label>String</d2p1:Label>
      <d2p1:Value />
      <d2p1:Values>String</d2p1:Values>
    </d2p1:CustomDataField>
  </CustomDataFields>
  <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>
  <Documents>
    <DomainItem>
      <LastUpdated>String</LastUpdated>
      <ObjectId>String</ObjectId>
      <VersionId>String</VersionId>
      <Workspace>String</Workspace>
    </DomainItem>
  </Documents>
  <Events>
    <EventItem>
      <Automatic>false</Automatic>
      <Barcode>String</Barcode>
      <Date>String</Date>
      <DateCreated>String</DateCreated>
      <Details>String</Details>
      <IsScan>false</IsScan>
      <Location>
        <x>0</x>
        <y>0</y>
      </Location>
      <ObjectId>String</ObjectId>
      <SelectedBy>String</SelectedBy>
      <Status>String</Status>
      <StatusType>String</StatusType>
      <Type>String</Type>
      <User>String</User>
    </EventItem>
  </Events>
  <ExternalId>String</ExternalId>
  <Geometry>
    <Coordinates>
      <Location>
        <x>0</x>
        <y>0</y>
      </Location>
    </Coordinates>
    <Type>String</Type>
  </Geometry>
  <GeometryString>String</GeometryString>
  <InventoryItems xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </InventoryItems>
  <IsParent>false</IsParent>
  <LastUpdated>String</LastUpdated>
  <Levels>0</Levels>
  <LocationHistory>
    <LocationHistory>
      <Barcode>String</Barcode>
      <Date>String</Date>
      <IsScan>false</IsScan>
      <Location>
        <x>0</x>
        <y>0</y>
      </Location>
      <Notes>String</Notes>
    </LocationHistory>
  </LocationHistory>
  <MaintenanceHistory>
    <MaintenanceRecord>
      <DateTime>String</DateTime>
      <Notes>String</Notes>
    </MaintenanceRecord>
  </MaintenanceHistory>
  <Name>String</Name>
  <ObjectId>String</ObjectId>
  <Owner>
    <Ancestors xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </Ancestors>
    <Class>String</Class>
    <ObjectId>String</ObjectId>
    <Type>String</Type>
    <VersionId>String</VersionId>
  </Owner>
  <Parent>String</Parent>
  <Schedules xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Schedules">
    <d2p1:Schedule>
      <d2p1:BasedOn>String</d2p1:BasedOn>
      <d2p1:Data xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:KeyValueOfstringanyType>
          <d4p1:Key>String</d4p1:Key>
          <d4p1:Value />
        </d4p1:KeyValueOfstringanyType>
      </d2p1:Data>
      <d2p1:End>String</d2p1:End>
      <d2p1:ObjectId>String</d2p1:ObjectId>
      <d2p1:Start>String</d2p1:Start>
      <d2p1:Teams xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Teams>
      <d2p1:TimeZone>String</d2p1:TimeZone>
      <d2p1:Users xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </d2p1:Users>
      <d2p1:VersionId>String</d2p1:VersionId>
      <d2p1:Workspace>String</d2p1:Workspace>
    </d2p1:Schedule>
  </Schedules>
  <SourceProjection>String</SourceProjection>
  <Symbol>String</Symbol>
  <TaskSeries xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TaskSeries>
  <TaskSeriesTemplates xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </TaskSeriesTemplates>
  <Tasks>
    <DomainItem>
      <LastUpdated>String</LastUpdated>
      <ObjectId>String</ObjectId>
      <VersionId>String</VersionId>
      <Workspace>String</Workspace>
    </DomainItem>
  </Tasks>
  <Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Teams>
  <TimeZone>String</TimeZone>
  <Type>String</Type>
  <Users>
    <DomainItem>
      <LastUpdated>String</LastUpdated>
      <ObjectId>String</ObjectId>
      <VersionId>String</VersionId>
      <Workspace>String</Workspace>
    </DomainItem>
  </Users>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
</Asset>