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}
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 object
        '''</Summary>
        Public Partial Class TaskSeries
            Public Sub New()
                Users = New List(Of String)
                Teams = New List(Of String)
                ScheduleDefs = New List(Of SeriesSchedule)
            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 TaskName As String
            Public Overridable Property TaskType As String
            Public Overridable Property Users As List(Of String)
            Public Overridable Property Teams As List(Of String)
            Public Overridable Property SeriesStartDate As String
            Public Overridable Property SeriesEndDate As String
            Public Overridable Property LastTaskEndDate As String
            Public Overridable Property ParentAsset 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 TemplateId As String
        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 TaskSeries DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
Content-Type: application/json
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"}