Field Squared API Services

<back to all web services

ScheduleRequestList

Set schedules for multiple tasks in a single operation.

The following routes are available for this service:
POST/{Workspace}/ScheduleRequestList
using System;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using Field2Office.API.Model.Schedules;

namespace Field2Office.API.Model.Schedules
{
    public partial class Schedule
    {
        public Schedule()
        {
            Users = new List<string>{};
            Teams = new List<string>{};
            Data = new Dictionary<string, Object>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual string BasedOn { get; set; }
        public virtual string Start { get; set; }
        public virtual string End { get; set; }
        public virtual string TimeZone { get; set; }
        public virtual List<string> Users { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual Dictionary<string, Object> Data { get; set; }
    }

    public partial class ScheduleRequest
    {
        public ScheduleRequest()
        {
            Users = new List<string>{};
            Teams = new List<string>{};
            Schedules = new List<Schedule>{};
        }

        public virtual string Workspace { get; set; }
        public virtual string ObjectId { get; set; }
        public virtual string VersionId { get; set; }
        public virtual List<string> Users { get; set; }
        public virtual List<string> Teams { get; set; }
        public virtual bool UnassignUsers { get; set; }
        public virtual bool UnassignTeams { get; set; }
        public virtual bool Unschedule { get; set; }
        public virtual bool DeleteTask { get; set; }
        public virtual string Status { get; set; }
        public virtual string Type { get; set; }
        public virtual string TaskType { get; set; }
        public virtual string DueDate { get; set; }
        public virtual bool SetPriority { get; set; }
        public virtual int Priority { get; set; }
        public virtual List<Schedule> Schedules { get; set; }
    }

    ///<summary>
    ///Set schedules for multiple tasks in a single operation.
    ///</summary>
    public partial class ScheduleRequestList
    {
        public ScheduleRequestList()
        {
            ScheduleRequests = new List<ScheduleRequest>{};
        }

        public virtual string Workspace { get; set; }
        public virtual List<ScheduleRequest> ScheduleRequests { get; set; }
    }

}

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

<ScheduleRequestList xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/Field2Office.API.Model.Schedules">
  <ScheduleRequests>
    <ScheduleRequest>
      <DeleteTask>false</DeleteTask>
      <DueDate>String</DueDate>
      <ObjectId>String</ObjectId>
      <Priority>0</Priority>
      <Schedules>
        <Schedule>
          <BasedOn>String</BasedOn>
          <Data xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:KeyValueOfstringanyType>
              <d6p1:Key>String</d6p1:Key>
              <d6p1:Value />
            </d6p1:KeyValueOfstringanyType>
          </Data>
          <End>String</End>
          <ObjectId>String</ObjectId>
          <Start>String</Start>
          <Teams xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </Teams>
          <TimeZone>String</TimeZone>
          <Users xmlns:d6p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
            <d6p1:string>String</d6p1:string>
          </Users>
          <VersionId>String</VersionId>
          <Workspace>String</Workspace>
        </Schedule>
      </Schedules>
      <SetPriority>false</SetPriority>
      <Status>String</Status>
      <TaskType>String</TaskType>
      <Teams xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Teams>
      <Type>String</Type>
      <UnassignTeams>false</UnassignTeams>
      <UnassignUsers>false</UnassignUsers>
      <Unschedule>false</Unschedule>
      <Users xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </Users>
      <VersionId>String</VersionId>
      <Workspace>String</Workspace>
    </ScheduleRequest>
  </ScheduleRequests>
  <Workspace>String</Workspace>
</ScheduleRequestList>