Trendsic Platform Service

ScheduleWorkerPoolRequest

The following routes are available for this service:
GET	/v1/schedule/workerpool

import Foundation
import ServiceStack

public class ScheduleWorkerPoolRequest : Codable
{
    public var projectID:Int
    public var jobID:Int
    public var scope:String
    public var crewID:Int
    public var includeOtherBranches:Bool

    required public init(){}
}

public class WorkerScheduleResponse : Codable
{
    public var items:[WorkerScheduleItem] = []
    public var schedulableJobs:[SchedulableJob] = []
    public var workers:[ScheduleWorker] = []
    public var crews:[Crew] = []
    public var budgetedCrew:[ScheduleWorker] = []
    public var lastAssignment:ScheduleLastAssignment
    public var autoFill:ScheduleAutoFillResult
    public var datesScheduled:Int?
    public var workersScheduled:Int?
    public var itemsRemoved:Int?
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class WorkerScheduleItem : Codable
{
    public var workerScheduleItemID:Int
    public var jobID:Int
    public var projectID:Int?
    public var contactID:Int
    public var scheduledDate:Date?
    public var sortOrder:Int
    public var sourceCrewID:Int?
    public var status:String
    public var startedAt:Date?
    public var completedAt:Date?
    public var workerNotes:String
    public var jobName:String
    public var projectName:String
    public var firstName:String
    public var lastName:String
    public var workerName:String
    public var sourceCrewName:String
    public var projectLocationID:Int?
    public var projectLocationName:String
    public var locationZip:String
    public var locationCity:String
    public var locationLatitude:Double?
    public var locationLongitude:Double?
    public var jobStatusName:String
    public var branchId:String
    public var branchName:String
    public var workerHomeBranchId:String?
    public var workerHomeBranchName:String

    required public init(){}
}

public class SchedulableJob : Codable
{
    public var jobID:Int
    public var jobName:String
    public var projectID:Int
    public var projectName:String
    public var statusID:Int?
    public var statusName:String
    public var projectLocationID:Int?
    public var projectLocationName:String
    public var locationZip:String
    public var locationCity:String
    public var locationLatitude:Double?
    public var locationLongitude:Double?
    public var expectedStartDate:Date?
    public var expectedCompletionDate:Date?
    public var isRecurring:Bool
    public var occurrenceDates:[String] = []

    required public init(){}
}

public class ScheduleWorker : Codable
{
    public var contactId:Int
    public var firstName:String
    public var lastName:String
    public var name:String
    public var initials:String
    public var rate:Double?
    public var imageUrl:String
    public var branchId:String?
    public var branchName:String

    required public init(){}
}

public class Crew : Codable
{
    public var crewID:Int
    public var crewName:String
    public var crewNumber:String
    public var crewManagerContactID:Int
    public var crewManagerContactName:String
    public var crewColor:String
    public var recordCreatedDate:Date
    public var active:Bool
    public var createdByUID:String
    public var projectID:Int
    public var crewMemberCount:Int
    public var projectCrewID:Int
    public var projectName:String
    public var branchId:String
    public var branchName:String

    required public init(){}
}

public class ScheduleLastAssignment : Codable
{
    public var jobID:Int
    public var contactIds:[Int] = []
    public var sourceCrewID:Int?

    required public init(){}
}

public class ScheduleAutoFillResult : Codable
{
    public var jobsFilled:Int
    public var jobsSkipped:Int
    public var visitsScheduled:Int

