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
"use strict";
export class CourierPayLineView {
    /** @param {{DispatchLoadID?:number,Kind?:string,Label?:string,Qty?:number,Rate?:number,Amount?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DispatchLoadID;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Label;
    /** @type {?number} */
    Qty;
    /** @type {?number} */
    Rate;
    /** @type {number} */
    Amount;
}
export class CourierDriverPayRow {
    /** @param {{DispatchLoadID?:number,Code?:string,Kind?:string,OrderCode?:string,RunCode?:string,QtyText?:string,SourceLabel?:string,DestinationLabel?:string,Status?:string,Pay?:number,OpenedUtc?:string,ClosedUtc?:string,Lines?:CourierPayLineView[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DispatchLoadID;
    /** @type {string} */
    Code;
    /** @type {string} */
    Kind;
    /** @type {string} */
    OrderCode;
    /** @type {string} */
    RunCode;
    /** @type {string} */
    QtyText;
    /** @type {string} */
    SourceLabel;
    /** @type {string} */
    DestinationLabel;
    /** @type {string} */
    Status;
    /** @type {?number} */
    Pay;
    /** @type {?string} */
    OpenedUtc;
    /** @type {?string} */
    ClosedUtc;
    /** @type {CourierPayLineView[]} */
    Lines = [];
}
export class CourierDriverPayResponse {
    /** @param {{Rows?:CourierDriverPayRow[],Total?:number,Available?:boolean,ServerUtc?:string,ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {CourierDriverPayRow[]} */
    Rows = [];
    /** @type {number} */
    Total;
    /** @type {boolean} */
    Available;
    /** @type {string} */
    ServerUtc;
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CourierDriverPayRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript 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
		}
	}
}