| GET | /v1/schedule/jobs |
|---|
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkerScheduleItem:
worker_schedule_item_i_d: int = 0
job_i_d: int = 0
project_i_d: Optional[int] = None
contact_i_d: int = 0
scheduled_date: Optional[datetime.datetime] = None
sort_order: int = 0
source_crew_i_d: Optional[int] = None
status: Optional[str] = None
started_at: Optional[datetime.datetime] = None
completed_at: Optional[datetime.datetime] = None
worker_notes: Optional[str] = None
job_name: Optional[str] = None
project_name: Optional[str] = None
first_name: Optional[str] = None
last_name: Optional[str] = None
worker_name: Optional[str] = None
source_crew_name: Optional[str] = None
project_location_i_d: Optional[int] = None
project_location_name: Optional[str] = None
location_zip: Optional[str] = None
location_city: Optional[str] = None
location_latitude: Optional[Decimal] = None
location_longitude: Optional[Decimal] = None
job_status_name: Optional[str] = None
branch_id: Optional[str] = None
branch_name: Optional[str] = None
worker_home_branch_id: Optional[str] = None
worker_home_branch_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class SchedulableJob:
job_i_d: int = 0
job_name: Optional[str] = None
project_i_d: int = 0
project_name: Optional[str] = None
status_i_d: Optional[int] = None
status_name: Optional[str] = None
project_location_i_d: Optional[int] = None
project_location_name: Optional[str] = None
location_zip: Optional[str] = None
location_city: Optional[str] = None
location_latitude: Optional[Decimal] = None
location_longitude: Optional[Decimal] = None
expected_start_date: Optional[datetime.datetime] = None
expected_completion_date: Optional[datetime.datetime] = None
is_recurring: bool = False
occurrence_dates: List[str] = field(default_factory=list)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleWorker:
contact_id: int = 0
first_name: Optional[str] = None
last_name: Optional[str] = None
name: Optional[str] = None
initials: Optional[str] = None
rate: Optional[Decimal] = None
image_url: Optional[str] = None
branch_id: Optional[str] = None
branch_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class Crew:
crew_i_d: int = 0
crew_name: Optional[str] = None
crew_number: Optional[str] = None
crew_manager_contact_i_d: int = 0
crew_manager_contact_name: Optional[str] = None
crew_color: Optional[str] = None
record_created_date: datetime.datetime = datetime.datetime(1, 1, 1)
active: bool = False
created_by_u_i_d: Optional[str] = None
project_i_d: int = 0
crew_member_count: int = 0
project_crew_i_d: int = 0
project_name: Optional[str] = None
branch_id: Optional[str] = None
branch_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleLastAssignment:
job_i_d: int = 0
contact_ids: List[int] = field(default_factory=list)
source_crew_i_d: Optional[int] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleAutoFillResult:
jobs_filled: int = 0
jobs_skipped: int = 0
visits_scheduled: int = 0
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class WorkerScheduleResponse:
items: List[WorkerScheduleItem] = field(default_factory=list)
schedulable_jobs: List[SchedulableJob] = field(default_factory=list)
workers: List[ScheduleWorker] = field(default_factory=list)
crews: List[Crew] = field(default_factory=list)
budgeted_crew: List[ScheduleWorker] = field(default_factory=list)
last_assignment: Optional[ScheduleLastAssignment] = None
auto_fill: Optional[ScheduleAutoFillResult] = None
dates_scheduled: Optional[int] = None
workers_scheduled: Optional[int] = None
items_removed: Optional[int] = None
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class ScheduleJobsRequest:
project_i_d: int = 0
from_date: Optional[str] = None
to_date: Optional[str] = None
show_all: bool = False
show_completed: bool = False
Python ScheduleJobsRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
GET /v1/schedule/jobs HTTP/1.1 Host: api.dev.dynamics.trendsic.com Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Items:
[
{
WorkerScheduleItemID: 0,
JobID: 0,
ProjectID: 0,
ContactID: 0,
ScheduledDate: 0001-01-01,
SortOrder: 0,
SourceCrewID: 0,
Status: String,
StartedAt: 0001-01-01,
CompletedAt: 0001-01-01,
WorkerNotes: String,
JobName: String,
ProjectName: String,
FirstName: String,
LastName: String,
WorkerName: String,
SourceCrewName: String,
ProjectLocationID: 0,
ProjectLocationName: String,
LocationZip: String,
LocationCity: String,
LocationLatitude: 0,
LocationLongitude: 0,
JobStatusName: String,
BranchId: 00000000000000000000000000000000,
BranchName: String,
WorkerHomeBranchId: 00000000000000000000000000000000,
WorkerHomeBranchName: String
}
],
SchedulableJobs:
[
{
JobID: 0,
JobName: String,
ProjectID: 0,
ProjectName: String,
StatusID: 0,
StatusName: String,
ProjectLocationID: 0,
ProjectLocationName: String,
LocationZip: String,
LocationCity: String,
LocationLatitude: 0,
LocationLongitude: 0,
ExpectedStartDate: 0001-01-01,
ExpectedCompletionDate: 0001-01-01,
IsRecurring: False,
OccurrenceDates:
[
String
]
}
],
Workers:
[
{
ContactId: 0,
FirstName: String,
LastName: String,
Name: String,
Initials: String,
Rate: 0,
ImageUrl: String,
BranchId: 00000000000000000000000000000000,
BranchName: String
}
],
Crews:
[
{
CrewID: 0,
CrewName: String,
CrewNumber: String,
CrewManagerContactID: 0,
CrewManagerContactName: String,
CrewColor: String,
RecordCreatedDate: 0001-01-01,
Active: False,
CreatedByUID: 00000000000000000000000000000000,
ProjectID: 0,
CrewMemberCount: 0,
ProjectCrewID: 0,
ProjectName: String,
BranchId: 00000000000000000000000000000000,
BranchName: String
}
],
BudgetedCrew:
[
{
ContactId: 0,
FirstName: String,
LastName: String,
Name: String,
Initials: String,
Rate: 0,
ImageUrl: String,
BranchId: 00000000000000000000000000000000,
BranchName: String
}
],
LastAssignment:
{
JobID: 0,
ContactIds:
[
0
],
SourceCrewID: 0
},
AutoFill:
{
JobsFilled: 0,
JobsSkipped: 0,
VisitsScheduled: 0
},
DatesScheduled: 0,
WorkersScheduled: 0,
ItemsRemoved: 0,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}