Field Squared API Services

ScheduleRequestList

Set schedules for multiple tasks in a single operation.

The following routes are available for this service:
POST	/{Workspace}/ScheduleRequestList

namespace Field2Office.API.Model.Schedules

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

    [<AllowNullLiteral>]
    type Schedule() = 
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null with get,set
        member val BasedOn:String = null with get,set
        member val Start:String = null with get,set
        member val End:String = null with get,set
        member val TimeZone:String = null 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:Dictionary<String, Object> = new Dictionary<String, Object>() with get,set

    [<AllowNullLiteral>]
    type ScheduleRequest() = 
        member val Workspace:String = null with get,set
        member val ObjectId:String = null with get,set
        member val VersionId:String = null 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 UnassignUsers:Boolean = new Boolean() with get,set
        member val UnassignTeams:Boolean = new Boolean() with get,set
        member val Unschedule:Boolean = new Boolean() with get,set
        member val DeleteTask:Boolean = new Boolean() with get,set
        member val Status:String = null with get,set
        member val Type:String = null with get,set
        member val TaskType:String = null with get,set
        member val DueDate:String = null with get,set
        member val SetPriority:Boolean = new Boolean() with get,set
        member val Priority:Int32 = new Int32() with get,set
        member val Schedules:ResizeArray<Schedule> = new ResizeArray<Schedule>() with get,set

    ///<summary>
    ///Set schedules for multiple tasks in a single operation.
    ///</summary>
    [<AllowNullLiteral>]
    type ScheduleRequestList() = 
        member val Workspace:String = null with get,set
        member val ScheduleRequests:ResizeArray<ScheduleRequest> = new ResizeArray<ScheduleRequest>() with get,set

F# 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>