Field Squared API Services

<back to all web services

PublicTask

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

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.Tasks
{
    [DataContract]
    public partial class PublicTask
    {
        public PublicTask()
        {
            Tasks = new List<Task>{};
        }

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

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

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

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

        [DataMember]
        public virtual List<Task> Tasks { 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.API.Model.Tasks
{
    ///<summary>
    ///Contains the data for a task within the system, with versioned object referneces to users and forms.
    ///</summary>
    public partial class Task
    {
        public Task()
        {
            Schedules = new List<Schedule>{};
            Users = new List<string>{};
            UsersExtended = new List<DomainItem>{};
            Teams = new List<DomainItem>{};
            Documents = new List<string>{};
            Docs = new List<DomainItem>{};
            DocSummaries = new List<Document>{};
            Data = new Dictionary<string, Object>{};
            Contacts = new List<string>{};
            Assets = new List<string>{};
            Tasks = new List<string>{};
            Events = new List<EventItem>{};
            UserStatuses = new Dictionary<string, List<EventItem>>{};
            InventoryItems = new List<string>{};
            LaborItems = new List<string>{};
            RequiredAssets = new List<RequiredAsset>{};
            RequiredInventoryTypes = new List<RequiredInventoryType>{};
            RequiredUsers = new List<RequiredUser>{};
            CustomDataFields = new List<CustomDataField>{};
        }

        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 ExternalId { get; set; }
        public virtual string Created { get; set; }
        public virtual string LastUpdated { get; set; }
        public virtual string LastUpdatedLocal { get; set; }
        public virtual decimal Rank { get; set; }
        public virtual string Name { get; set; }
        public virtual string Description { get; set; }
        public virtual Address Address { get; set; }
        public virtual List<Schedule> Schedules { get; set; }
        public virtual string Status { get; set; }
        public virtual string BlockedReason { get; set; }
        public virtual string TaskType { get; set; }
        public virtual string DueDate { get; set; }
        public virtual string DesiredCompletionDate { get; set; }
        public virtual TimeWindow DesiredTimeWindow { get; set; }
        public virtual int? Priority { get; set; }
        public virtual double PercentComplete { get; set; }
        public virtual List<string> Users { get; set; }
        public virtual List<DomainItem> UsersExtended { get; set; }
        public virtual List<DomainItem> Teams { get; set; }
        public virtual List<string> Documents { get; set; }
        public virtual List<DomainItem> Docs { get; set; }
        public virtual List<Document> DocSummaries { get; set; }
        public virtual Dictionary<string, Object> Data { get; set; }
        public virtual List<string> Contacts { get; set; }
        public virtual Location StatusLocation { get; set; }
        public virtual List<string> Assets { get; set; }
        public virtual List<string> Tasks { get; set; }
        public virtual string Owner { get; set; }
        public virtual List<EventItem> Events { get; set; }
        public virtual Dictionary<string, List<EventItem>> UserStatuses { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual string SeriesId { get; set; }
        public virtual int JobTimerRunTime { get; set; }
        public virtual int JobTimerPauseTime { get; set; }
        public virtual int JobTimerTransitTime { get; set; }
        public virtual string CurrentJobTimerStatus { get; set; }
        public virtual string CurrentJobTimerTime { get; set; }
        public virtual List<string> InventoryItems { get; set; }
        public virtual List<string> LaborItems { get; set; }
        public virtual List<RequiredAsset> RequiredAssets { get; set; }
        public virtual List<RequiredInventoryType> RequiredInventoryTypes { get; set; }
        public virtual List<RequiredUser> RequiredUsers { get; set; }
        public virtual bool Locked { get; set; }
        public virtual bool Ready { get; set; }
        public virtual TaskTemplate TaskTemplate { get; set; }
        public virtual List<CustomDataField> CustomDataFields { get; set; }
    }

    public partial class TimeWindow
    {
        public virtual int Start { get; set; }
        public virtual int End { 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.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.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
{
    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,
    }

}

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 BindingDescriptor
    {
        public virtual string Binding { get; set; }
        public virtual bool Required { get; set; }
    }

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

    public partial class RequiredAsset
    {
        public virtual int Number { get; set; }
        public virtual string Type { get; set; }
    }

    public partial class RequiredInventoryType
    {
        public virtual int Number { get; set; }
        public virtual string Type { get; set; }
        public virtual string Name { get; set; }
        public virtual bool IsSerialized { get; set; }
        public virtual string Description { get; set; }
    }

    public partial class RequiredUser
    {
        public RequiredUser()
        {
            SkillTags = new List<string>{};
        }

        public virtual int Number { get; set; }
        public virtual List<string> SkillTags { get; set; }
    }

    public partial class TaskStatusDef
    {
        public TaskStatusDef()
        {
            TransitionCustomFields = new List<string>{};
            AutoCreateDocuments = new List<string>{};
            SubmittedForms = new List<BindingDescriptor>{};
        }

        public virtual string Name { get; set; }
        public virtual string Color { get; set; }
        public virtual string Code { get; set; }
        public virtual string TransitionFrom { get; set; }
        public virtual string TransitionMessage { get; set; }
        public virtual List<string> TransitionCustomFields { get; set; }
        public virtual string HiddenIf { get; set; }
        public virtual bool IsStart { get; set; }
        public virtual bool IsEnd { get; set; }
        public virtual bool IsBlocked { get; set; }
        public virtual string StatusType { get; set; }
        public virtual string ProgressType { get; set; }
        public virtual List<string> AutoCreateDocuments { get; set; }
        public virtual bool LockTask { get; set; }
        public virtual List<BindingDescriptor> SubmittedForms { get; set; }
    }

    public partial class TaskTemplate
    {
        public TaskTemplate()
        {
            CustomFields = new List<CustomField>{};
            Statuses = new List<TaskStatusDef>{};
        }

        public virtual List<CustomField> CustomFields { get; set; }
        public virtual List<TaskStatusDef> Statuses { get; set; }
        public virtual string TaskListDetails { get; set; }
        public virtual string AutoAssignStatus { get; set; }
        public virtual string AutoUnassignStatus { get; set; }
        public virtual string AutoScheduleStatus { get; set; }
        public virtual string AutoUnscheduleStatus { get; set; }
        public virtual string AutoUpdateStartStatus { get; set; }
        public virtual string AutoUpdateEndStatus { get; set; }
        public virtual string ArrivalStatus { get; set; }
        public virtual string DepartureStatus { get; set; }
        public virtual bool ConfirmArrival { get; set; }
        public virtual bool ConfirmDeparture { get; set; }
        public virtual bool ManualArrivalAllowed { get; set; }
        public virtual bool ManualDepartureAllowed { get; set; }
        public virtual bool HideDisabledStatuses { get; set; }
        public virtual int GeofenceRadius { get; set; }
    }

}

C# PublicTask DTOs

POST /{Workspace}/API/Task/{Id} HTTP/1.1 
Host: dev.fieldsquared.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":"String","Workspace":"String","TaskTemplate":"String","Task":{"Name":"String","Description":"String","ExternalId":"String","TaskType":"String","Priority":0,"DueDate":"String","DesiredCompletionDate":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","ScheduleStart":"String","ScheduleEnd":"String","Status":"String","User":"String","Team":"String","Asset":"String","Contact":"String","TimeZone":"String","LastUpdated":"String","Created":"String","Data":{"String":{}}},"Tasks":[{"Name":"String","Description":"String","ExternalId":"String","TaskType":"String","Priority":0,"DueDate":"String","DesiredCompletionDate":"String","Lat":0,"Lon":0,"StreetAddress":"String","Unit":"String","City":"String","State":"String","Zip":"String","Country":"String","ScheduleStart":"String","ScheduleEnd":"String","Status":"String","User":"String","Team":"String","Asset":"String","Contact":"String","TimeZone":"String","LastUpdated":"String","Created":"String","Data":{"String":{}}}]}