Trendsic Platform Service

CourierAvailabilityRequest

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

import Foundation
import ServiceStack

public class CourierAvailabilityRequest : Codable
{
    public var id:Int
    public var date:String
    public var zip:String

    required public init(){}
}

public class CourierAvailabilityResponse : Codable
{
    public var availability:Availability
    public var date:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class Availability : Codable
{
    public var inArea:Bool
    public var zipChecked:Bool
    public var closed:Bool
    public var windows:[Window] = []

    required public init(){}
}

public class Window : Codable
{
    public var id:String
    public var dayIx:Int
    public var startMin:Int
    public var endMin:Int
    public var label:String
    public var asap:Bool
    public var levels:[LevelOffer] = []

    required public init(){}
}

public class LevelOffer : Codable
{
    public var code:String
    public var name:String
    public var ok:Bool
    public var why:String
    public var promise:String
    public var surcharge:Double

    required public init(){}
}

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