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

<TaskSeries xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Tasks">
  <AssignedWorkspace>String</AssignedWorkspace>
  <BasedOn>String</BasedOn>
  <Created>String</Created>
  <CreatedBy>String</CreatedBy>
  <ExternalId>String</ExternalId>
  <LastTaskEndDate>String</LastTaskEndDate>
  <LastUpdated>String</LastUpdated>
  <LastUpdatedLocal>String</LastUpdatedLocal>
  <ObjectId>String</ObjectId>
  <ParentAsset>String</ParentAsset>
  <RepeatFrequency>String</RepeatFrequency>
  <RepeatInterval>0</RepeatInterval>
  <ScheduleDefs xmlns:d2p1="http://schemas.datacontract.org/2004/07/Field2Office.DomainObjects.Model">
    <d2p1:SeriesSchedule>
      <d2p1:AllDay>false</d2p1:AllDay>
      <d2p1:Day>0</d2p1:Day>
      <d2p1:Duration>0</d2p1:Duration>
      <d2p1:End>0</d2p1:End>
      <d2p1:Start>0</d2p1:Start>
    </d2p1:SeriesSchedule>
  </ScheduleDefs>
  <SeriesEndDate>String</SeriesEndDate>
  <SeriesStartDate>String</SeriesStartDate>
  <TaskName>String</TaskName>
  <TaskType>String</TaskType>
  <Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Teams>
  <TemplateId>String</TemplateId>
  <Users xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Users>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
</TaskSeries>