Trendsic Platform Service

<back to all web services

DispatchModulesSaveRequest

Requires Authentication
The following routes are available for this service:
PUT,OPTIONS/v1/dispatch/settings/modules
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 DispatchModulesResponse
    {
        public virtual List<DispatchModuleView> Modules { get; set; } = [];
        public virtual List<DispatchPatternView> Patterns { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class DispatchModulesSaveRequest
    {
        public virtual string Key { get; set; }
        public virtual bool Enabled { get; set; }
    }

    public partial class DispatchModuleView
    {
        public virtual string Key { get; set; }
        public virtual string Mode { get; set; }
        public virtual bool Allowed { get; set; }
        public virtual bool Enabled { get; set; }
        public virtual int InFlight { get; set; }
    }

    public partial class DispatchPatternView
    {
        public virtual string PatternId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Source { get; set; }
        public virtual string Facility { get; set; }
        public virtual string Unit { get; set; }
        public virtual bool HasQuotas { get; set; }
        public virtual bool IsInverted { get; set; }
        public virtual int LoadLimitMins { get; set; }
        public virtual string TicketSource { get; set; }
        public virtual string PayBasis { get; set; }
        public virtual bool IsActive { get; set; }
    }

}

C# DispatchModulesSaveRequest 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/modules HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Key: String,
	Enabled: False
}
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
		}
	}
}