Trendsic Platform Service

<back to all web services

CourierRecurrenceActionRequest

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


open class CourierRecurrenceActionRequest
{
    open var Id:Int? = null
    open var Action:String? = null
    open var Date:String? = null
}

open class CourierRecurrenceResponse
{
    open var Recurrences:ArrayList<CourierRecurrenceView> = ArrayList<CourierRecurrenceView>()
    open var Message:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CourierRecurrenceView
{
    open var CourierRecurrenceID:Int? = null
    open var CourierProfileId:Int? = null
    open var ProfileName:String? = null
    open var CourierFacilityId:Int? = null
    open var CustomerContactId:Int? = null
    open var CustomerName:String? = null
    open var CustomerPhone:String? = null
    open var Address:String? = null
    open var Unit:String? = null
    open var City:String? = null
    open var Zip:String? = null
    open var Zone:String? = null
    open var Lat:BigDecimal? = null
    open var Lng:BigDecimal? = null
    open var Weekday:Int? = null
    open var WindowStart:String? = null
    open var WindowEnd:String? = null
    open var Cadence:String? = null
    open var AnchorDate:String? = null
    open var ServiceLevelCode:String? = null
    open var UnitsExpected:Int? = null
    open var Handoff:String? = null
    open var Instructions:String? = null
    open var PayMode:String? = null
    open var AccountCode:String? = null
    open var Paused:Boolean? = null
    open var LastMaterializedDate:String? = null
    open var NextDate:String? = null
    open var SkipDates:ArrayList<String> = ArrayList<String>()
}

Kotlin CourierRecurrenceActionRequest 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.

POST /v1/dispatch/courier/recurrences/{Id}/{Action} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
Content-Type: text/csv
Content-Length: length

{"Id":0,"Action":"String","Date":"String"}
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Recurrences":[{"CourierRecurrenceID":0,"CourierProfileId":0,"ProfileName":"String","CourierFacilityId":0,"CustomerContactId":0,"CustomerName":"String","CustomerPhone":"String","Address":"String","Unit":"String","City":"String","Zip":"String","Zone":"String","Lat":0,"Lng":0,"Weekday":0,"WindowStart":"String","WindowEnd":"String","Cadence":"String","AnchorDate":"String","ServiceLevelCode":"String","UnitsExpected":0,"Handoff":"String","Instructions":"String","PayMode":"String","AccountCode":"String","Paused":false,"LastMaterializedDate":"String","NextDate":"String","SkipDates":["String"]}],"Message":"String","ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}