Trendsic Platform Service

<back to all web services

CourierBookAvailabilityRequest

The following routes are available for this service:
GET,OPTIONS/v1/book/{Slug}/availability

export class LevelOffer
{
    public Code: string;
    public Name: string;
    public Ok: boolean;
    public Why: string;
    public Promise: string;
    public Surcharge: number;

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

export class Window
{
    public Id: string;
    public DayIx: number;
    public StartMin: number;
    public EndMin: number;
    public Label: string;
    public Asap: boolean;
    public Levels: LevelOffer[] = [];

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

export class CourierBookDay
{
    public DayIx: number;
    public Date: string;
    public Weekday: number;
    public Closed: boolean;
    public Windows: Window[] = [];

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

export class CourierBookAvailabilityResponse
{
    public InArea: boolean;
    public Days: CourierBookDay[] = [];
    public ResponseStatus: ResponseStatus;

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

export class CourierBookAvailabilityRequest
{
    public Slug: string;
    public Profile: string;
    public Zip: string;

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

TypeScript CourierBookAvailabilityRequest 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}/availability HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	InArea: False,
	Days: 
	[
		{
			DayIx: 0,
			Date: String,
			Weekday: 0,
			Closed: False,
			Windows: 
			[
				{
					Id: String,
					DayIx: 0,
					StartMin: 0,
					EndMin: 0,
					Label: String,
					Asap: False,
					Levels: 
					[
						{
							Code: String,
							Name: String,
							Ok: False,
							Why: String,
							Promise: String,
							Surcharge: 0
						}
					]
				}
			]
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}