Field Squared API Services

<back to all web services

TaskSeries

Contains the data for a task series object

The following routes are available for this service:
GET,PUT,POST,DELETE/{Workspace}/TaskSeries/{ObjectId}
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Tasks;
using Field2Office.DomainObjects.Model;

namespace Field2Office.API.Model.Tasks
{
    ///<summary>
    ///Contains the data for a task series object
    ///</summary>
    public partial class TaskSeries
    {
        public TaskSeries()
        {
            Users = new List<string>{};
            Teams = new List<string>{};
            ScheduleDefs = new List<SeriesSchedule>{};
        }

        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 ExternalId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string Created { get; set; }
        public virtual string CreatedBy { get; set; }
        public virtual string LastUpdated { get; set; }
        public virtual string LastUpdatedLocal { get; set; }
        public virtual string TaskName { get; set; }
        public virtual string TaskType { get; set; }
        public virtual List<string> Users { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual string SeriesStartDate { get; set; }
        public virtual string SeriesEndDate { get; set; }
        public virtual string LastTaskEndDate { get; set; }
        public virtual string ParentAsset { get; set; }
        public virtual string RepeatFrequency { get; set; }
        public virtual int RepeatInterval { get; set; }
        public virtual List<SeriesSchedule> ScheduleDefs { get; set; }
        public virtual string TemplateId { get; set; }
    }

}

namespace Field2Office.DomainObjects.Model
{
    public partial class SeriesSchedule
    {
        public virtual int Day { get; set; }
        public virtual int Start { get; set; }
        public virtual int End { get; set; }
        public virtual bool AllDay { get; set; }
        public virtual int Duration { get; set; }
    }

}

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

{
	Workspace: String,
	AssignedWorkspace: String,
	ObjectId: String,
	VersionId: String,
	ExternalId: String,
	BasedOn: String,
	Created: String,
	CreatedBy: String,
	LastUpdated: String,
	LastUpdatedLocal: String,
	TaskName: String,
	TaskType: String,
	Users: 
	[
		String
	],
	Teams: 
	[
		String
	],
	SeriesStartDate: String,
	SeriesEndDate: String,
	LastTaskEndDate: String,
	ParentAsset: String,
	RepeatFrequency: String,
	RepeatInterval: 0,
	ScheduleDefs: 
	[
		{
			Day: 0,
			Start: 0,
			End: 0,
			AllDay: False,
			Duration: 0
		}
	],
	TemplateId: String
}