Trendsic Platform Service

<back to all web services

DispatchPatternRequest

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

public class dtos
{

    public static class DispatchPatternRequest
    {
        public String PatternId = null;
        
        public String getPatternId() { return PatternId; }
        public DispatchPatternRequest setPatternId(String value) { this.PatternId = value; return this; }
    }

    public static class DispatchModulesResponse
    {
        public ArrayList<DispatchModuleView> Modules = new ArrayList<DispatchModuleView>();
        public ArrayList<DispatchPatternView> Patterns = new ArrayList<DispatchPatternView>();
        public ResponseStatus ResponseStatus = null;
        
        public ArrayList<DispatchModuleView> getModules() { return Modules; }
        public DispatchModulesResponse setModules(ArrayList<DispatchModuleView> value) { this.Modules = value; return this; }
        public ArrayList<DispatchPatternView> getPatterns() { return Patterns; }
        public DispatchModulesResponse setPatterns(ArrayList<DispatchPatternView> value) { this.Patterns = value; return this; }
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public DispatchModulesResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
    }

    public static class DispatchModuleView
    {
        public String Key = null;
        public String Mode = null;
        public Boolean Allowed = null;
        public Boolean Enabled = null;
        public Integer InFlight = null;
        
        public String getKey() { return Key; }
        public DispatchModuleView setKey(String value) { this.Key = value; return this; }
        public String getMode() { return Mode; }
        public DispatchModuleView setMode(String value) { this.Mode = value; return this; }
        public Boolean isAllowed() { return Allowed; }
        public DispatchModuleView setAllowed(Boolean value) { this.Allowed = value; return this; }
        public Boolean isEnabled() { return Enabled; }
        public DispatchModuleView setEnabled(Boolean value) { this.Enabled = value; return this; }
        public Integer getInFlight() { return InFlight; }
        public DispatchModuleView setInFlight(Integer value) { this.InFlight = value; return this; }
    }

    public static class DispatchPatternView
    {
        public String PatternId = null;
        public String Name = null;
        public String Source = null;
        public String Facility = null;
        public String Unit = null;
        public Boolean HasQuotas = null;
        public Boolean IsInverted = null;
        public Integer LoadLimitMins = null;
        public String TicketSource = null;
        public String PayBasis = null;
        public Boolean IsActive = null;
        
        public String getPatternId() { return PatternId; }
        public DispatchPatternView setPatternId(String value) { this.PatternId = value; return this; }
        public String getName() { return Name; }
        public DispatchPatternView setName(String value) { this.Name = value; return this; }
        public String getSource() { return Source; }
        public DispatchPatternView setSource(String value) { this.Source = value; return this; }
        public String getFacility() { return Facility; }
        public DispatchPatternView setFacility(String value) { this.Facility = value; return this; }
        public String getUnit() { return Unit; }
        public DispatchPatternView setUnit(String value) { this.Unit = value; return this; }
        public Boolean isHasQuotas() { return HasQuotas; }
        public DispatchPatternView setHasQuotas(Boolean value) { this.HasQuotas = value; return this; }
        public Boolean getIsInverted() { return IsInverted; }
        public DispatchPatternView setIsInverted(Boolean value) { this.IsInverted = value; return this; }
        public Integer getLoadLimitMins() { return LoadLimitMins; }
        public DispatchPatternView setLoadLimitMins(Integer value) { this.LoadLimitMins = value; return this; }
        public String getTicketSource() { return TicketSource; }
        public DispatchPatternView setTicketSource(String value) { this.TicketSource = value; return this; }
        public String getPayBasis() { return PayBasis; }
        public DispatchPatternView setPayBasis(String value) { this.PayBasis = value; return this; }
        public Boolean getIsActive() { return IsActive; }
        public DispatchPatternView setIsActive(Boolean value) { this.IsActive = value; return this; }
    }

}

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

PUT /v1/dispatch/settings/pattern HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	PatternId: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Modules: 
	[
		{
			Key: String,
			Mode: String,
			Allowed: False,
			Enabled: False,
			InFlight: 0
		}
	],
	Patterns: 
	[
		{
			PatternId: String,
			Name: String,
			Source: String,
			Facility: String,
			Unit: String,
			HasQuotas: False,
			IsInverted: False,
			LoadLimitMins: 0,
			TicketSource: String,
			PayBasis: String,
			IsActive: False
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}