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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class DispatchHoldCreateRequest
{
    open var ScopeKind:String? = null
    open var ScopeKey:String? = null
    open var ScopeLabel:String? = null
    open var Reason:String? = null
    open var Note:String? = null
    open var StartUtc:String? = null
    open var EndUtc:String? = null
    open var SuggestionDate:String? = null
    open var SuggestionKind:String? = null
}

open class DispatchHoldsResponse
{
    open var Holds:ArrayList<DispatchHoldView> = ArrayList<DispatchHoldView>()
    open var Windows:ArrayList<DispatchOfflineWindowView> = ArrayList<DispatchOfflineWindowView>()
    open var Scopes:ArrayList<DispatchHoldScopeView> = ArrayList<DispatchHoldScopeView>()
    open var Suggestion:DispatchHoldSuggestionView? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class DispatchHoldView
{
    open var HoldId:Int? = null
    open var Code:String? = null
    open var ScopeKind:String? = null
    open var ScopeKey:String? = null
    open var ScopeLabel:String? = null
    open var Reason:String? = null
    open var Note:String? = null
    open var StartUtc:Date? = null
    open var EndUtc:Date? = null
    open var Source:String? = null
    open var IncidentRef:String? = null
    open var LiftedUtc:Date? = null
    open var LiftedBy:String? = null
    open var CreatedUtc:Date? = null
    open var CreatedBy:String? = null
    open var Status:String? = null
}

open class DispatchOfflineWindowView
{
    open var OfflineWindowId:Int? = null
    open var FromHour:String? = null
    open var ToHour:String? = null
}

open class DispatchHoldScopeView
{
    open var Kind:String? = null
    open var Key:String? = null
    open var Label:String? = null
}

open class DispatchHoldSuggestionView
{
    open var ForDate:String? = null
    open var Kind:String? = null
    open var Severity:Int? = null
    open var Headline:String? = null
    open var DayLabel:String? = null
    open var ScopeKind:String? = null
    open var ScopeLabel:String? = null
    open var Reason:String? = null
    open var StartUtc:Date? = null
    open var EndUtc:Date? = null
    open var WindowLocal:String? = null
    open var Text:String? = null
}

Kotlin 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
		}
	}
}