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

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

{
	Token: String,
	Undo: False
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	State: String,
	WorkerFirst: String,
	Primary: String,
	Kind: String,
	Role: String,
	Pay: String,
	Site: String,
	Address: String,
	GapDate: String,
	GapTime: String,
	CalMon: String,
	CalDay: String,
	ReportTo: String,
	Elig: 
	[
		{
			Label: String,
			Detail: String,
			State: String
		}
	],
	AssignmentMode: String,
	Ticket: String,
	Expires: String,
	BlockExpl: 
	{
		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
	},
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}