Trendsic Platform Service

<back to all web services

DispatchModulesRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/dispatch/settings/modules
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class DispatchModulesRequest
        End Class

        Public Partial Class DispatchModulesResponse
            Public Overridable Property Modules As List(Of DispatchModuleView) = New List(Of DispatchModuleView)
            Public Overridable Property Patterns As List(Of DispatchPatternView) = New List(Of DispatchPatternView)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class DispatchModuleView
            Public Overridable Property Key As String
            Public Overridable Property Mode As String
            Public Overridable Property Allowed As Boolean
            Public Overridable Property Enabled As Boolean
            Public Overridable Property InFlight As Integer
        End Class

        Public Partial Class DispatchPatternView
            Public Overridable Property PatternId As String
            Public Overridable Property Name As String
            Public Overridable Property Source As String
            Public Overridable Property Facility As String
            Public Overridable Property Unit As String
            Public Overridable Property HasQuotas As Boolean
            Public Overridable Property IsInverted As Boolean
            Public Overridable Property LoadLimitMins As Integer
            Public Overridable Property TicketSource As String
            Public Overridable Property PayBasis As String
            Public Overridable Property IsActive As Boolean
        End Class
    End Namespace
End Namespace

VB.NET DispatchModulesRequest 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/dispatch/settings/modules HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
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
		}
	}
}