Field Squared API Services

PublicDocument

The following routes are available for this service:
GET	/{Workspace}/API/Document/Schema
GET, PUT, POST, DELETE	/{Workspace}/API/Document/{Id}
GET, PUT, POST, DELETE	/{Workspace}/API/Document
GET	/{Workspace}/API/Document/Schema/{DocumentType}

using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.PublicApi.Documents;
using Field2Office.API.Model.Documents;
using Field2Office.API.Model;
using Field2Office.API.Model.Teams;
using Field2Office.DomainObjects.Model;
using Field2Office.Core.Model.Task;

namespace Field2Office.API.Model
{
    public partial class Address
    {
        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 ContactTitle { get; set; }
        public virtual string ContactName { get; set; }
        public virtual string ContactPhone { get; set; }
        public virtual string ContactEmail { get; set; }
        public virtual Location Location { get; set; }
        public virtual string SiteName { get; set; }
        public virtual bool GeocodeFailed { get; set; }
        public virtual string Country { 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 Location
    {
        public virtual double y { get; set; }
        public virtual double x { get; set; }
    }

}

namespace Field2Office.API.Model.Documents
{
    ///<summary>
    ///Represents a document associated with a task or user. To return multiple documents, call /{Workspace}/Document and pass in query parameter ids = comma separated list of document ids. 
    ///</summary>
    public partial class Document
    {
        public Document()
        {
            Data = new Dictionary<string, Object>{};
            SecondaryOwners = new List<ClassedItem>{};
            RangeExceptions = new List<RangeExceptionItem>{};
        }

        public virtual string Workspace { 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 Created { get; set; }
        public virtual string ExternalId { get; set; }
        public virtual string LastUpdated { get; set; }
        public virtual string Type { get; set; }
        public virtual string Name { get; set; }
        public virtual string Title { get; set; }
        public virtual Dictionary<string, Object> Data { get; set; }
        public virtual ClassedItem Owner { get; set; }
        public virtual List<ClassedItem> SecondaryOwners { get; set; }
        public virtual Location Location { get; set; }
        public virtual string Date { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual double PercentComplete { get; set; }
        public virtual int PercentTotal { get; set; }
        public virtual int PercentDone { get; set; }
        public virtual List<RangeExceptionItem> RangeExceptions { get; set; }
        public virtual bool Submitted { get; set; }
        public virtual string Schema { get; set; }
        public virtual DocumentOwnerData OwnerData { get; set; }
    }

    public partial class DocumentOwnerData
    {
        public virtual string OwnerType { get; set; }
        public virtual DocumentOwnerDataTask TaskData { get; set; }
        public virtual DocumentOwnerDataAsset AssetData { get; set; }
    }

    public partial class DocumentOwnerDataAsset
    {
        public DocumentOwnerDataAsset()
        {
            CustomDataFields = new List<CustomDataField>{};
        }

        public virtual string ObjectId { get; set; }
        public virtual string Name { get; set; }
        public virtual string AssetType { get; set; }
        public virtual DateTime LastUpdated { get; set; }
        public virtual DateTime Created { get; set; }
        public virtual AddressBasic Address { get; set; }
        public virtual List<CustomDataField> CustomDataFields { get; set; }
    }

    public partial class DocumentOwnerDataTask
    {
        public DocumentOwnerDataTask()
        {
            CustomDataFields = new List<CustomDataField>{};
        }

        public virtual string ObjectId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Status { get; set; }
        public virtual string TaskType { get; set; }
        public virtual DateTime LastUpdated { get; set; }
        public virtual DateTime Created { get; set; }
        public virtual int? Priority { get; set; }
        public virtual decimal Rank { get; set; }
        public virtual Team FirstTeam { get; set; }
        public virtual Address Address { get; set; }
        public virtual List<CustomDataField> CustomDataFields { get; set; }
    }

    public partial class RangeExceptionItem
    {
        public virtual string Binding { get; set; }
        public virtual string Message { get; set; }
        public virtual string Type { get; set; }
        public virtual string ClassName { get; set; }
    }

}

namespace Field2Office.API.Model.PublicApi.Documents
{
    [DataContract]
    public partial class PublicDocument
    {
        public PublicDocument()
        {
            Documents = new List<Document>{};
        }

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

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

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

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

        [DataMember]
        public virtual List<Document> Documents { get; set; }
    }

}

namespace Field2Office.API.Model.Teams
{
    ///<summary>
    ///Represents a DTO for a team in a workspace. Calls without an ObjectId will retrieve an array of all team objects for the workspace.
    ///</summary>
    public partial class Team
    {
        public Team()
        {
            Members = new List<DomainItem>{};
            Data = new Dictionary<string, string>{};
            Teams = new List<string>{};
            Events = new List<EventItem>{};
            ActiveLaborTypes = new Dictionary<string, Object>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string ExternalId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string Name { get; set; }
        public virtual bool Enabled { get; set; }
        public virtual List<DomainItem> Members { get; set; }
        public virtual DomainItem Lead { get; set; }
        public virtual DomainItem Parent { get; set; }
        public virtual Address Address { get; set; }
        public virtual Dictionary<string, string> Data { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual List<EventItem> Events { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual Dictionary<string, Object> ActiveLaborTypes { 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; }
    }

}

namespace Field2Office.DomainObjects.Model
{
    public partial class Address
        : AddressBase
    {
        public virtual string SiteName { get; set; }
        public virtual string ContactTitle { get; set; }
        public virtual string ContactName { get; set; }
        public virtual string ContactPhone { get; set; }
        public virtual string ContactEmail { get; set; }
    }

    public partial class AddressBase
    {
        public virtual string Id { get; set; }
        public virtual string AddressLine1 { get; set; }
        public virtual string AddressLine2 { get; set; }
        public virtual string City { get; set; }
        public virtual string State { get; set; }
        public virtual string Zip { get; set; }
        public virtual Location Location { get; set; }
        public virtual string Name { get; set; }
        public virtual string NameSingleLine { get; set; }
        public virtual string NameSingleLine5DigitZip { get; set; }
        public virtual bool HasValidLocation { get; set; }
        public virtual bool GeocodeFailed { get; set; }
        public virtual string GeocodeResultCode { get; set; }
        public virtual string Country { get; set; }
    }

    public partial class AddressBasic
        : AddressBase
    {
    }

    public partial class Location
    {
        public virtual double Latitude { get; set; }
        public virtual double Longitude { get; set; }
        public virtual bool HasValidLocation { get; set; }
    }

}

C# PublicDocument 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/Document/{Id} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: String,
	Workspace: String,
	DocumentType: String,
	Document: 
	{
		Name: String,
		ExternalId: String,
		Type: String,
		OwnerId: String,
		OwnerClass: String,
		Lat: 0,
		Lon: 0,
		LastUpdated: String,
		Created: String,
		Date: String,
		PercentComplete: 0,
		PercentTotal: 0,
		PercentDone: 0,
		Data: 
		{
			String: {}
		}
	},
	Documents: 
	[
		{
			Name: String,
			ExternalId: String,
			Type: String,
			OwnerId: String,
			OwnerClass: String,
			Lat: 0,
			Lon: 0,
			LastUpdated: String,
			Created: String,
			Date: String,
			PercentComplete: 0,
			PercentTotal: 0,
			PercentDone: 0,
			Data: 
			{
				String: {}
			}
		}
	]
}