Trendsic Platform Service

<back to all web services

CoverageTemplatesRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/policies/templates
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 CoverageRingDef:
    key: Optional[str] = None
    label: Optional[str] = None
    sub: Optional[str] = None
    wait_minutes: Optional[int] = None
    enabled: bool = False


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoveragePolicyPrefs:
    assignment_mode: Optional[str] = None
    rest_hours: int = 0
    ot_threshold_hours: int = 0
    ring_wait_minutes: int = 0
    quiet_start: Optional[str] = None
    quiet_end: Optional[str] = None
    reschedule_allowed: bool = False
    quiet_mode: Optional[str] = None
    rings: List[CoverageRingDef] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageRuleDocSection:
    h: Optional[str] = None
    t: Optional[str] = None


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


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageRuleTune:
    intro: Optional[str] = None
    options: List[CoverageRuleTuneOption] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageRuleDef:
    rule_id: Optional[str] = None
    name: Optional[str] = None
    kind: Optional[str] = None
    demand: Optional[str] = None
    source_policy_name: Optional[str] = None
    cascade_level: Optional[str] = None
    why: Optional[str] = None
    change: Optional[str] = None
    override_who: Optional[str] = None
    override_consequence: Optional[str] = None
    no_note: Optional[str] = None
    params: Dict[str, str] = field(default_factory=dict)
    doc: List[CoverageRuleDocSection] = field(default_factory=list)
    tune: Optional[CoverageRuleTune] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoveragePolicyDoc:
    intro: Optional[str] = None
    lock_line: Optional[str] = None
    template_name: Optional[str] = None
    prefs: Optional[CoveragePolicyPrefs] = None
    rules: List[CoverageRuleDef] = field(default_factory=list)


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageTemplateInfo:
    key: Optional[str] = None
    name: Optional[str] = None
    sub: Optional[str] = None
    doc: Optional[CoveragePolicyDoc] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageTemplatesResponse:
    templates: List[CoverageTemplateInfo] = field(default_factory=list)
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageTemplatesRequest:
    pass

Python CoverageTemplatesRequest 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/coverage/policies/templates HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Templates: 
	[
		{
			Key: String,
			Name: String,
			Sub: String,
			Doc: 
			{
				Intro: String,
				LockLine: String,
				TemplateName: String,
				Prefs: 
				{
					AssignmentMode: String,
					RestHours: 0,
					OtThresholdHours: 0,
					RingWaitMinutes: 0,
					QuietStart: String,
					QuietEnd: String,
					RescheduleAllowed: False,
					QuietMode: String,
					Rings: 
					[
						{
							Key: String,
							Label: String,
							Sub: String,
							WaitMinutes: 0,
							Enabled: False
						}
					]
				},
				Rules: 
				[
					{
						RuleId: String,
						Name: String,
						Kind: String,
						Demand: String,
						SourcePolicyName: String,
						CascadeLevel: String,
						Why: String,
						Change: String,
						OverrideWho: String,
						OverrideConsequence: String,
						NoNote: String,
						Params: 
						{
							String: String
						},
						Doc: 
						[
							{
								H: String,
								T: String
							}
						],
						Tune: 
						{
							Intro: String,
							Options: 
							[
								{
									Label: String,
									Sub: String
								}
							]
						}
					}
				]
			}
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}