Trendsic Platform Service

<back to all web services

CoverageLeaveRequisitionRequest

Requires Authentication
The following routes are available for this service:
POST/v1/coverage/leave/{CoverageGapId}/requisition
CoverageLeaveRequisitionRequest Parameters:
NameParameterData TypeRequiredDescription
CoverageGapIdpathintNo
CoverageGapResponse Parameters:
NameParameterData TypeRequiredDescription
GapformCoverageGapNo
ChainedPreviewformint?No
CanSeePayformboolNo
ResponseStatusformResponseStatusNo
CoverageGap Parameters:
NameParameterData TypeRequiredDescription
CoverageGapIdformintNo
CoverageGapUIDformGuidNo
BranchIdformGuid?No
StatusformstringNo
TrackformstringNo
OutContactIDformint?No
OutNameformstringNo
OutInitialsformstringNo
JobIDformint?No
JobNameformstringNo
ProjectIDformint?No
WorkerScheduleItemIDformint?No
WindowStartformDateTimeNo
WindowEndformDateTimeNo
ReasonformstringNo
MustFillformboolNo
MustFillExplformCoverageExplanationNo
FilledByContactIDformint?No
FilledByNameformstringNo
RecordNoformstringNo
DecidedPolicyVersionIdformint?No
CreatedAtformDateTimeNo
UpdatedAtformDateTime?No
QualifiedLineformstringNo
CandidatesformList<CoverageCandidate>No
BlockedformList<CoverageBlockedCandidate>No
OffersformList<CoverageOfferInfo>No
ApprovalsformList<CoverageApprovalInfo>No
TimelineformList<CoverageGapEventInfo>No
MoveOptionsformList<CoverageMoveOption>No
OrderExplformCoverageExplanationNo
AssignmentModeformstringNo
NoShowformCoverageNoShowStateNo
LeaveformCoverageLeaveStateNo
CustomerNameformstringNo
CoverageExplanation Parameters:
NameParameterData TypeRequiredDescription
PlainSentenceformstringNo
RuleIdformstringNo
RuleNameformstringNo
DemandformstringNo
SourceformCoverageExplanationSourceNo
KindformstringNo
WhyItExistsformstringNo
WhatWouldChangeItformstringNo
OverrideformCoverageExplanationOverrideNo
DrillformstringNo
CoverageExplanationSource Parameters:
NameParameterData TypeRequiredDescription
PolicyNameformstringNo
CascadeLevelformstringNo
CoverageExplanationOverride Parameters:
NameParameterData TypeRequiredDescription
WhoformstringNo
ConsequenceformstringNo
CoverageCandidate Parameters:
NameParameterData TypeRequiredDescription
ContactIdformintNo
NameformstringNo
FirstNameformstringNo
InitialsformstringNo
RankformintNo
DiffLineformstringNo
CostLineformstringNo
CostToneformstringNo
RankExplformCoverageExplanationNo
MarginPctformdecimal?No
MarginToneformstringNo
Loadedformdecimal?No
Billedformdecimal?No
OtHoursformdecimal?No
OtPremiumformdecimal?No
ChecksformList<CoverageCandidateCheck>No
PreviewformList<CoverageEffect>No
ConfirmformList<CoverageEffect>No
HasWarnformboolNo
CoverageCandidateCheck Parameters:
NameParameterData TypeRequiredDescription
CheckIdformstringNo
ResultformstringNo
ExplformCoverageExplanationNo
CoverageEffect Parameters:
NameParameterData TypeRequiredDescription
IconformstringNo
TextformstringNo
RuleIdformstringNo
ExplformCoverageExplanationNo
CoverageBlockedCandidate Parameters:
NameParameterData TypeRequiredDescription
ContactIdformintNo
NameformstringNo
InitialsformstringNo
ReasonformstringNo
ChangeChipformstringNo
ExplformCoverageExplanationNo
CoverageOfferInfo Parameters:
NameParameterData TypeRequiredDescription
CoverageOfferIdformintNo
ContactIdformintNo
NameformstringNo
RingformintNo
ChannelformstringNo
StatusformstringNo
SentAtUtcformDateTimeNo
RespondedAtUtcformDateTime?No
CoverageApprovalInfo Parameters:
NameParameterData TypeRequiredDescription
CoverageApprovalIdformintNo
CoverageGapIdformintNo
TypeformstringNo
StatusformstringNo
RequestedAtUtcformDateTimeNo
EffectsformList<CoverageEffect>No
ContactIdformint?No
ContactNameformstringNo
DecidedAtUtcformDateTime?No
DecisionNoteformstringNo
CoverageGapEventInfo Parameters:
NameParameterData TypeRequiredDescription
EventTypeformstringNo
ChannelformstringNo
DetailformstringNo
ContactNameformstringNo
AtUtcformDateTimeNo
CoverageMoveOption Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
LabelformstringNo
DetailformstringNo
ExplformCoverageExplanationNo
CoverageNoShowState Parameters:
NameParameterData TypeRequiredDescription
GraceUntilUtcformDateTimeNo
AttemptsformList<CoverageNoShowAttempt>No
DeclaredAtUtcformDateTime?No
AttendanceNoteformboolNo
FalseAlarmformboolNo
CoverageNoShowAttempt Parameters:
NameParameterData TypeRequiredDescription
AtUtcformDateTimeNo
ChannelformstringNo
NoteformstringNo
CoverageLeaveState Parameters:
NameParameterData TypeRequiredDescription
FmlaformboolNo
BeganformDateTimeNo
EstReturnformDateTime?No
CheckpointDaysformintNo
NextCheckpointUtcformDateTime?No
CheckpointsformList<CoverageLeaveCheckpoint>No
InterimContactIdformint?No
InterimNameformstringNo
InterimStartformDateTime?No
InterimEndformDateTime?No
RequisitionOpenedformboolNo
StaffPostingIdformint?No
ChainedGapIdsformList<int>No
ParentLeaveGapIdformint?No
RestoredAtUtcformDateTime?No
CoverageLeaveCheckpoint Parameters:
NameParameterData TypeRequiredDescription
AtUtcformDateTimeNo
NoteformstringNo
ByNameformstringNo

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

