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

export class CourierPayLineView
{
    public DispatchLoadID: number;
    public Kind: string;
    public Label: string;
    public Qty?: number;
    public Rate?: number;
    public Amount: number;

    public constructor(init?: Partial<CourierPayLineView>) { (Object as any).assign(this, init); }
}

export class CourierDriverPayRow
{
    public DispatchLoadID: number;
    public Code: string;
    public Kind: string;
    public OrderCode: string;
    public RunCode: string;
    public QtyText: string;
    public SourceLabel: string;
    public DestinationLabel: string;
    public Status: string;
    public Pay?: number;
    public OpenedUtc?: string;
    public ClosedUtc?: string;
    public Lines: CourierPayLineView[] = [];

    public constructor(init?: Partial<CourierDriverPayRow>) { (Object as any).assign(this, init); }
}

export class CourierDriverPayResponse
{
    public Rows: CourierDriverPayRow[] = [];
    public Total: number;
    public Available: boolean;
    public ServerUtc: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CourierDriverPayResponse>) { (Object as any).assign(this, init); }
}

export class CourierDriverPayRequest
{

    public constructor(init?: Partial<CourierDriverPayRequest>) { (Object as any).assign(this, init); }
}

TypeScript CourierDriverPayRequest DTOs

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

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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-01T00:00:00.0000000","ClosedUtc":"0001-01-01T00:00:00.0000000","Lines":[{"DispatchLoadID":0,"Kind":"String","Label":"String","Qty":0,"Rate":0,"Amount":0}]}],"Total":0,"Available":false,"ServerUtc":"0001-01-01T00:00:00.0000000","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}