Trendsic Platform Service

<back to all web services

CourierBookPageRequest

The following routes are available for this service:
GET,OPTIONS/v1/book/{Slug}
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 CourierTrackBusiness() = 
        member val Name:String = null with get,set
        member val Phone:String = null with get,set

    [<AllowNullLiteral>]
    type CourierBookLevel() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Ready:String = null with get,set
        member val WithinMin:Int32 = new Int32() with get,set
        member val InBy:String = null with get,set
        member val Surcharge:Decimal = new Decimal() with get,set
        member val Days:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val DeadlineMin:Nullable<Int32> = new Nullable<Int32>() with get,set

    [<AllowNullLiteral>]
    type HandoffOptions() = 
        member val Hand:Boolean = new Boolean() with get,set
        member val Porch:Boolean = new Boolean() with get,set
        member val Desk:Boolean = new Boolean() with get,set
        member val SigRequired:Boolean = new Boolean() with get,set
        member val IdRequired:Boolean = new Boolean() with get,set
        member val CodeRequired:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CourierBookProfile() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Shape:String = null with get,set
        member val Template:String = null with get,set
        member val UnitOne:String = null with get,set
        member val UnitMany:String = null with get,set
        member val UnitOneEs:String = null with get,set
        member val UnitManyEs:String = null with get,set
        member val FacilityNoun:String = null with get,set
        member val FacilityNounEs:String = null with get,set
        member val FacilityName:String = null with get,set
        member val Levels:ResizeArray<CourierBookLevel> = new ResizeArray<CourierBookLevel>() with get,set
        member val Asap:Boolean = new Boolean() with get,set
        member val Recurring:Boolean = new Boolean() with get,set
        member val PayTiming:String = null with get,set
        member val FinalAfterCount:Boolean = new Boolean() with get,set
        member val CancelFee:Decimal = new Decimal() with get,set
        member val MissedFee:Decimal = new Decimal() with get,set
        member val MissedWaitMin:Int32 = new Int32() with get,set
        member val ServiceArea:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Zips:ResizeArray<String> = new ResizeArray<String>() with get,set
        member val Handoffs:HandoffOptions = null with get,set

    [<AllowNullLiteral>]
    type CourierBookProfileLink() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Shape:String = null with get,set

    [<AllowNullLiteral>]
    type CourierBookPageView() = 
        member val Available:Boolean = new Boolean() with get,set
        member val BookingOn:Boolean = new Boolean() with get,set
        member val Business:CourierTrackBusiness = null with get,set
        member val Profile:CourierBookProfile = null with get,set
        member val Profiles:ResizeArray<CourierBookProfileLink> = new ResizeArray<CourierBookProfileLink>() with get,set
        member val CardEnabled:Boolean = new Boolean() with get,set
        member val PublishableKey:String = null with get,set
        member val AppUrl:String = null with get,set
        member val Today:String = null with get,set
        member val Weekday:Int32 = new Int32() with get,set
        member val NowMin:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CourierBookPageResponse() = 
        member val Page:CourierBookPageView = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CourierBookPageRequest() = 
        member val Slug:String = null with get,set
        member val Profile:String = null with get,set

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

{
	Page: 
	{
		Available: False,
		BookingOn: False,
		Business: 
		{
			Name: String,
			Phone: String
		},
		Profile: 
		{
			Code: String,
			Name: String,
			Shape: String,
			Template: String,
			UnitOne: String,
			UnitMany: String,
			UnitOneEs: String,
			UnitManyEs: String,
			FacilityNoun: String,
			FacilityNounEs: String,
			FacilityName: String,
			Levels: 
			[
				{
					Code: String,
					Name: String,
					Ready: String,
					WithinMin: 0,
					InBy: String,
					Surcharge: 0,
					Days: 
					[
						0
					],
					DeadlineMin: 0
				}
			],
			Asap: False,
			Recurring: False,
			PayTiming: String,
			FinalAfterCount: False,
			CancelFee: 0,
			MissedFee: 0,
			MissedWaitMin: 0,
			ServiceArea: 
			[
				String
			],
			Zips: 
			[
				String
			],
			Handoffs: 
			{
				Hand: False,
				Porch: False,
				Desk: False,
				SigRequired: False,
				IdRequired: False,
				CodeRequired: False
			}
		},
		Profiles: 
		[
			{
				Code: String,
				Name: String,
				Shape: String
			}
		],
		CardEnabled: False,
		PublishableKey: String,
		AppUrl: String,
		Today: String,
		Weekday: 0,
		NowMin: 0
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}