Trendsic Platform Service

<back to all web services

CourierDriverStopsRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/worker/dispatch/od/stops
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CourierDriverStopsRequest
    {
        
    }

    public static class CourierDriverStopsResponse
    {
        public ArrayList<CourierStopRow> Rows = new ArrayList<CourierStopRow>();
        public Boolean Hidden = null;
        public CourierPingFacts Facts = null;
        public Boolean Available = null;
        public Date ServerUtc = null;
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<CourierStopRow> getRows() { return Rows; }
        public CourierDriverStopsResponse setRows(ArrayList<CourierStopRow> value) { this.Rows = value; return this; }
        public Boolean isHidden() { return Hidden; }
        public CourierDriverStopsResponse setHidden(Boolean value) { this.Hidden = value; return this; }
        public CourierPingFacts getFacts() { return Facts; }
        public CourierDriverStopsResponse setFacts(CourierPingFacts value) { this.Facts = value; return this; }
        public Boolean isAvailable() { return Available; }
        public CourierDriverStopsResponse setAvailable(Boolean value) { this.Available = value; return this; }
        public Date getServerUtc() { return ServerUtc; }
        public CourierDriverStopsResponse setServerUtc(Date value) { this.ServerUtc = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CourierDriverStopsResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class CourierStopRow
    {
        public String Kind = null;
        public Date AtUtc = null;
        public String OrderCode = null;
        public Integer Units = null;
        public Integer OrderCount = null;
        public String RunCode = null;
        public Integer StopSeq = null;
        public String Street = null;
        public String City = null;
        public String Zip = null;
        public String FacilityName = null;
        public String Reason = null;
        
        public String getKind() { return Kind; }
        public CourierStopRow setKind(String value) { this.Kind = value; return this; }
        public Date getAtUtc() { return AtUtc; }
        public CourierStopRow setAtUtc(Date value) { this.AtUtc = value; return this; }
        public String getOrderCode() { return OrderCode; }
        public CourierStopRow setOrderCode(String value) { this.OrderCode = value; return this; }
        public Integer getUnits() { return Units; }
        public CourierStopRow setUnits(Integer value) { this.Units = value; return this; }
        public Integer getOrderCount() { return OrderCount; }
        public CourierStopRow setOrderCount(Integer value) { this.OrderCount = value; return this; }
        public String getRunCode() { return RunCode; }
        public CourierStopRow setRunCode(String value) { this.RunCode = value; return this; }
        public Integer getStopSeq() { return StopSeq; }
        public CourierStopRow setStopSeq(Integer value) { this.StopSeq = value; return this; }
        public String getStreet() { return Street; }
        public CourierStopRow setStreet(String value) { this.Street = value; return this; }
        public String getCity() { return City; }
        public CourierStopRow setCity(String value) { this.City = value; return this; }
        public String getZip() { return Zip; }
        public CourierStopRow setZip(String value) { this.Zip = value; return this; }
        public String getFacilityName() { return FacilityName; }
        public CourierStopRow setFacilityName(String value) { this.FacilityName = value; return this; }
        public String getReason() { return Reason; }
        public CourierStopRow setReason(String value) { this.Reason = value; return this; }
    }

    public static class CourierPingFacts
    {
        public Boolean Busy = null;
        public BigDecimal RadiusMi = null;
        public Boolean HideAddressesInHistory = null;
        public BigDecimal PingRadiusMi = null;
        public Date PingRadiusUntilUtc = null;
        public String UnitOne = null;
        public String UnitMany = null;
        public String UnitOneEs = null;
        public String UnitManyEs = null;
        public String FacilityNoun = null;
        public String FacilityNounEs = null;
        
        public Boolean isBusy() { return Busy; }
        public CourierPingFacts setBusy(Boolean value) { this.Busy = value; return this; }
        public BigDecimal getRadiusMi() { return RadiusMi; }
        public CourierPingFacts setRadiusMi(BigDecimal value) { this.RadiusMi = value; return this; }
        public Boolean isHideAddressesInHistory() { return HideAddressesInHistory; }
        public CourierPingFacts setHideAddressesInHistory(Boolean value) { this.HideAddressesInHistory = value; return this; }
        public BigDecimal getPingRadiusMi() { return PingRadiusMi; }
        public CourierPingFacts setPingRadiusMi(BigDecimal value) { this.PingRadiusMi = value; return this; }
        public Date getPingRadiusUntilUtc() { return PingRadiusUntilUtc; }
        public CourierPingFacts setPingRadiusUntilUtc(Date value) { this.PingRadiusUntilUtc = value; return this; }
        public String getUnitOne() { return UnitOne; }
        public CourierPingFacts setUnitOne(String value) { this.UnitOne = value; return this; }
        public String getUnitMany() { return UnitMany; }
        public CourierPingFacts setUnitMany(String value) { this.UnitMany = value; return this; }
        public String getUnitOneEs() { return UnitOneEs; }
        public CourierPingFacts setUnitOneEs(String value) { this.UnitOneEs = value; return this; }
        public String getUnitManyEs() { return UnitManyEs; }
        public CourierPingFacts setUnitManyEs(String value) { this.UnitManyEs = value; return this; }
        public String getFacilityNoun() { return FacilityNoun; }
        public CourierPingFacts setFacilityNoun(String value) { this.FacilityNoun = value; return this; }
        public String getFacilityNounEs() { return FacilityNounEs; }
        public CourierPingFacts setFacilityNounEs(String value) { this.FacilityNounEs = value; return this; }
    }

}

Java CourierDriverStopsRequest 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.

GET /v1/worker/dispatch/od/stops HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Rows: 
	[
		{
			Kind: String,
			AtUtc: 0001-01-01,
			OrderCode: String,
			Units: 0,
			OrderCount: 0,
			RunCode: String,
			StopSeq: 0,
			Street: String,
			City: String,
			Zip: String,
			FacilityName: String,
			Reason: String
		}
	],
	Hidden: False,
	Facts: 
	{
		Busy: False,
		RadiusMi: 0,
		HideAddressesInHistory: False,
		PingRadiusMi: 0,
		PingRadiusUntilUtc: 0001-01-01,
		UnitOne: String,
		UnitMany: String,
		UnitOneEs: String,
		UnitManyEs: String,
		FacilityNoun: String,
		FacilityNounEs: String
	},
	Available: False,
	ServerUtc: 0001-01-01,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}