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}
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CourierRecurrenceActionRequest
    {
        public Integer Id = null;
        public String Action = null;
        public String Date = null;
        
        public Integer getId() { return Id; }
        public CourierRecurrenceActionRequest setId(Integer value) { this.Id = value; return this; }
        public String getAction() { return Action; }
        public CourierRecurrenceActionRequest setAction(String value) { this.Action = value; return this; }
        public String getDate() { return Date; }
        public CourierRecurrenceActionRequest setDate(String value) { this.Date = value; return this; }
    }

    public static class CourierRecurrenceResponse
    {
        public ArrayList<CourierRecurrenceView> Recurrences = new ArrayList<CourierRecurrenceView>();
        public String Message = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<CourierRecurrenceView> getRecurrences() { return Recurrences; }
        public CourierRecurrenceResponse setRecurrences(ArrayList<CourierRecurrenceView> value) { this.Recurrences = value; return this; }
        public String getMessage() { return Message; }
        public CourierRecurrenceResponse setMessage(String value) { this.Message = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CourierRecurrenceResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class CourierRecurrenceView
    {
        public Integer CourierRecurrenceID = null;
        public Integer CourierProfileId = null;
        public String ProfileName = null;
        public Integer CourierFacilityId = null;
        public Integer CustomerContactId = null;
        public String CustomerName = null;
        public String CustomerPhone = null;
        public String Address = null;
        public String Unit = null;
        public String City = null;
        public String Zip = null;
        public String Zone = null;
        public BigDecimal Lat = null;
        public BigDecimal Lng = null;
        public Integer Weekday = null;
        public String WindowStart = null;
        public String WindowEnd = null;
        public String Cadence = null;
        public String AnchorDate = null;
        public String ServiceLevelCode = null;
        public Integer UnitsExpected = null;
        public String Handoff = null;
        public String Instructions = null;
        public String PayMode = null;
        public String AccountCode = null;
        public Boolean Paused = null;
        public String LastMaterializedDate = null;
        public String NextDate = null;
        public ArrayList<String> SkipDates = new ArrayList<String>();
        
        public Integer getCourierRecurrenceID() { return CourierRecurrenceID; }
        public CourierRecurrenceView setCourierRecurrenceID(Integer value) { this.CourierRecurrenceID = value; return this; }
        public Integer getCourierProfileId() { return CourierProfileId; }
        public CourierRecurrenceView setCourierProfileId(Integer value) { this.CourierProfileId = value; return this; }
        public String getProfileName() { return ProfileName; }
        public CourierRecurrenceView setProfileName(String value) { this.ProfileName = value; return this; }
        public Integer getCourierFacilityId() { return CourierFacilityId; }
        public CourierRecurrenceView setCourierFacilityId(Integer value) { this.CourierFacilityId = value; return this; }
        public Integer getCustomerContactId() { return CustomerContactId; }
        public CourierRecurrenceView setCustomerContactId(Integer value) { this.CustomerContactId = value; return this; }
        public String getCustomerName() { return CustomerName; }
        public CourierRecurrenceView setCustomerName(String value) { this.CustomerName = value; return this; }
        public String getCustomerPhone() { return CustomerPhone; }
        public CourierRecurrenceView setCustomerPhone(String value) { this.CustomerPhone = value; return this; }
        public String getAddress() { return Address; }
        public CourierRecurrenceView setAddress(String value) { this.Address = value; return this; }
        public String getUnit() { return Unit; }
        public CourierRecurrenceView setUnit(String value) { this.Unit = value; return this; }
        public String getCity() { return City; }
        public CourierRecurrenceView setCity(String value) { this.City = value; return this; }
        public String getZip() { return Zip; }
        public CourierRecurrenceView setZip(String value) { this.Zip = value; return this; }
        public String getZone() { return Zone; }
        public CourierRecurrenceView setZone(String value) { this.Zone = value; return this; }
        public BigDecimal getLat() { return Lat; }
        public CourierRecurrenceView setLat(BigDecimal value) { this.Lat = value; return this; }
        public BigDecimal getLng() { return Lng; }
        public CourierRecurrenceView setLng(BigDecimal value) { this.Lng = value; return this; }
        public Integer getWeekday() { return Weekday; }
        public CourierRecurrenceView setWeekday(Integer value) { this.Weekday = value; return this; }
        public String getWindowStart() { return WindowStart; }
        public CourierRecurrenceView setWindowStart(String value) { this.WindowStart = value; return this; }
        public String getWindowEnd() { return WindowEnd; }
        public CourierRecurrenceView setWindowEnd(String value) { this.WindowEnd = value; return this; }
        public String getCadence() { return Cadence; }
        public CourierRecurrenceView setCadence(String value) { this.Cadence = value; return this; }
        public String getAnchorDate() { return AnchorDate; }
        public CourierRecurrenceView setAnchorDate(String value) { this.AnchorDate = value; return this; }
        public String getServiceLevelCode() { return ServiceLevelCode; }
        public CourierRecurrenceView setServiceLevelCode(String value) { this.ServiceLevelCode = value; return this; }
        public Integer getUnitsExpected() { return UnitsExpected; }
        public CourierRecurrenceView setUnitsExpected(Integer value) { this.UnitsExpected = value; return this; }
        public String getHandoff() { return Handoff; }
        public CourierRecurrenceView setHandoff(String value) { this.Handoff = value; return this; }
        public String getInstructions() { return Instructions; }
        public CourierRecurrenceView setInstructions(String value) { this.Instructions = value; return this; }
        public String getPayMode() { return PayMode; }
        public CourierRecurrenceView setPayMode(String value) { this.PayMode = value; return this; }
        public String getAccountCode() { return AccountCode; }
        public CourierRecurrenceView setAccountCode(String value) { this.AccountCode = value; return this; }
        public Boolean isPaused() { return Paused; }
        public CourierRecurrenceView setPaused(Boolean value) { this.Paused = value; return this; }
        public String getLastMaterializedDate() { return LastMaterializedDate; }
        public CourierRecurrenceView setLastMaterializedDate(String value) { this.LastMaterializedDate = value; return this; }
        public String getNextDate() { return NextDate; }
        public CourierRecurrenceView setNextDate(String value) { this.NextDate = value; return this; }
        public ArrayList<String> getSkipDates() { return SkipDates; }
        public CourierRecurrenceView setSkipDates(ArrayList<String> value) { this.SkipDates = value; return this; }
    }

}

Java CourierRecurrenceActionRequest 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/{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
		}
	}
}