Trendsic Platform Service

<back to all web services

CoverageSurgePreviewRequest

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 CoverageSurgeGap:
    coverage_gap_id: int = 0
    label: Optional[str] = None
    note: Optional[str] = None
    track: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageExplanationSource:
    policy_name: Optional[str] = None
    cascade_level: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageExplanationOverride:
    who: Optional[str] = None
    consequence: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageExplanation:
    plain_sentence: Optional[str] = None
    rule_id: Optional[str] = None
    rule_name: Optional[str] = None
    demand: Optional[str] = None
    source: Optional[CoverageExplanationSource] = None
    kind: Optional[str] = None
    why_it_exists: Optional[str] = None
    what_would_change_it: Optional[str] = None
    override: Optional[CoverageExplanationOverride] = None
    drill: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageEffect:
    icon: Optional[str] = None
    text: Optional[str] = None
    rule_id: Optional[str] = None
    expl: Optional[CoverageExplanation] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageSurgePreviewResponse:
    banner: Optional[str] = None
    title: Optional[str] = None
    sub: Optional[str] = None
    items: List[CoverageSurgeGap] = field(default_factory=list)
    pool_count: int = 0
    conseq: List[CoverageEffect] = field(default_factory=list)
    guard_line: Optional[str] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageSurgePreviewRequest:
    scope_date: Optional[datetime.datetime] = None

Python CoverageSurgePreviewRequest DTOs

GET /v1/coverage/surge/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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

{
	Banner: String,
	Title: String,
	Sub: String,
	Items: 
	[
		{
			CoverageGapId: 0,
			Label: String,
			Note: String,
			Track: String
		}
	],
	PoolCount: 0,
	Conseq: 
	[
		{
			Icon: String,
			Text: String,
			RuleId: String,
			Expl: 
			{
				PlainSentence: String,
				RuleId: String,
				RuleName: String,
				Demand: String,
				Source: 
				{
					PolicyName: String,
					CascadeLevel: String
				},
				Kind: String,
				WhyItExists: String,
				WhatWouldChangeIt: String,
				Override: 
				{
					Who: String,
					Consequence: String
				},
				Drill: String
			}
		}
	],
	GuardLine: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}