Trendsic Platform Service

DispatchHoldCreateRequest

**Requires Authentication**
Requires any of the permissions:	DISPATCH:HAUL:MANAGE, DISPATCH:JOB:MANAGE, DISPATCH:ONDEMAND:MANAGE

The following routes are available for this service:
POST,OPTIONS	/v1/dispatch/holds

import Foundation
import ServiceStack

public class DispatchHoldCreateRequest : Codable
{
    public var scopeKind:String
    public var scopeKey:String
    public var scopeLabel:String
    public var reason:String
    public var note:String
    public var startUtc:String
    public var endUtc:String
    public var suggestionDate:String
    public var suggestionKind:String

    required public init(){}
}

public class DispatchHoldsResponse : Codable
{
    public var holds:[DispatchHoldView] = []
    public var windows:[DispatchOfflineWindowView] = []
    public var scopes:[DispatchHoldScopeView] = []
    public var suggestion:DispatchHoldSuggestionView
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class DispatchHoldView : Codable
{
    public var holdId:Int
    public var code:String
    public var scopeKind:String
    public var scopeKey:String
    public var scopeLabel:String
    public var reason:String
    public var note:String
    public var startUtc:Date
    public var endUtc:Date
    public var source:String
    public var incidentRef:String
    public var liftedUtc:Date?
    public var liftedBy:String
    public var createdUtc:Date?
    public var createdBy:String
    public var status:String

    required public init(){}
}

public class DispatchOfflineWindowView : Codable
{
    public var offlineWindowId:Int
    public var fromHour:String
    public var toHour:String

    required public init(){}
}

public class DispatchHoldScopeView : Codable
{
    public var kind:String
    public var key:String
    public var label:String

    required public init(){}
}

public class DispatchHoldSuggestionView : Codable
{
    public var forDate:String
    public var kind:String
    public var severity:Int
    public var headline:String
    public var dayLabel:String
    public var scopeKind:String
    public var scopeLabel:String
    public var reason:String
    public var startUtc:Date
    public var endUtc:Date
    public var windowLocal:String
    public var text:String

    required public init(){}
}

Swift DispatchHoldCreateRequest 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/holds HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ScopeKind: String,
	ScopeKey: String,
	ScopeLabel: String,
	Reason: String,
	Note: String,
	StartUtc: String,
	EndUtc: String,
	SuggestionDate: String,
	SuggestionKind: String
}

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Holds: 
	[
		{
			HoldId: 0,
			Code: String,
			ScopeKind: String,
			ScopeKey: String,
			ScopeLabel: String,
			Reason: String,
			Note: String,
			StartUtc: 0001-01-01,
			EndUtc: 0001-01-01,
			Source: String,
			IncidentRef: String,
			LiftedUtc: 0001-01-01,
			LiftedBy: String,
			CreatedUtc: 0001-01-01,
			CreatedBy: String,
			Status: String
		}
	],
	Windows: 
	[
		{
			OfflineWindowId: 0,
			FromHour: String,
			ToHour: String
		}
	],
	Scopes: 
	[
		{
			Kind: String,
			Key: String,
			Label: String
		}
	],
	Suggestion: 
	{
		ForDate: String,
		Kind: String,
		Severity: 0,
		Headline: String,
		DayLabel: String,
		ScopeKind: String,
		ScopeLabel: String,
		Reason: String,
		StartUtc: 0001-01-01,
		EndUtc: 0001-01-01,
		WindowLocal: String,
		Text: String
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}