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
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type LevelOffer() = 
        member val Code:String = null with get,set
        member val Name:String = null with get,set
        member val Ok:Boolean = new Boolean() with get,set
        member val Why:String = null with get,set
        member val Promise:String = null with get,set
        member val Surcharge:Decimal = new Decimal() with get,set

    [<AllowNullLiteral>]
    type Window() = 
        member val Id:String = null with get,set
        member val DayIx:Int32 = new Int32() with get,set
        member val StartMin:Int32 = new Int32() with get,set
        member val EndMin:Int32 = new Int32() with get,set
        member val Label:String = null with get,set
        member val Asap:Boolean = new Boolean() with get,set
        member val Levels:ResizeArray<LevelOffer> = new ResizeArray<LevelOffer>() with get,set

    [<AllowNullLiteral>]
    type Availability() = 
        member val InArea:Boolean = new Boolean() with get,set
        member val ZipChecked:Boolean = new Boolean() with get,set
        member val Closed:Boolean = new Boolean() with get,set
        member val Windows:ResizeArray<Window> = new ResizeArray<Window>() with get,set

    [<AllowNullLiteral>]
    type CourierAvailabilityResponse() = 
        member val Availability:Availability = null with get,set
        member val Date:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CourierAvailabilityRequest() = 
        member val Id:Int32 = new Int32() with get,set
        member val Date:String = null with get,set
        member val Zip:String = null with get,set

F# CourierAvailabilityRequest DTOs

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

HTTP + CSV

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