Trendsic Platform Service

RoutePlanWeekRequest

The following routes are available for this service:
GET,OPTIONS	/v1/routeplan/week

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 RoutePlanCrew:
    crew_i_d: int = 0
    crew_name: Optional[str] = None
    crew_color: Optional[str] = None
    home_zip: Optional[str] = None
    yard_lat: Optional[float] = None
    yard_lng: Optional[float] = None
    daily_capacity_min: int = 0
    weekly_capacity_min: int = 0
    specialist: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RoutePlanVisit:
    agreement_i_d: int = 0
    agreement_job_i_d: Optional[int] = None
    name: Optional[str] = None
    sub: Optional[str] = None
    service_type: Optional[str] = None
    zip: Optional[str] = None
    area: Optional[str] = None
    lat: Optional[float] = None
    lng: Optional[float] = None
    duration_min: int = 0
    due_iso: Optional[str] = None
    due_label: Optional[str] = None
    overdue: bool = False
    default_crew_i_d: Optional[int] = None
    route_crew_i_d: Optional[int] = None
    route_seq: Optional[int] = None
    route_date_iso: Optional[str] = None
    late_days: int = 0
    auto_pay: bool = False
    skip_policy: Optional[str] = None
    skip_credit_amount: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RoutePlanSkippedVisit:
    agreement_job_i_d: int = 0
    agreement_i_d: int = 0
    name: Optional[str] = None
    date_iso: Optional[str] = None
    reason: Optional[str] = None
    credit_amount: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RoutePlanWeekResponse:
    from_iso: Optional[str] = None
    to_iso: Optional[str] = None
    crews: List[RoutePlanCrew] = field(default_factory=list)
    visits: List[RoutePlanVisit] = field(default_factory=list)
    skipped: List[RoutePlanSkippedVisit] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class RoutePlanWeekRequest:
    from_: Optional[str] = field(metadata=config(field_name='from'), default=None)

Python RoutePlanWeekRequest 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/routeplan/week HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<RoutePlanWeekResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Crews>
    <RoutePlanCrew>
      <CrewColor>String</CrewColor>
      <CrewID>0</CrewID>
      <CrewName>String</CrewName>
      <DailyCapacityMin>0</DailyCapacityMin>
      <HomeZip>String</HomeZip>
      <Specialist>false</Specialist>
      <WeeklyCapacityMin>0</WeeklyCapacityMin>
      <YardLat>0</YardLat>
      <YardLng>0</YardLng>
    </RoutePlanCrew>
  </Crews>
  <FromIso>String</FromIso>
  <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>
  <Skipped>
    <RoutePlanSkippedVisit>
      <AgreementID>0</AgreementID>
      <AgreementJobID>0</AgreementJobID>
      <CreditAmount>0</CreditAmount>
      <DateIso>String</DateIso>
      <Name>String</Name>
      <Reason>String</Reason>
    </RoutePlanSkippedVisit>
  </Skipped>
  <ToIso>String</ToIso>
  <Visits>
    <RoutePlanVisit>
      <AgreementID>0</AgreementID>
      <AgreementJobID>0</AgreementJobID>
      <Area>String</Area>
      <AutoPay>false</AutoPay>
      <DefaultCrewID>0</DefaultCrewID>
      <DueIso>String</DueIso>
      <DueLabel>String</DueLabel>
      <DurationMin>0</DurationMin>
      <Lat>0</Lat>
      <LateDays>0</LateDays>
      <Lng>0</Lng>
      <Name>String</Name>
      <Overdue>false</Overdue>
      <RouteCrewID>0</RouteCrewID>
      <RouteDateIso>String</RouteDateIso>
      <RouteSeq>0</RouteSeq>
      <ServiceType>String</ServiceType>
      <SkipCreditAmount>0</SkipCreditAmount>
      <SkipPolicy>String</SkipPolicy>
      <Sub>String</Sub>
      <Zip>String</Zip>
    </RoutePlanVisit>
  </Visits>
</RoutePlanWeekResponse>