POST /v1/coverage/leave/{CoverageGapId}/requisition HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
Content-Length: length

{"CoverageGapId":0}

HTTP/1.1 200 OK
Content-Type: application/json
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-01T00:00:00.0000000","WindowEnd":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","RespondedAtUtc":"0001-01-01T00:00:00.0000000"}],"Approvals":[{"CoverageApprovalId":0,"CoverageGapId":0,"Type":"String","Status":"String","RequestedAtUtc":"0001-01-01T00:00:00.0000000","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-01T00:00:00.0000000","DecisionNote":"String"}],"Timeline":[{"EventType":"String","Channel":"String","Detail":"String","ContactName":"String","AtUtc":"0001-01-01T00:00:00.0000000"}],"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-01T00:00:00.0000000","Attempts":[{"AtUtc":"0001-01-01T00:00:00.0000000","Channel":"String","Note":"String"}],"DeclaredAtUtc":"0001-01-01T00:00:00.0000000","AttendanceNote":false,"FalseAlarm":false},"Leave":{"Fmla":false,"Began":"0001-01-01T00:00:00.0000000","EstReturn":"0001-01-01T00:00:00.0000000","CheckpointDays":0,"NextCheckpointUtc":"0001-01-01T00:00:00.0000000","Checkpoints":[{"AtUtc":"0001-01-01T00:00:00.0000000","Note":"String","ByName":"String"}],"InterimContactId":0,"InterimName":"String","InterimStart":"0001-01-01T00:00:00.0000000","InterimEnd":"0001-01-01T00:00:00.0000000","RequisitionOpened":false,"StaffPostingId":0,"ChainedGapIds":[0],"ParentLeaveGapId":0,"RestoredAtUtc":"0001-01-01T00:00:00.0000000"},"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"}}}