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}

export class CourierRecurrenceView
{
    public CourierRecurrenceID: number;
    public CourierProfileId: number;
    public ProfileName: string;
    public CourierFacilityId?: number;
    public CustomerContactId?: number;
    public CustomerName: string;
    public CustomerPhone: string;
    public Address: string;
    public Unit: string;
    public City: string;
    public Zip: string;
    public Zone: string;
    public Lat?: number;
    public Lng?: number;
    public Weekday: number;
    public WindowStart: string;
    public WindowEnd: string;
    public Cadence: string;
    public AnchorDate: string;
    public ServiceLevelCode: string;
    public UnitsExpected: number;
    public Handoff: string;
    public Instructions: string;
    public PayMode: string;
    public AccountCode: string;
    public Paused: boolean;
    public LastMaterializedDate: string;
    public NextDate: string;
    public SkipDates: string[] = [];

    public constructor(init?: Partial<CourierRecurrenceView>) { (Object as any).assign(this, init); }
}

export class CourierRecurrenceResponse
{
    public Recurrences: CourierRecurrenceView[] = [];
    public Message: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CourierRecurrenceResponse>) { (Object as any).assign(this, init); }
}

export class CourierRecurrenceActionRequest
{
    public Id: number;
    public Action: string;
    public Date: string;

    public constructor(init?: Partial<CourierRecurrenceActionRequest>) { (Object as any).assign(this, init); }
}

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

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

{"Id":0,"Action":"String","Date":"String"}

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