Trendsic Platform Service

<back to all web services

CourierDriverPayRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/worker/dispatch/od/pay
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 CourierPayLineView:
    dispatch_load_i_d: int = 0
    kind: Optional[str] = None
    label: Optional[str] = None
    qty: Optional[Decimal] = None
    rate: Optional[Decimal] = None
    amount: Decimal = decimal.Decimal(0)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierDriverPayRow:
    dispatch_load_i_d: int = 0
    code: Optional[str] = None
    kind: Optional[str] = None
    order_code: Optional[str] = None
    run_code: Optional[str] = None
    qty_text: Optional[str] = None
    source_label: Optional[str] = None
    destination_label: Optional[str] = None
    status: Optional[str] = None
    pay: Optional[Decimal] = None
    opened_utc: Optional[datetime.datetime] = None
    closed_utc: Optional[datetime.datetime] = None
    lines: List[CourierPayLineView] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierDriverPayResponse:
    rows: List[CourierDriverPayRow] = field(default_factory=list)
    total: Decimal = decimal.Decimal(0)
    available: bool = False
    server_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CourierDriverPayRequest:
    pass

Python CourierDriverPayRequest 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/worker/dispatch/od/pay HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Rows: 
	[
		{
			DispatchLoadID: 0,
			Code: String,
			Kind: String,
			OrderCode: String,
			RunCode: String,
			QtyText: String,
			SourceLabel: String,
			DestinationLabel: String,
			Status: String,
			Pay: 0,
			OpenedUtc: 0001-01-01,
			ClosedUtc: 0001-01-01,
			Lines: 
			[
				{
					DispatchLoadID: 0,
					Kind: String,
					Label: String,
					Qty: 0,
					Rate: 0,
					Amount: 0
				}
			]
		}
	],
	Total: 0,
	Available: False,
	ServerUtc: 0001-01-01,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}