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

**ScheduleRequestList** Parameters:
Name	Parameter	Data Type	Required	Description
Workspace	path	string	No
ScheduleRequests	body	List<ScheduleRequest>	No

**ScheduleRequest** Parameters:
Name	Parameter	Data Type	Required
Workspace	form	string	No
ObjectId	form	string	No
VersionId	form	string	No
Users	form	List<string>	No
Teams	form	List<string>	No
UnassignUsers	form	bool	No
UnassignTeams	form	bool	No
Unschedule	form	bool	No
DeleteTask	form	bool	No
Status	form	string	No
Type	form	string	No
TaskType	form	string	No
DueDate	form	string	No
SetPriority	form	bool	No
Priority	form	int	No
Schedules	form	List<Schedule>	No

**Schedule** Parameters:
Name	Parameter	Data Type	Required
Workspace	form	string	No
ObjectId	form	string	No
VersionId	form	string	No
BasedOn	form	string	No
Start	form	string	No
End	form	string	No
TimeZone	form	string	No
Users	form	List<string>	No
Teams	form	List<string>	No
Data	form	Dictionary<string, Object>	No

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>