Trendsic Platform Service

CoverageBoardRequest

The following routes are available for this service:
GET,OPTIONS	/v1/coverage/board

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

To override the Content-type in your clients, use the HTTP Accept Header, append the .xml suffix or ?format=xml

HTTP + XML

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CoverageBoardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Approvals>
    <CoverageBoardApproval>
      <Channel>String</Channel>
      <Claimant>String</Claimant>
      <CoverageApprovalId>0</CoverageApprovalId>
      <CoverageGapId>0</CoverageGapId>
      <Day>String</Day>
      <EligNote>String</EligNote>
      <EligText>String</EligText>
      <EligWarn>false</EligWarn>
      <MarginNote>String</MarginNote>
      <MarginText>String</MarginText>
      <MarginTone>String</MarginTone>
      <OtNote>String</OtNote>
      <OtText>String</OtText>
      <OtWarn>false</OtWarn>
      <Poster>String</Poster>
      <Role>String</Role>
      <Site>String</Site>
      <Window>String</Window>
    </CoverageBoardApproval>
  </Approvals>
  <CanApprove>false</CanApprove>
  <History>
    <CoverageBoardHistoryRow>
      <Detail>String</Detail>
      <Kind>String</Kind>
      <Outcome>String</Outcome>
      <Title>String</Title>
      <WhenLabel>String</WhenLabel>
    </CoverageBoardHistoryRow>
  </History>
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Shifts>
    <CoverageBoardShift>
      <AudienceTier>String</AudienceTier>
      <ClaimantName>String</ClaimantName>
      <ClaimsCount>0</ClaimsCount>
      <CoverageGapId>0</CoverageGapId>
      <Day>String</Day>
      <EligibleCount>0</EligibleCount>
      <ExpiresSoon>false</ExpiresSoon>
      <ExpiryLabel>String</ExpiryLabel>
      <IneligibleCount>0</IneligibleCount>
      <Matrix>
        <CoverageSelfMatrixRow>
          <Name>String</Name>
          <Note>String</Note>
          <Tone>String</Tone>
        </CoverageSelfMatrixRow>
      </Matrix>
      <NotYetOffered>0</NotYetOffered>
      <OfferedCount>0</OfferedCount>
      <Poster>String</Poster>
      <Role>String</Role>
      <Site>String</Site>
      <State>String</State>
      <Window>String</Window>
    </CoverageBoardShift>
  </Shifts>
</CoverageBoardResponse>