Trendsic Platform Service

<back to all web services

CourierRecurrenceSaveRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/dispatch/courier/recurrences
PUT,OPTIONS/v1/dispatch/courier/recurrences/{Id}
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 CourierRecurrenceView() = 
        member val CourierRecurrenceID:Int32 = new Int32() with get,set
        member val CourierProfileId:Int32 = new Int32() with get,set
        member val ProfileName:String = null with get,set
        member val CourierFacilityId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CustomerContactId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CustomerName:String = null with get,set
        member val CustomerPhone:String = null with get,set
        member val Address:String = null with get,set
        member val Unit:String = null with get,set
        member val City:String = null with get,set
        member val Zip:String = null with get,set
        member val Zone:String = null with get,set
        member val Lat:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Lng:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Weekday:Int32 = new Int32() with get,set
        member val WindowStart:String = null with get,set
        member val WindowEnd:String = null with get,set
        member val Cadence:String = null with get,set
        member val AnchorDate:String = null with get,set
        member val ServiceLevelCode:String = null with get,set
        member val UnitsExpected:Int32 = new Int32() with get,set
        member val Handoff:String = null with get,set
        member val Instructions:String = null with get,set
        member val PayMode:String = null with get,set
        member val AccountCode:String = null with get,set
        member val Paused:Boolean = new Boolean() with get,set
        member val LastMaterializedDate:String = null with get,set
        member val NextDate:String = null with get,set
        member val SkipDates:ResizeArray<String> = new ResizeArray<String>() with get,set

    [<AllowNullLiteral>]
    type CourierRecurrenceResponse() = 
        member val Recurrences:ResizeArray<CourierRecurrenceView> = new ResizeArray<CourierRecurrenceView>() with get,set
        member val Message:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CourierRecurrenceSaveRequest() = 
        member val Id:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Recurrence:CourierRecurrenceView = null with get,set

F# CourierRecurrenceSaveRequest 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.

POST /v1/dispatch/courier/recurrences HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsonl
Content-Type: text/jsonl
Content-Length: length

{"Id":0,"Recurrence":{"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"]}}

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