Trendsic Platform Service

<back to all web services

DispatchHoldSuggestionDismissRequest

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/suggestion/dismiss
import datetime
import decimal
from marshmallow.fields import *
from servicestack import *
from typing import *
from dataclasses import dataclass, field
from dataclasses_json import dataclass_json, LetterCase, Undefined, config
from enum import Enum, IntEnum


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchHoldView:
    hold_id: int = 0
    code: Optional[str] = None
    scope_kind: Optional[str] = None
    scope_key: Optional[str] = None
    scope_label: Optional[str] = None
    reason: Optional[str] = None
    note: Optional[str] = None
    start_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    end_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    source: Optional[str] = None
    incident_ref: Optional[str] = None
    lifted_utc: Optional[datetime.datetime] = None
    lifted_by: Optional[str] = None
    created_utc: Optional[datetime.datetime] = None
    created_by: Optional[str] = None
    status: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchOfflineWindowView:
    offline_window_id: int = 0
    from_hour: Optional[str] = None
    to_hour: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchHoldScopeView:
    kind: Optional[str] = None
    key: Optional[str] = None
    label: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchHoldSuggestionView:
    for_date: Optional[str] = None
    kind: Optional[str] = None
    severity: int = 0
    headline: Optional[str] = None
    day_label: Optional[str] = None
    scope_kind: Optional[str] = None
    scope_label: Optional[str] = None
    reason: Optional[str] = None
    start_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    end_utc: datetime.datetime = datetime.datetime(1, 1, 1)
    window_local: Optional[str] = None
    text: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchHoldsResponse:
    holds: List[DispatchHoldView] = field(default_factory=list)
    windows: List[DispatchOfflineWindowView] = field(default_factory=list)
    scopes: List[DispatchHoldScopeView] = field(default_factory=list)
    suggestion: Optional[DispatchHoldSuggestionView] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class DispatchHoldSuggestionDismissRequest:
    for_date: Optional[str] = None
    kind: Optional[str] = None

Python DispatchHoldSuggestionDismissRequest 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/suggestion/dismiss HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	ForDate: String,
	Kind: 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
		}
	}
}