Trendsic Platform Service

<back to all web services

CourierRecurrencesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/courier/recurrences
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class CourierRecurrenceResponse
    {
        public virtual List<CourierRecurrenceView> Recurrences { get; set; } = [];
        public virtual string Message { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class CourierRecurrencesRequest
    {
        public virtual int? ProfileId { get; set; }
    }

    public partial class CourierRecurrenceView
    {
        public virtual int CourierRecurrenceID { get; set; }
        public virtual int CourierProfileId { get; set; }
        public virtual string ProfileName { get; set; }
        public virtual int? CourierFacilityId { get; set; }
        public virtual int? CustomerContactId { get; set; }
        public virtual string CustomerName { get; set; }
        public virtual string CustomerPhone { get; set; }
        public virtual string Address { get; set; }
        public virtual string Unit { get; set; }
        public virtual string City { get; set; }
        public virtual string Zip { get; set; }
        public virtual string Zone { get; set; }
        public virtual decimal? Lat { get; set; }
        public virtual decimal? Lng { get; set; }
        public virtual int Weekday { get; set; }
        public virtual string WindowStart { get; set; }
        public virtual string WindowEnd { get; set; }
        public virtual string Cadence { get; set; }
        public virtual string AnchorDate { get; set; }
        public virtual string ServiceLevelCode { get; set; }
        public virtual int UnitsExpected { get; set; }
        public virtual string Handoff { get; set; }
        public virtual string Instructions { get; set; }
        public virtual string PayMode { get; set; }
        public virtual string AccountCode { get; set; }
        public virtual bool Paused { get; set; }
        public virtual string LastMaterializedDate { get; set; }
        public virtual string NextDate { get; set; }
        public virtual List<string> SkipDates { get; set; } = [];
    }

}

C# CourierRecurrencesRequest 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.

GET /v1/dispatch/courier/recurrences HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
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>