Trendsic Platform Service

<back to all web services

CoverageBoardRequest

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 CoverageSelfMatrixRow:
    name: Optional[str] = None
    note: Optional[str] = None
    tone: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageBoardShift:
    coverage_gap_id: int = 0
    state: Optional[str] = None
    day: Optional[str] = None
    window: Optional[str] = None
    site: Optional[str] = None
    role: Optional[str] = None
    poster: Optional[str] = None
    expiry_label: Optional[str] = None
    expires_soon: bool = False
    eligible_count: int = 0
    ineligible_count: int = 0
    offered_count: int = 0
    claims_count: int = 0
    claimant_name: Optional[str] = None
    audience_tier: Optional[str] = None
    matrix: List[CoverageSelfMatrixRow] = field(default_factory=list)
    not_yet_offered: int = 0


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageBoardApproval:
    coverage_approval_id: int = 0
    coverage_gap_id: int = 0
    claimant: Optional[str] = None
    poster: Optional[str] = None
    day: Optional[str] = None
    window: Optional[str] = None
    site: Optional[str] = None
    role: Optional[str] = None
    ot_text: Optional[str] = None
    ot_note: Optional[str] = None
    ot_warn: bool = False
    margin_text: Optional[str] = None
    margin_note: Optional[str] = None
    margin_tone: Optional[str] = None
    elig_text: Optional[str] = None
    elig_note: Optional[str] = None
    elig_warn: bool = False
    channel: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageBoardHistoryRow:
    kind: Optional[str] = None
    title: Optional[str] = None
    detail: Optional[str] = None
    outcome: Optional[str] = None
    when_label: Optional[str] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageBoardResponse:
    response_status: Optional[ResponseStatus] = None
    shifts: List[CoverageBoardShift] = field(default_factory=list)
    approvals: List[CoverageBoardApproval] = field(default_factory=list)
    history: List[CoverageBoardHistoryRow] = field(default_factory=list)
    can_approve: bool = False


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

Python CoverageBoardRequest DTOs

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

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

{
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	},
	Shifts: 
	[
		{
			CoverageGapId: 0,
			State: String,
			Day: String,
			Window: String,
			Site: String,
			Role: String,
			Poster: String,
			ExpiryLabel: String,
			ExpiresSoon: False,
			EligibleCount: 0,
			IneligibleCount: 0,
			OfferedCount: 0,
			ClaimsCount: 0,
			ClaimantName: String,
			AudienceTier: String,
			Matrix: 
			[
				{
					Name: String,
					Note: String,
					Tone: String
				}
			],
			NotYetOffered: 0
		}
	],
	Approvals: 
	[
		{
			CoverageApprovalId: 0,
			CoverageGapId: 0,
			Claimant: String,
			Poster: String,
			Day: String,
			Window: String,
			Site: String,
			Role: String,
			OtText: String,
			OtNote: String,
			OtWarn: False,
			MarginText: String,
			MarginNote: String,
			MarginTone: String,
			EligText: String,
			EligNote: String,
			EligWarn: False,
			Channel: String
		}
	],
	History: 
	[
		{
			Kind: String,
			Title: String,
			Detail: String,
			Outcome: String,
			WhenLabel: String
		}
	],
	CanApprove: False
}