Trendsic Platform Service

DispatchLoadsRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/loads

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 DispatchLoadStageView:
    stage: Optional[str] = None
    at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    note: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchLoadView:
    load_id: int = 0
    code: Optional[str] = None
    module: Optional[str] = None
    truck_label: Optional[str] = None
    driver_label: Optional[str] = None
    carrier_label: Optional[str] = None
    source_label: Optional[str] = None
    destination_label: Optional[str] = None
    qty: Optional[Decimal] = None
    unit: Optional[str] = None
    qty_text: Optional[str] = None
    ticket_code: Optional[str] = None
    rate_applied: Optional[Decimal] = None
    rate_basis: Optional[str] = None
    revenue: Optional[Decimal] = None
    pay_plan_label: Optional[str] = None
    pay: Optional[Decimal] = None
    status: Optional[str] = None
    opened_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    closed_utc: Optional[datetime.datetime] = None
    photos: int = 0
    stages: List[DispatchLoadStageView] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchLoadsResponse:
    loads: List[DispatchLoadView] = field(default_factory=list)
    hours: int = 0
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchLoadsRequest:
    hours: int = 0
    module: Optional[str] = None

Python DispatchLoadsRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/dispatch/loads HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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

{
	Loads: 
	[
		{
			LoadId: 0,
			Code: String,
			Module: String,
			TruckLabel: String,
			DriverLabel: String,
			CarrierLabel: String,
			SourceLabel: String,
			DestinationLabel: String,
			Qty: 0,
			Unit: String,
			QtyText: String,
			TicketCode: String,
			RateApplied: 0,
			RateBasis: String,
			Revenue: 0,
			PayPlanLabel: String,
			Pay: 0,
			Status: String,
			OpenedUtc: 0001-01-01,
			ClosedUtc: 0001-01-01,
			Photos: 0,
			Stages: 
			[
				{
					Stage: String,
					AtUtc: 0001-01-01,
					Note: String
				}
			]
		}
	],
	Hours: 0,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}