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}
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 CourierRecurrenceSaveRequest
    {
        public virtual int? Id { get; set; }
        public virtual CourierRecurrenceView Recurrence { 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# CourierRecurrenceSaveRequest DTOs

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

HTTP + JSV

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/jsv
Content-Type: text/jsv
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/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
		}
	}
}