    required public init(){}
}

Swift ScheduleWorkerPoolRequest 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.

GET /v1/schedule/workerpool HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<WorkerScheduleResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AutoFill>
    <JobsFilled>0</JobsFilled>
    <JobsSkipped>0</JobsSkipped>
    <VisitsScheduled>0</VisitsScheduled>
  </AutoFill>
  <BudgetedCrew>
    <ScheduleWorker>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <BranchName>String</BranchName>
      <ContactId>0</ContactId>
      <FirstName>String</FirstName>
      <ImageUrl>String</ImageUrl>
      <Initials>String</Initials>
      <LastName>String</LastName>
      <Name>String</Name>
      <Rate>0</Rate>
    </ScheduleWorker>
  </BudgetedCrew>
  <Crews>
    <Crew>
      <Active>false</Active>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <BranchName>String</BranchName>
      <CreatedByUID>00000000-0000-0000-0000-000000000000</CreatedByUID>
      <CrewColor>String</CrewColor>
      <CrewID>0</CrewID>
      <CrewManagerContactID>0</CrewManagerContactID>
      <CrewManagerContactName>String</CrewManagerContactName>
      <CrewMemberCount>0</CrewMemberCount>
      <CrewName>String</CrewName>
      <CrewNumber>String</CrewNumber>
      <ProjectCrewID>0</ProjectCrewID>
      <ProjectID>0</ProjectID>
      <ProjectName>String</ProjectName>
      <RecordCreatedDate>0001-01-01T00:00:00</RecordCreatedDate>
    </Crew>
  </Crews>
  <DatesScheduled>0</DatesScheduled>
  <Items>
    <WorkerScheduleItem>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <BranchName>String</BranchName>
      <CompletedAt>0001-01-01T00:00:00</CompletedAt>
      <ContactID>0</ContactID>
      <FirstName>String</FirstName>
      <JobID>0</JobID>
      <JobName>String</JobName>
      <JobStatusName>String</JobStatusName>
      <LastName>String</LastName>
      <LocationCity>String</LocationCity>
      <LocationLatitude>0</LocationLatitude>
      <LocationLongitude>0</LocationLongitude>
      <LocationZip>String</LocationZip>
      <ProjectID>0</ProjectID>
      <ProjectLocationID>0</ProjectLocationID>
      <ProjectLocationName>String</ProjectLocationName>
      <ProjectName>String</ProjectName>
      <ScheduledDate>0001-01-01T00:00:00</ScheduledDate>
      <SortOrder>0</SortOrder>
      <SourceCrewID>0</SourceCrewID>
      <SourceCrewName>String</SourceCrewName>
      <StartedAt>0001-01-01T00:00:00</StartedAt>
      <Status>String</Status>
      <WorkerHomeBranchId>00000000-0000-0000-0000-000000000000</WorkerHomeBranchId>
      <WorkerHomeBranchName>String</WorkerHomeBranchName>
      <WorkerName>String</WorkerName>
      <WorkerNotes>String</WorkerNotes>
      <WorkerScheduleItemID>0</WorkerScheduleItemID>
    </WorkerScheduleItem>
  </Items>
  <ItemsRemoved>0</ItemsRemoved>
  <LastAssignment>
    <ContactIds xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:int>0</d3p1:int>
    </ContactIds>
    <JobID>0</JobID>
    <SourceCrewID>0</SourceCrewID>
  </LastAssignment>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <SchedulableJobs>
    <SchedulableJob>
      <ExpectedCompletionDate>0001-01-01T00:00:00</ExpectedCompletionDate>
      <ExpectedStartDate>0001-01-01T00:00:00</ExpectedStartDate>
      <IsRecurring>false</IsRecurring>
      <JobID>0</JobID>
      <JobName>String</JobName>
      <LocationCity>String</LocationCity>
      <LocationLatitude>0</LocationLatitude>
      <LocationLongitude>0</LocationLongitude>
      <LocationZip>String</LocationZip>
      <OccurrenceDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </OccurrenceDates>
      <ProjectID>0</ProjectID>
      <ProjectLocationID>0</ProjectLocationID>
      <ProjectLocationName>String</ProjectLocationName>
      <ProjectName>String</ProjectName>
      <StatusID>0</StatusID>
      <StatusName>String</StatusName>
    </SchedulableJob>
  </SchedulableJobs>
  <Workers>
    <ScheduleWorker>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <BranchName>String</BranchName>
      <ContactId>0</ContactId>
      <FirstName>String</FirstName>
      <ImageUrl>String</ImageUrl>
      <Initials>String</Initials>
      <LastName>String</LastName>
      <Name>String</Name>
      <Rate>0</Rate>
    </ScheduleWorker>
  </Workers>
  <WorkersScheduled>0</WorkersScheduled>
</WorkerScheduleResponse>