Trendsic Platform Service

CourierAvailabilityRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/courier/profiles/{Id}/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 Availability
{
    public InArea: boolean;
    public ZipChecked: boolean;
    public Closed: boolean;
    public Windows: Window[] = [];

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

export class CourierAvailabilityResponse
{
    public Availability: Availability;
    public Date: string;
    public ResponseStatus: ResponseStatus;

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

export class CourierAvailabilityRequest
{
    public Id: number;
    public Date: string;
    public Zip: string;

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

TypeScript CourierAvailabilityRequest 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/courier/profiles/{Id}/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

{
	Availability: 
	{
		InArea: False,
		ZipChecked: False,
		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
					}
				]
			}
		]
	},
	Date: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}