Trendsic Platform Service

<back to all web services

CourierBookAvailabilityRequest

The following routes are available for this service:
GET,OPTIONS/v1/book/{Slug}/availability
CourierBookAvailabilityRequest Parameters:
NameParameterData TypeRequiredDescription
SlugpathstringNo
ProfilequerystringNo
ZipquerystringNo
CourierBookAvailabilityResponse Parameters:
NameParameterData TypeRequiredDescription
InAreaformboolNo
DaysformList<CourierBookDay>No
ResponseStatusformResponseStatusNo
CourierBookDay Parameters:
NameParameterData TypeRequiredDescription
DayIxformintNo
DateformstringNo
WeekdayformintNo
ClosedformboolNo
WindowsformList<Window>No
Window Parameters:
NameParameterData TypeRequiredDescription
IdformstringNo
DayIxformintNo
StartMinformintNo
EndMinformintNo
LabelformstringNo
AsapformboolNo
LevelsformList<LevelOffer>No
LevelOffer Parameters:
NameParameterData TypeRequiredDescription
CodeformstringNo
NameformstringNo
OkformboolNo
WhyformstringNo
PromiseformstringNo
SurchargeformdecimalNo

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