Trendsic Platform Service

<back to all web services

CourierBookAvailabilityRequest

The following routes are available for this service:
GET,OPTIONS/v1/book/{Slug}/availability
"use strict";
export class LevelOffer {
    /** @param {{Code?:string,Name?:string,Ok?:boolean,Why?:string,Promise?:string,Surcharge?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Code;
    /** @type {string} */
    Name;
    /** @type {boolean} */
    Ok;
    /** @type {string} */
    Why;
    /** @type {string} */
    Promise;
    /** @type {number} */
    Surcharge;
}
export class Window {
    /** @param {{Id?:string,DayIx?:number,StartMin?:number,EndMin?:number,Label?:string,Asap?:boolean,Levels?:LevelOffer[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Id;
    /** @type {number} */
    DayIx;
    /** @type {number} */
    StartMin;
    /** @type {number} */
    EndMin;
    /** @type {string} */
    Label;
    /** @type {boolean} */
    Asap;
    /** @type {LevelOffer[]} */
    Levels = [];
}
export class CourierBookDay {
    /** @param {{DayIx?:number,Date?:string,Weekday?:number,Closed?:boolean,Windows?:Window[]}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    DayIx;
    /** @type {string} */
    Date;
    /** @type {number} */
    Weekday;
    /** @type {boolean} */
    Closed;
    /** @type {Window[]} */
    Windows = [];
}
export class CourierBookAvailabilityResponse {
    /** @param {{InArea?:boolean,Days?:CourierBookDay[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {boolean} */
    InArea;
    /** @type {CourierBookDay[]} */
    Days = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class CourierBookAvailabilityRequest {
    /** @param {{Slug?:string,Profile?:string,Zip?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Slug;
    /** @type {string} */
    Profile;
    /** @type {string} */
    Zip;
}

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