Trendsic Platform Service

<back to all web services

CourierRecurrenceSaveRequest

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 CourierRecurrenceView:
    courier_recurrence_i_d: int = 0
    courier_profile_id: int = 0
    profile_name: Optional[str] = None
    courier_facility_id: Optional[int] = None
    customer_contact_id: Optional[int] = None
    customer_name: Optional[str] = None
    customer_phone: Optional[str] = None
    address: Optional[str] = None
    unit: Optional[str] = None
    city: Optional[str] = None
    zip: Optional[str] = None
    zone: Optional[str] = None
    lat: Optional[Decimal] = None
    lng: Optional[Decimal] = None
    weekday: int = 0
    window_start: Optional[str] = None
    window_end: Optional[str] = None
    cadence: Optional[str] = None
    anchor_date: Optional[str] = None
    service_level_code: Optional[str] = None
    units_expected: int = 0
    handoff: Optional[str] = None
    instructions: Optional[str] = None
    pay_mode: Optional[str] = None
    account_code: Optional[str] = None
    paused: bool = False
    last_materialized_date: Optional[str] = None
    next_date: Optional[str] = None
    skip_dates: List[str] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierRecurrenceResponse:
    recurrences: List[CourierRecurrenceView] = field(default_factory=list)
    message: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierRecurrenceSaveRequest:
    id: Optional[int] = None
    recurrence: Optional[CourierRecurrenceView] = None

Python CourierRecurrenceSaveRequest DTOs

POST /v1/dispatch/courier/recurrences HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Id: 0,
	Recurrence: 
	{
		CourierRecurrenceID: 0,
		CourierProfileId: 0,
		ProfileName: String,
		CourierFacilityId: 0,
		CustomerContactId: 0,
		CustomerName: String,
		CustomerPhone: String,
		Address: String,
		Unit: String,
		City: String,
		Zip: String,
		Zone: String,
		Lat: 0,
		Lng: 0,
		Weekday: 0,
		WindowStart: String,
		WindowEnd: String,
		Cadence: String,
		AnchorDate: String,
		ServiceLevelCode: String,
		UnitsExpected: 0,
		Handoff: String,
		Instructions: String,
		PayMode: String,
		AccountCode: String,
		Paused: False,
		LastMaterializedDate: String,
		NextDate: String,
		SkipDates: 
		[
			String
		]
	}
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Recurrences: 
	[
		{
			CourierRecurrenceID: 0,
			CourierProfileId: 0,
			ProfileName: String,
			CourierFacilityId: 0,
			CustomerContactId: 0,
			CustomerName: String,
			CustomerPhone: String,
			Address: String,
			Unit: String,
			City: String,
			Zip: String,
			Zone: String,
			Lat: 0,
			Lng: 0,
			Weekday: 0,
			WindowStart: String,
			WindowEnd: String,
			Cadence: String,
			AnchorDate: String,
			ServiceLevelCode: String,
			UnitsExpected: 0,
			Handoff: String,
			Instructions: String,
			PayMode: String,
			AccountCode: String,
			Paused: False,
			LastMaterializedDate: String,
			NextDate: String,
			SkipDates: 
			[
				String
			]
		}
	],
	Message: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}