Trendsic Platform Service

<back to all web services

DispatchPickupPageRequest

The following routes are available for this service:
GET,OPTIONS/v1/dispatch/public/pickup/{SchedulerUrl}
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 DispatchZoneView() = 
        member val Zone:String = null with get,set
        member val Base:Decimal = new Decimal() with get,set
        member val PerBag:Decimal = new Decimal() with get,set
        member val PremiumUpliftPct:Decimal = new Decimal() with get,set
        member val Drivers:Int32 = new Int32() with get,set
        member val IdleDrivers:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type DispatchNeedView() = 
        member val Id:String = null with get,set
        member val Label:String = null with get,set
        member val Sub:String = null with get,set

    [<AllowNullLiteral>]
    type DispatchPickupPageResponse() = 
        member val CompanyName:String = null with get,set
        member val Zones:ResizeArray<DispatchZoneView> = new ResizeArray<DispatchZoneView>() with get,set
        member val Needs:ResizeArray<DispatchNeedView> = new ResizeArray<DispatchNeedView>() with get,set
        member val CardEnabled:Boolean = new Boolean() with get,set
        member val PublishableKey:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type DispatchPickupPageRequest() = 
        member val SchedulerUrl:String = null with get,set

F# DispatchPickupPageRequest 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/public/pickup/{SchedulerUrl} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	CompanyName: String,
	Zones: 
	[
		{
			Zone: String,
			Base: 0,
			PerBag: 0,
			PremiumUpliftPct: 0,
			Drivers: 0,
			IdleDrivers: 0
		}
	],
	Needs: 
	[
		{
			Id: String,
			Label: String,
			Sub: String
		}
	],
	CardEnabled: False,
	PublishableKey: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}