Trendsic Platform Service

<back to all web services

CourierBookPageRequest

The following routes are available for this service:
GET,OPTIONS/v1/book/{Slug}
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CourierBookPageRequest
{
    open var Slug:String? = null
    open var Profile:String? = null
}

open class CourierBookPageResponse
{
    open var Page:CourierBookPageView? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CourierBookPageView
{
    open var Available:Boolean? = null
    open var BookingOn:Boolean? = null
    open var Business:CourierTrackBusiness? = null
    open var Profile:CourierBookProfile? = null
    open var Profiles:ArrayList<CourierBookProfileLink> = ArrayList<CourierBookProfileLink>()
    open var CardEnabled:Boolean? = null
    open var PublishableKey:String? = null
    open var AppUrl:String? = null
    open var Today:String? = null
    open var Weekday:Int? = null
    open var NowMin:Int? = null
}

open class CourierTrackBusiness
{
    open var Name:String? = null
    open var Phone:String? = null
}

open class CourierBookProfile
{
    open var Code:String? = null
    open var Name:String? = null
    open var Shape:String? = null
    open var Template:String? = null
    open var UnitOne:String? = null
    open var UnitMany:String? = null
    open var UnitOneEs:String? = null
    open var UnitManyEs:String? = null
    open var FacilityNoun:String? = null
    open var FacilityNounEs:String? = null
    open var FacilityName:String? = null
    open var Levels:ArrayList<CourierBookLevel> = ArrayList<CourierBookLevel>()
    open var Asap:Boolean? = null
    open var Recurring:Boolean? = null
    open var PayTiming:String? = null
    open var FinalAfterCount:Boolean? = null
    open var CancelFee:BigDecimal? = null
    open var MissedFee:BigDecimal? = null
    open var MissedWaitMin:Int? = null
    open var ServiceArea:ArrayList<String> = ArrayList<String>()
    open var Zips:ArrayList<String> = ArrayList<String>()
    open var Handoffs:HandoffOptions? = null
}

open class CourierBookLevel
{
    open var Code:String? = null
    open var Name:String? = null
    open var Ready:String? = null
    open var WithinMin:Int? = null
    open var InBy:String? = null
    open var Surcharge:BigDecimal? = null
    open var Days:ArrayList<Int> = ArrayList<Int>()
    open var DeadlineMin:Int? = null
}

open class HandoffOptions
{
    open var Hand:Boolean? = null
    open var Porch:Boolean? = null
    open var Desk:Boolean? = null
    open var SigRequired:Boolean? = null
    open var IdRequired:Boolean? = null
    open var CodeRequired:Boolean? = null
}

open class CourierBookProfileLink
{
    open var Code:String? = null
    open var Name:String? = null
    open var Shape:String? = null
}

Kotlin CourierBookPageRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/book/{Slug} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"Page":{"Available":false,"BookingOn":false,"Business":{"Name":"String","Phone":"String"},"Profile":{"Code":"String","Name":"String","Shape":"String","Template":"String","UnitOne":"String","UnitMany":"String","UnitOneEs":"String","UnitManyEs":"String","FacilityNoun":"String","FacilityNounEs":"String","FacilityName":"String","Levels":[{"Code":"String","Name":"String","Ready":"String","WithinMin":0,"InBy":"String","Surcharge":0,"Days":[0],"DeadlineMin":0}],"Asap":false,"Recurring":false,"PayTiming":"String","FinalAfterCount":false,"CancelFee":0,"MissedFee":0,"MissedWaitMin":0,"ServiceArea":["String"],"Zips":["String"],"Handoffs":{"Hand":false,"Porch":false,"Desk":false,"SigRequired":false,"IdRequired":false,"CodeRequired":false}},"Profiles":[{"Code":"String","Name":"String","Shape":"String"}],"CardEnabled":false,"PublishableKey":"String","AppUrl":"String","Today":"String","Weekday":0,"NowMin":0},"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}