| POST,OPTIONS | /v1/dispatch/courier/recurrences/{Id}/{Action} |
|---|
"use strict";
export class CourierRecurrenceView {
/** @param {{CourierRecurrenceID?:number,CourierProfileId?:number,ProfileName?:string,CourierFacilityId?:number,CustomerContactId?:number,CustomerName?:string,CustomerPhone?:string,Address?:string,Unit?:string,City?:string,Zip?:string,Zone?:string,Lat?:number,Lng?:number,Weekday?:number,WindowStart?:string,WindowEnd?:string,Cadence?:string,AnchorDate?:string,ServiceLevelCode?:string,UnitsExpected?:number,Handoff?:string,Instructions?:string,PayMode?:string,AccountCode?:string,Paused?:boolean,LastMaterializedDate?:string,NextDate?:string,SkipDates?:string[]}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CourierRecurrenceID;
/** @type {number} */
CourierProfileId;
/** @type {string} */
ProfileName;
/** @type {?number} */
CourierFacilityId;
/** @type {?number} */
CustomerContactId;
/** @type {string} */
CustomerName;
/** @type {string} */
CustomerPhone;
/** @type {string} */
Address;
/** @type {string} */
Unit;
/** @type {string} */
City;
/** @type {string} */
Zip;
/** @type {string} */
Zone;
/** @type {?number} */
Lat;
/** @type {?number} */
Lng;
/** @type {number} */
Weekday;
/** @type {string} */
WindowStart;
/** @type {string} */
WindowEnd;
/** @type {string} */
Cadence;
/** @type {string} */
AnchorDate;
/** @type {string} */
ServiceLevelCode;
/** @type {number} */
UnitsExpected;
/** @type {string} */
Handoff;
/** @type {string} */
Instructions;
/** @type {string} */
PayMode;
/** @type {string} */
AccountCode;
/** @type {boolean} */
Paused;
/** @type {string} */
LastMaterializedDate;
/** @type {string} */
NextDate;
/** @type {string[]} */
SkipDates = [];
}
export class CourierRecurrenceResponse {
/** @param {{Recurrences?:CourierRecurrenceView[],Message?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {CourierRecurrenceView[]} */
Recurrences = [];
/** @type {string} */
Message;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class CourierRecurrenceActionRequest {
/** @param {{Id?:number,Action?:string,Date?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
Id;
/** @type {string} */
Action;
/** @type {string} */
Date;
}
JavaScript CourierRecurrenceActionRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
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/jsv
Content-Type: text/jsv
Content-Length: length
{
Id: 0,
Action: String,
Date: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
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
}
}
}