Field Squared API 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}

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.PublicApi.Assets;
using Field2Office.API.Model;
using Field2Office.API.Model.Schedules;
using Field2Office.Core.Model.Task;

namespace Field2Office.API.Model
{
    public partial class AddressBasic
    {
        public virtual string Street { get; set; }
        public virtual string Unit { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string Zip { get; set; }
        public virtual string Country { get; set; }
        public virtual Location Location { get; set; }
    }

    public partial class Anno
    {
        public virtual double X { get; set; }
        public virtual double Y { get; set; }
        public virtual double R { get; set; }
        public virtual double S { get; set; }
        public virtual string T { get; set; }
    }

    ///<summary>
    ///Contains the data for an asset within the system.
    ///</summary>
    public partial class Asset
    {
        public Asset()
        {
            Schedules = new List<Schedule>{};
            Documents = new List<DomainItem>{};
            Tasks = new List<DomainItem>{};
            TaskSeries = new List<string>{};
            TaskSeriesTemplates = new List<string>{};
            Users = new List<DomainItem>{};
            Data = new Dictionary<string, string>{};
            MaintenanceHistory = new List<MaintenanceRecord>{};
            Ancestors = new List<string>{};
            LocationHistory = new List<LocationHistory>{};
            Assets = new List<string>{};
            Contacts = new List<string>{};
            Events = new List<EventItem>{};
            Teams = new List<string>{};
            InventoryItems = new List<string>{};
            ActiveLaborTypes = new Dictionary<string, Object>{};
            CustomDataFields = new List<CustomDataField>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual string AssignedWorkspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string ExternalId { get; set; }
        public virtual string Created { get; set; }
        public virtual string LastUpdated { get; set; }
        public virtual string Name { get; set; }
        public virtual List<Schedule> Schedules { get; set; }
        public virtual List<DomainItem> Documents { get; set; }
        public virtual List<DomainItem> Tasks { get; set; }
        public virtual List<string> TaskSeries { get; set; }
        public virtual List<string> TaskSeriesTemplates { get; set; }
        public virtual List<DomainItem> Users { get; set; }
        public virtual string Type { get; set; }
        public virtual string Symbol { get; set; }
        public virtual Dictionary<string, string> Data { get; set; }
        public virtual Geometry Geometry { get; set; }
        public virtual List<MaintenanceRecord> MaintenanceHistory { get; set; }
        public virtual string Parent { get; set; }
        public virtual List<string> Ancestors { get; set; }
        public virtual List<LocationHistory> LocationHistory { get; set; }
        public virtual ClassedItem Owner { get; set; }
        public virtual bool IsParent { get; set; }
        public virtual List<string> Assets { get; set; }
        public virtual List<string> Contacts { get; set; }
        public virtual string GeometryString { get; set; }
        public virtual string SourceProjection { get; set; }
        public virtual List<EventItem> Events { get; set; }
        public virtual Anno Anno { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual AddressBasic Address { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual List<string> InventoryItems { get; set; }
        public virtual Dictionary<string, Object> ActiveLaborTypes { get; set; }
        public virtual int Levels { get; set; }
        public virtual int AllAssests { get; set; }
        public virtual string Barcode { get; set; }
        public virtual List<CustomDataField> CustomDataFields { get; set; }
    }

    public partial class ClassedItem
    {
        public ClassedItem()
        {
            Ancestors = new List<string>{};
        }

        public virtual string ObjectId { get; set; }
        public virtual string Class { get; set; }
        public virtual string VersionId { get; set; }
        public virtual List<string> Ancestors { get; set; }
        public virtual string Type { get; set; }
    }

    public partial class DomainItem
    {
        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string LastUpdated { get; set; }
    }

    public partial class EventItem
    {
        public virtual string ObjectId { get; set; }
        public virtual string Date { get; set; }
        public virtual Location Location { get; set; }
        public virtual string Barcode { get; set; }
        public virtual string Details { get; set; }
        public virtual string Type { get; set; }
        public virtual bool IsScan { get; set; }
        public virtual string User { get; set; }
        public virtual string SelectedBy { get; set; }
        public virtual string Status { get; set; }
        public virtual string StatusType { get; set; }
        public virtual string DateCreated { get; set; }
        public virtual bool Automatic { get; set; }
    }

    public partial class Geometry
    {
        public Geometry()
        {
            Coordinates = new List<Location>{};
        }

        public virtual string Type { get; set; }
        public virtual List<Location> Coordinates { get; set; }
    }

    public partial class Location
    {
        public virtual double y { get; set; }
        public virtual double x { get; set; }
    }

    public partial class LocationHistory
    {
        public virtual string Date { get; set; }
        public virtual Location Location { get; set; }
        public virtual string Barcode { get; set; }
        public virtual string Notes { get; set; }
        public virtual bool IsScan { get; set; }
    }

    public partial class MaintenanceRecord
    {
        public virtual string DateTime { get; set; }
        public virtual string Notes { get; set; }
    }

}

namespace Field2Office.API.Model.PublicApi.Assets
{
    [DataContract]
    public partial class PublicAsset
    {
        public PublicAsset()
        {
            Assets = new List<Asset>{};
        }

        [DataMember]
        public virtual string Id { get; set; }

        [DataMember]
        public virtual string Workspace { get; set; }

        [DataMember]
        public virtual string AssetType { get; set; }

        [DataMember]
        public virtual Asset Asset { get; set; }

        [DataMember]
        public virtual List<Asset> Assets { get; set; }
    }

}

namespace Field2Office.API.Model.Schedules
{
    public partial class Schedule
    {
        public Schedule()
        {
            Users = new List<string>{};
            Teams = new List<string>{};
            Data = new Dictionary<string, Object>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string Start { get; set; }
        public virtual string End { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual List<string> Users { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual Dictionary<string, Object> Data { get; set; }
    }

}

namespace Field2Office.Core.Model.Task
{
    public partial class CustomDataField
    {
        public virtual string Binding { get; set; }
        public virtual string Label { get; set; }
        public virtual Object Value { get; set; }
        public virtual string DataType { get; set; }
        public virtual bool IsReadOnly { get; set; }
        public virtual bool IsHidden { get; set; }
        public virtual string Values { get; set; }
    }

}

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