Field Squared API Services

TaskSeriesTemplate

Contains the data for a task series template object

The following routes are available for this service:
GET,PUT,POST	/{Workspace}/TaskSeriesTemplate
GET,PUT,POST,DELETE	/{Workspace}/TaskSeriesTemplate/{ObjectId}

namespace Field2Office.API.Model.Tasks

open System
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type SeriesSchedule() = 
        member val Day:Int32 = new Int32() with get,set
        member val Start:Int32 = new Int32() with get,set
        member val End:Int32 = new Int32() with get,set
        member val AllDay:Boolean = new Boolean() with get,set
        member val Duration:Int32 = new Int32() with get,set

    ///<summary>
    ///Contains the data for a task series template object
    ///</summary>
    [<AllowNullLiteral>]
    type TaskSeriesTemplate() = 
        member val Workspace:String = null with get,set
        member val AssignedWorkspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val ExternalId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val Created:String = null with get,set
        member val CreatedBy:String = null with get,set
        member val LastUpdated:String = null with get,set
        member val LastUpdatedLocal:String = null with get,set
        member val TemplateName:String = null with get,set
        member val TaskName:String = null with get,set
        member val TaskType:String = null with get,set
        member val ParentAsset:String = null with get,set
        member val ParentTemplate:String = null with get,set
        member val SeriesStartDate:String = null with get,set
        member val SeriesEndDate:String = null with get,set
        member val DueDate:String = null with get,set
        member val CreateFrequency:String = null with get,set
        member val RepeatFrequency:String = null with get,set
        member val RepeatInterval:Int32 = new Int32() with get,set
        member val ScheduleDefs:ResizeArray<SeriesSchedule> = new ResizeArray<SeriesSchedule>() with get,set
        member val CreateOnAsset:Boolean = new Boolean() with get,set
        member val CreateOnChildren:Boolean = new Boolean() with get,set
        member val BatchCreate:Boolean = new Boolean() with get,set
        member val FutureBatch:Int32 = new Int32() with get,set
        member val CreateSchedule:Boolean = new Boolean() with get,set
        member val SetDueDate:Boolean = new Boolean() with get,set
        member val IsRootTemplate:Boolean = new Boolean() with get,set
        member val Users:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Teams:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Data:String = null with get,set
        member val DataTree:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set

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

<TaskSeriesTemplate 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>
  <BatchCreate>false</BatchCreate>
  <CreateFrequency>String</CreateFrequency>
  <CreateOnAsset>false</CreateOnAsset>
  <CreateOnChildren>false</CreateOnChildren>
  <CreateSchedule>false</CreateSchedule>
  <Created>String</Created>
  <CreatedBy>String</CreatedBy>
  <Data>String</Data>
  <DataTree xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:KeyValueOfstringanyType>
      <d2p1:Key>String</d2p1:Key>
      <d2p1:Value />
    </d2p1:KeyValueOfstringanyType>
  </DataTree>
  <DueDate>String</DueDate>
  <ExternalId>String</ExternalId>
  <FutureBatch>0</FutureBatch>
  <IsRootTemplate>false</IsRootTemplate>
  <LastUpdated>String</LastUpdated>
  <LastUpdatedLocal>String</LastUpdatedLocal>
  <ObjectId>String</ObjectId>
  <ParentAsset>String</ParentAsset>
  <ParentTemplate>String</ParentTemplate>
  <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>
  <SetDueDate>false</SetDueDate>
  <TaskName>String</TaskName>
  <TaskType>String</TaskType>
  <Teams xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Teams>
  <TemplateName>String</TemplateName>
  <Users xmlns:d2p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
    <d2p1:string>String</d2p1:string>
  </Users>
  <VersionId>String</VersionId>
  <Workspace>String</Workspace>
</TaskSeriesTemplate>