| POST | /v1/coverage/leave/{CoverageGapId}/checkpoint |
|---|
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 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 CoverageCandidateCheck:
check_id: Optional[str] = None
result: Optional[str] = None
expl: Optional[CoverageExplanation] = 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 CoverageCandidate:
contact_id: int = 0
name: Optional[str] = None
first_name: Optional[str] = None
initials: Optional[str] = None
rank: int = 0
diff_line: Optional[str] = None
cost_line: Optional[str] = None
cost_tone: Optional[str] = None
rank_expl: Optional[CoverageExplanation] = None
margin_pct: Optional[Decimal] = None
margin_tone: Optional[str] = None
loaded: Optional[Decimal] = None
billed: Optional[Decimal] = None
ot_hours: Optional[Decimal] = None
ot_premium: Optional[Decimal] = None
checks: List[CoverageCandidateCheck] = field(default_factory=list)
preview: List[CoverageEffect] = field(default_factory=list)
confirm: List[CoverageEffect] = field(default_factory=list)
has_warn: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageBlockedCandidate:
contact_id: int = 0
name: Optional[str] = None
initials: Optional[str] = None
reason: Optional[str] = None
change_chip: Optional[str] = None
expl: Optional[CoverageExplanation] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageOfferInfo:
coverage_offer_id: int = 0
contact_id: int = 0
name: Optional[str] = None
ring: int = 0
channel: Optional[str] = None
status: Optional[str] = None
sent_at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
responded_at_utc: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageApprovalInfo:
coverage_approval_id: int = 0
coverage_gap_id: int = 0
type: Optional[str] = None
status: Optional[str] = None
requested_at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
effects: List[CoverageEffect] = field(default_factory=list)
contact_id: Optional[int] = None
contact_name: Optional[str] = None
decided_at_utc: Optional[datetime.datetime] = None
decision_note: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageGapEventInfo:
event_type: Optional[str] = None
channel: Optional[str] = None
detail: Optional[str] = None
contact_name: Optional[str] = None
at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageMoveOption:
key: Optional[str] = None
label: Optional[str] = None
detail: Optional[str] = None
expl: Optional[CoverageExplanation] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageNoShowAttempt:
at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
channel: Optional[str] = None
note: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageNoShowState:
grace_until_utc: datetime.datetime = datetime.datetime(1, 1, 1)
attempts: List[CoverageNoShowAttempt] = field(default_factory=list)
declared_at_utc: Optional[datetime.datetime] = None
attendance_note: bool = False
false_alarm: bool = False
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageLeaveCheckpoint:
at_utc: datetime.datetime = datetime.datetime(1, 1, 1)
note: Optional[str] = None
by_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageLeaveState:
fmla: bool = False
began: datetime.datetime = datetime.datetime(1, 1, 1)
est_return: Optional[datetime.datetime] = None
checkpoint_days: int = 0
next_checkpoint_utc: Optional[datetime.datetime] = None
checkpoints: List[CoverageLeaveCheckpoint] = field(default_factory=list)
interim_contact_id: Optional[int] = None
interim_name: Optional[str] = None
interim_start: Optional[datetime.datetime] = None
interim_end: Optional[datetime.datetime] = None
requisition_opened: bool = False
staff_posting_id: Optional[int] = None
chained_gap_ids: List[int] = field(default_factory=list)
parent_leave_gap_id: Optional[int] = None
restored_at_utc: Optional[datetime.datetime] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageGap:
coverage_gap_id: int = 0
coverage_gap_u_i_d: Optional[str] = None
branch_id: Optional[str] = None
status: Optional[str] = None
track: Optional[str] = None
out_contact_i_d: Optional[int] = None
out_name: Optional[str] = None
out_initials: Optional[str] = None
job_i_d: Optional[int] = None
job_name: Optional[str] = None
project_i_d: Optional[int] = None
worker_schedule_item_i_d: Optional[int] = None
window_start: datetime.datetime = datetime.datetime(1, 1, 1)
window_end: datetime.datetime = datetime.datetime(1, 1, 1)
reason: Optional[str] = None
must_fill: bool = False
must_fill_expl: Optional[CoverageExplanation] = None
filled_by_contact_i_d: Optional[int] = None
filled_by_name: Optional[str] = None
record_no: Optional[str] = None
decided_policy_version_id: Optional[int] = None
created_at: datetime.datetime = datetime.datetime(1, 1, 1)
updated_at: Optional[datetime.datetime] = None
qualified_line: Optional[str] = None
candidates: List[CoverageCandidate] = field(default_factory=list)
blocked: List[CoverageBlockedCandidate] = field(default_factory=list)
offers: List[CoverageOfferInfo] = field(default_factory=list)
approvals: List[CoverageApprovalInfo] = field(default_factory=list)
timeline: List[CoverageGapEventInfo] = field(default_factory=list)
move_options: List[CoverageMoveOption] = field(default_factory=list)
order_expl: Optional[CoverageExplanation] = None
assignment_mode: Optional[str] = None
no_show: Optional[CoverageNoShowState] = None
leave: Optional[CoverageLeaveState] = None
customer_name: Optional[str] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageGapResponse:
gap: Optional[CoverageGap] = None
chained_preview: Optional[int] = None
can_see_pay: bool = False
response_status: Optional[ResponseStatus] = None
@dataclass_json(letter_case=LetterCase.CAMEL, undefined=Undefined.EXCLUDE)
@dataclass
class CoverageLeaveCheckpointRequest:
coverage_gap_id: int = 0
note: Optional[str] = None
Python CoverageLeaveCheckpointRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv
The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.
POST /v1/coverage/leave/{CoverageGapId}/checkpoint HTTP/1.1
Host: api.dev.dynamics.trendsic.com
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length
{
CoverageGapId: 0,
Note: String
}
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length
{
Gap:
{
CoverageGapId: 0,
CoverageGapUID: 00000000000000000000000000000000,
BranchId: 00000000000000000000000000000000,
Status: String,
Track: String,
OutContactID: 0,
OutName: String,
OutInitials: String,
JobID: 0,
JobName: String,
ProjectID: 0,
WorkerScheduleItemID: 0,
WindowStart: 0001-01-01,
WindowEnd: 0001-01-01,
Reason: String,
MustFill: False,
MustFillExpl:
{
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
},
FilledByContactID: 0,
FilledByName: String,
RecordNo: String,
DecidedPolicyVersionId: 0,
CreatedAt: 0001-01-01,
UpdatedAt: 0001-01-01,
QualifiedLine: String,
Candidates:
[
{
ContactId: 0,
Name: String,
FirstName: String,
Initials: String,
Rank: 0,
DiffLine: String,
CostLine: String,
CostTone: String,
RankExpl:
{
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
},
MarginPct: 0,
MarginTone: String,
Loaded: 0,
Billed: 0,
OtHours: 0,
OtPremium: 0,
Checks:
[
{
CheckId: String,
Result: 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
}
}
],
Preview:
[
{
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
}
}
],
Confirm:
[
{
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
}
}
],
HasWarn: False
}
],
Blocked:
[
{
ContactId: 0,
Name: String,
Initials: String,
Reason: String,
ChangeChip: 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
}
}
],
Offers:
[
{
CoverageOfferId: 0,
ContactId: 0,
Name: String,
Ring: 0,
Channel: String,
Status: String,
SentAtUtc: 0001-01-01,
RespondedAtUtc: 0001-01-01
}
],
Approvals:
[
{
CoverageApprovalId: 0,
CoverageGapId: 0,
Type: String,
Status: String,
RequestedAtUtc: 0001-01-01,
Effects:
[
{
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
}
}
],
ContactId: 0,
ContactName: String,
DecidedAtUtc: 0001-01-01,
DecisionNote: String
}
],
Timeline:
[
{
EventType: String,
Channel: String,
Detail: String,
ContactName: String,
AtUtc: 0001-01-01
}
],
MoveOptions:
[
{
Key: String,
Label: String,
Detail: 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
}
}
],
OrderExpl:
{
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
},
AssignmentMode: String,
NoShow:
{
GraceUntilUtc: 0001-01-01,
Attempts:
[
{
AtUtc: 0001-01-01,
Channel: String,
Note: String
}
],
DeclaredAtUtc: 0001-01-01,
AttendanceNote: False,
FalseAlarm: False
},
Leave:
{
Fmla: False,
Began: 0001-01-01,
EstReturn: 0001-01-01,
CheckpointDays: 0,
NextCheckpointUtc: 0001-01-01,
Checkpoints:
[
{
AtUtc: 0001-01-01,
Note: String,
ByName: String
}
],
InterimContactId: 0,
InterimName: String,
InterimStart: 0001-01-01,
InterimEnd: 0001-01-01,
RequisitionOpened: False,
StaffPostingId: 0,
ChainedGapIds:
[
0
],
ParentLeaveGapId: 0,
RestoredAtUtc: 0001-01-01
},
CustomerName: String
},
ChainedPreview: 0,
CanSeePay: False,
ResponseStatus:
{
ErrorCode: String,
Message: String,
StackTrace: String,
Errors:
[
{
ErrorCode: String,
FieldName: String,
Message: String,
Meta:
{
String: String
}
}
],
Meta:
{
String: String
}
}
}