Trendsic Platform Service

<back to all web services

CoverageOfferPassRequest

The following routes are available for this service:
POST/v1/coverage/offer/{Token}/pass
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 CoverageOfferEligChip:
    label: Optional[str] = None
    detail: Optional[str] = None
    state: 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 CoverageOfferViewResponse:
    state: Optional[str] = None
    worker_first: Optional[str] = None
    primary: Optional[str] = None
    kind: Optional[str] = None
    role: Optional[str] = None
    pay: Optional[str] = None
    site: Optional[str] = None
    address: Optional[str] = None
    gap_date: Optional[str] = None
    gap_time: Optional[str] = None
    cal_mon: Optional[str] = None
    cal_day: Optional[str] = None
    report_to: Optional[str] = None
    elig: List[CoverageOfferEligChip] = field(default_factory=list)
    assignment_mode: Optional[str] = None
    ticket: Optional[str] = None
    expires: Optional[str] = None
    block_expl: Optional[CoverageExplanation] = None
    response_status: Optional[ResponseStatus] = None


@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageOfferPassRequest:
    token: Optional[str] = None
    undo: bool = False

Python CoverageOfferPassRequest 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.

POST /v1/coverage/offer/{Token}/pass HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CoverageOfferPassRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Token>String</Token>
  <Undo>false</Undo>
</CoverageOfferPassRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CoverageOfferViewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Address>String</Address>
  <AssignmentMode>String</AssignmentMode>
  <BlockExpl>
    <Demand>String</Demand>
    <Drill>String</Drill>
    <Kind>String</Kind>
    <Override>
      <Consequence>String</Consequence>
      <Who>String</Who>
    </Override>
    <PlainSentence>String</PlainSentence>
    <RuleId>String</RuleId>
    <RuleName>String</RuleName>
    <Source>
      <CascadeLevel>String</CascadeLevel>
      <PolicyName>String</PolicyName>
    </Source>
    <WhatWouldChangeIt>String</WhatWouldChangeIt>
    <WhyItExists>String</WhyItExists>
  </BlockExpl>
  <CalDay>String</CalDay>
  <CalMon>String</CalMon>
  <Elig>
    <CoverageOfferEligChip>
      <Detail>String</Detail>
      <Label>String</Label>
      <State>String</State>
    </CoverageOfferEligChip>
  </Elig>
  <Expires>String</Expires>
  <GapDate>String</GapDate>
  <GapTime>String</GapTime>
  <Kind>String</Kind>
  <Pay>String</Pay>
  <Primary>String</Primary>
  <ReportTo>String</ReportTo>
  <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>
  <Role>String</Role>
  <Site>String</Site>
  <State>String</State>
  <Ticket>String</Ticket>
  <WorkerFirst>String</WorkerFirst>
</CoverageOfferViewResponse>