Trendsic Platform Service

CourierAvailabilityRequest

The following routes are available for this service:
GET,OPTIONS	/v1/dispatch/courier/profiles/{Id}/availability

**CourierAvailabilityRequest** Parameters:
Name	Parameter	Data Type	Required
Id	path	int	No
Date	query	string	No
Zip	query	string	No

**CourierAvailabilityResponse** Parameters:
Name	Parameter	Data Type	Required
Availability	form	Availability	No
Date	form	string	No
ResponseStatus	form	ResponseStatus	No

**Availability** Parameters:
Name	Parameter	Data Type	Required
InArea	form	bool	No
ZipChecked	form	bool	No
Closed	form	bool	No
Windows	form	List<Window>	No

**Window** Parameters:
Name	Parameter	Data Type	Required
Id	form	string	No
DayIx	form	int	No
StartMin	form	int	No
EndMin	form	int	No
Label	form	string	No
Asap	form	bool	No
Levels	form	List<LevelOffer>	No

**LevelOffer** Parameters:
Name	Parameter	Data Type	Required
Code	form	string	No
Name	form	string	No
Ok	form	bool	No
Why	form	string	No
Promise	form	string	No
Surcharge	form	decimal	No

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