Field Squared API Services

<back to all web 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}
Imports System
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports Field2Office.API.Model.Tasks
Imports Field2Office.DomainObjects.Model

Namespace Global

    Namespace Field2Office.API.Model.Tasks

        '''<Summary>
        '''Contains the data for a task series template object
        '''</Summary>
        Public Partial Class TaskSeriesTemplate
            Public Sub New()
                ScheduleDefs = New List(Of SeriesSchedule)
                Users = New List(Of String)
                Teams = New List(Of String)
                DataTree = New Dictionary(Of String, Object)
            End Sub

            Public Overridable Property Workspace As String
            Public Overridable Property AssignedWorkspace As String
            Public Overridable Property ObjectId As String
            Public Overridable Property VersionId As String
            Public Overridable Property ExternalId As String
            Public Overridable Property BasedOn As String
            Public Overridable Property Created As String
            Public Overridable Property CreatedBy As String
            Public Overridable Property LastUpdated As String
            Public Overridable Property LastUpdatedLocal As String
            Public Overridable Property TemplateName As String
            Public Overridable Property TaskName As String
            Public Overridable Property TaskType As String
            Public Overridable Property ParentAsset As String
            Public Overridable Property ParentTemplate As String
            Public Overridable Property SeriesStartDate As String
            Public Overridable Property SeriesEndDate As String
            Public Overridable Property DueDate As String
            Public Overridable Property CreateFrequency As String
            Public Overridable Property RepeatFrequency As String
            Public Overridable Property RepeatInterval As Integer
            Public Overridable Property ScheduleDefs As List(Of SeriesSchedule)
            Public Overridable Property CreateOnAsset As Boolean
            Public Overridable Property CreateOnChildren As Boolean
            Public Overridable Property BatchCreate As Boolean
            Public Overridable Property FutureBatch As Integer
            Public Overridable Property CreateSchedule As Boolean
            Public Overridable Property SetDueDate As Boolean
            Public Overridable Property IsRootTemplate As Boolean
            Public Overridable Property Users As List(Of String)
            Public Overridable Property Teams As List(Of String)
            Public Overridable Property Data As String
            Public Overridable Property DataTree As Dictionary(Of String, Object)
        End Class
    End Namespace

    Namespace Field2Office.DomainObjects.Model

        Public Partial Class SeriesSchedule
            Public Overridable Property Day As Integer
            Public Overridable Property Start As Integer
            Public Overridable Property [End] As Integer
            Public Overridable Property AllDay As Boolean
            Public Overridable Property Duration As Integer
        End Class
    End Namespace
End Namespace

VB.NET TaskSeriesTemplate DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=csv

HTTP + CSV

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: text/csv
Content-Type: text/csv
Content-Length: length

{"Workspace":"String","AssignedWorkspace":"String","ObjectId":"String","VersionId":"String","ExternalId":"String","BasedOn":"String","Created":"String","CreatedBy":"String","LastUpdated":"String","LastUpdatedLocal":"String","TemplateName":"String","TaskName":"String","TaskType":"String","ParentAsset":"String","ParentTemplate":"String","SeriesStartDate":"String","SeriesEndDate":"String","DueDate":"String","CreateFrequency":"String","RepeatFrequency":"String","RepeatInterval":0,"ScheduleDefs":[{"Day":0,"Start":0,"End":0,"AllDay":false,"Duration":0}],"CreateOnAsset":false,"CreateOnChildren":false,"BatchCreate":false,"FutureBatch":0,"CreateSchedule":false,"SetDueDate":false,"IsRootTemplate":false,"Users":["String"],"Teams":["String"],"Data":"String","DataTree":{"String":{}}}