Trendsic Platform Service

<back to all web services

CourierAvailabilityRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/courier/profiles/{Id}/availability
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CourierAvailabilityRequest
{
    open var Id:Int? = null
    open var Date:String? = null
    open var Zip:String? = null
}

open class CourierAvailabilityResponse
{
    open var Availability:Availability? = null
    open var Date:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class Availability
{
    open var InArea:Boolean? = null
    open var ZipChecked:Boolean? = null
    open var Closed:Boolean? = null
    open var Windows:ArrayList<Window> = ArrayList<Window>()
}

open class Window
{
    open var Id:String? = null
    open var DayIx:Int? = null
    open var StartMin:Int? = null
    open var EndMin:Int? = null
    open var Label:String? = null
    open var Asap:Boolean? = null
    open var Levels:ArrayList<LevelOffer> = ArrayList<LevelOffer>()
}

open class LevelOffer
{
    open var Code:String? = null
    open var Name:String? = null
    open var Ok:Boolean? = null
    open var Why:String? = null
    open var Promise:String? = null
    open var Surcharge:BigDecimal? = null
}

Kotlin CourierAvailabilityRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .other suffix or ?format=other

HTTP + OTHER

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/jsonl
HTTP/1.1 200 OK
Content-Type: text/jsonl
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"}}}