Trendsic Platform Service

CourierRecurrenceSaveRequest

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/courier/recurrences
PUT,OPTIONS	/v1/dispatch/courier/recurrences/{Id}

"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 CourierRecurrenceSaveRequest {
    /** @param {{Id?:number,Recurrence?:CourierRecurrenceView}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?number} */
    Id;
    /** @type {CourierRecurrenceView} */
    Recurrence;
}

JavaScript CourierRecurrenceSaveRequest DTOs

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

HTTP + XML

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: application/xml
Content-Type: application/xml
Content-Length: length

<CourierRecurrenceSaveRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Id>0</Id>
  <Recurrence>
    <AccountCode>String</AccountCode>
    <Address>String</Address>
    <AnchorDate>String</AnchorDate>
    <Cadence>String</Cadence>
    <City>String</City>
    <CourierFacilityId>0</CourierFacilityId>
    <CourierProfileId>0</CourierProfileId>
    <CourierRecurrenceID>0</CourierRecurrenceID>
    <CustomerContactId>0</CustomerContactId>
    <CustomerName>String</CustomerName>
    <CustomerPhone>String</CustomerPhone>
    <Handoff>String</Handoff>
    <Instructions>String</Instructions>
    <LastMaterializedDate>String</LastMaterializedDate>
    <Lat>0</Lat>
    <Lng>0</Lng>
    <NextDate>String</NextDate>
    <Paused>false</Paused>
    <PayMode>String</PayMode>
    <ProfileName>String</ProfileName>
    <ServiceLevelCode>String</ServiceLevelCode>
    <SkipDates xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:string>String</d3p1:string>
    </SkipDates>
    <Unit>String</Unit>
    <UnitsExpected>0</UnitsExpected>
    <Weekday>0</Weekday>
    <WindowEnd>String</WindowEnd>
    <WindowStart>String</WindowStart>
    <Zip>String</Zip>
    <Zone>String</Zone>
  </Recurrence>
</CourierRecurrenceSaveRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CourierRecurrenceResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Message>String</Message>
  <Recurrences>
    <CourierRecurrenceView>
      <AccountCode>String</AccountCode>
      <Address>String</Address>
      <AnchorDate>String</AnchorDate>
      <Cadence>String</Cadence>
      <City>String</City>
      <CourierFacilityId>0</CourierFacilityId>
      <CourierProfileId>0</CourierProfileId>
      <CourierRecurrenceID>0</CourierRecurrenceID>
      <CustomerContactId>0</CustomerContactId>
      <CustomerName>String</CustomerName>
      <CustomerPhone>String</CustomerPhone>
      <Handoff>String</Handoff>
      <Instructions>String</Instructions>
      <LastMaterializedDate>String</LastMaterializedDate>
      <Lat>0</Lat>
      <Lng>0</Lng>
      <NextDate>String</NextDate>
      <Paused>false</Paused>
      <PayMode>String</PayMode>
      <ProfileName>String</ProfileName>
      <ServiceLevelCode>String</ServiceLevelCode>
      <SkipDates xmlns:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:string>String</d4p1:string>
      </SkipDates>
      <Unit>String</Unit>
      <UnitsExpected>0</UnitsExpected>
      <Weekday>0</Weekday>
      <WindowEnd>String</WindowEnd>
      <WindowStart>String</WindowStart>
      <Zip>String</Zip>
      <Zone>String</Zone>
    </CourierRecurrenceView>
  </Recurrences>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
</CourierRecurrenceResponse>