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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CourierPayLineView() = 
        member val DispatchLoadID:Int32 = new Int32() with get,set
        member val Kind:String = null with get,set
        member val Label:String = null with get,set
        member val Qty:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Rate:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Amount:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type CourierDriverPayRow() = 
        member val DispatchLoadID:Int32 = new Int32() with get,set
        member val Code:String = null with get,set
        member val Kind:String = null with get,set
        member val OrderCode:String = null with get,set
        member val RunCode:String = null with get,set
        member val QtyText:String = null with get,set
        member val SourceLabel:String = null with get,set
        member val DestinationLabel:String = null with get,set
        member val Status:String = null with get,set
        member val Pay:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OpenedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val ClosedUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Lines:ResizeArray<CourierPayLineView> = new ResizeArray<CourierPayLineView>() with get,set

    [<AllowNullLiteral>]
    type CourierDriverPayResponse() = 
        member val Rows:ResizeArray<CourierDriverPayRow> = new ResizeArray<CourierDriverPayRow>() with get,set
        member val Total:Decimal = new Decimal() with get,set
        member val Available:Boolean = new Boolean() with get,set
        member val ServerUtc:DateTime = new DateTime() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CourierDriverPayRequest() = 
        class end

F# 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
		}
	}
}