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}
import 'package:servicestack/servicestack.dart';

class SeriesSchedule implements IConvertible
{
    int? Day;
    int? Start;
    int? End;
    bool? AllDay;
    int? Duration;

    SeriesSchedule({this.Day,this.Start,this.End,this.AllDay,this.Duration});
    SeriesSchedule.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Day = json['Day'];
        Start = json['Start'];
        End = json['End'];
        AllDay = json['AllDay'];
        Duration = json['Duration'];
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Day': Day,
        'Start': Start,
        'End': End,
        'AllDay': AllDay,
        'Duration': Duration
    };

    getTypeName() => "SeriesSchedule";
    TypeContext? context = _ctx;
}

/**
* Contains the data for a task series template object
*/
class TaskSeriesTemplate implements IConvertible
{
    String? 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;
    int? RepeatInterval;
    List<SeriesSchedule>? ScheduleDefs;
    bool? CreateOnAsset;
    bool? CreateOnChildren;
    bool? BatchCreate;
    int? FutureBatch;
    bool? CreateSchedule;
    bool? SetDueDate;
    bool? IsRootTemplate;
    List<String>? Users;
    List<String>? Teams;
    String? Data;
    Map<String,dynamic?>? DataTree;

    TaskSeriesTemplate({this.Workspace,this.AssignedWorkspace,this.ObjectId,this.VersionId,this.ExternalId,this.BasedOn,this.Created,this.CreatedBy,this.LastUpdated,this.LastUpdatedLocal,this.TemplateName,this.TaskName,this.TaskType,this.ParentAsset,this.ParentTemplate,this.SeriesStartDate,this.SeriesEndDate,this.DueDate,this.CreateFrequency,this.RepeatFrequency,this.RepeatInterval,this.ScheduleDefs,this.CreateOnAsset,this.CreateOnChildren,this.BatchCreate,this.FutureBatch,this.CreateSchedule,this.SetDueDate,this.IsRootTemplate,this.Users,this.Teams,this.Data,this.DataTree});
    TaskSeriesTemplate.fromJson(Map<String, dynamic> json) { fromMap(json); }

    fromMap(Map<String, dynamic> json) {
        Workspace = json['Workspace'];
        AssignedWorkspace = json['AssignedWorkspace'];
        ObjectId = json['ObjectId'];
        VersionId = json['VersionId'];
        ExternalId = json['ExternalId'];
        BasedOn = json['BasedOn'];
        Created = json['Created'];
        CreatedBy = json['CreatedBy'];
        LastUpdated = json['LastUpdated'];
        LastUpdatedLocal = json['LastUpdatedLocal'];
        TemplateName = json['TemplateName'];
        TaskName = json['TaskName'];
        TaskType = json['TaskType'];
        ParentAsset = json['ParentAsset'];
        ParentTemplate = json['ParentTemplate'];
        SeriesStartDate = json['SeriesStartDate'];
        SeriesEndDate = json['SeriesEndDate'];
        DueDate = json['DueDate'];
        CreateFrequency = json['CreateFrequency'];
        RepeatFrequency = json['RepeatFrequency'];
        RepeatInterval = json['RepeatInterval'];
        ScheduleDefs = JsonConverters.fromJson(json['ScheduleDefs'],'List<SeriesSchedule>',context!);
        CreateOnAsset = json['CreateOnAsset'];
        CreateOnChildren = json['CreateOnChildren'];
        BatchCreate = json['BatchCreate'];
        FutureBatch = json['FutureBatch'];
        CreateSchedule = json['CreateSchedule'];
        SetDueDate = json['SetDueDate'];
        IsRootTemplate = json['IsRootTemplate'];
        Users = JsonConverters.fromJson(json['Users'],'List<String>',context!);
        Teams = JsonConverters.fromJson(json['Teams'],'List<String>',context!);
        Data = json['Data'];
        DataTree = JsonConverters.fromJson(json['DataTree'],'Map<String,dynamic?>',context!);
        return this;
    }

    Map<String, dynamic> toJson() => {
        'Workspace': Workspace,
        'AssignedWorkspace': AssignedWorkspace,
        'ObjectId': ObjectId,
        'VersionId': VersionId,
        'ExternalId': ExternalId,
        'BasedOn': BasedOn,
        'Created': Created,
        'CreatedBy': CreatedBy,
        'LastUpdated': LastUpdated,
        'LastUpdatedLocal': LastUpdatedLocal,
        'TemplateName': TemplateName,
        'TaskName': TaskName,
        'TaskType': TaskType,
        'ParentAsset': ParentAsset,
        'ParentTemplate': ParentTemplate,
        'SeriesStartDate': SeriesStartDate,
        'SeriesEndDate': SeriesEndDate,
        'DueDate': DueDate,
        'CreateFrequency': CreateFrequency,
        'RepeatFrequency': RepeatFrequency,
        'RepeatInterval': RepeatInterval,
        'ScheduleDefs': JsonConverters.toJson(ScheduleDefs,'List<SeriesSchedule>',context!),
        'CreateOnAsset': CreateOnAsset,
        'CreateOnChildren': CreateOnChildren,
        'BatchCreate': BatchCreate,
        'FutureBatch': FutureBatch,
        'CreateSchedule': CreateSchedule,
        'SetDueDate': SetDueDate,
        'IsRootTemplate': IsRootTemplate,
        'Users': JsonConverters.toJson(Users,'List<String>',context!),
        'Teams': JsonConverters.toJson(Teams,'List<String>',context!),
        'Data': Data,
        'DataTree': JsonConverters.toJson(DataTree,'Map<String,dynamic?>',context!)
    };

    getTypeName() => "TaskSeriesTemplate";
    TypeContext? context = _ctx;
}

TypeContext _ctx = TypeContext(library: 'dev.fieldsquared.com', types: <String, TypeInfo> {
    'SeriesSchedule': TypeInfo(TypeOf.Class, create:() => SeriesSchedule()),
    'TaskSeriesTemplate': TypeInfo(TypeOf.Class, create:() => TaskSeriesTemplate()),
    'List<SeriesSchedule>': TypeInfo(TypeOf.Class, create:() => <SeriesSchedule>[]),
    'Map<String,dynamic?>': TypeInfo(TypeOf.Class, create:() => Map<String,dynamic?>()),
});

Dart 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>