Trendsic Platform Service

CoverageGapsRequest

The following routes are available for this service:
GET	/v1/coverage/gaps

**CoverageGapsRequest** Parameters:
Name	Parameter	Data Type	Required	Description
BranchId	query	Guid?	No

**CoverageGapsResponse** Parameters:
Name	Parameter	Data Type	Required
Gaps	form	List<CoverageGap>	No
PolicyName	form	string	No
LockLine	form	string	No
AssignmentMode	form	string	No
CanApprove	form	bool	No
CanEditPolicy	form	bool	No
CanSeePay	form	bool	No
ResponseStatus	form	ResponseStatus	No

**CoverageGap** Parameters:
Name	Parameter	Data Type	Required
CoverageGapId	form	int	No
CoverageGapUID	form	Guid	No
BranchId	form	Guid?	No
Status	form	string	No
Track	form	string	No
OutContactID	form	int?	No
OutName	form	string	No
OutInitials	form	string	No
JobID	form	int?	No
JobName	form	string	No
ProjectID	form	int?	No
WorkerScheduleItemID	form	int?	No
WindowStart	form	DateTime	No
WindowEnd	form	DateTime	No
Reason	form	string	No
MustFill	form	bool	No
MustFillExpl	form	CoverageExplanation	No
FilledByContactID	form	int?	No
FilledByName	form	string	No
RecordNo	form	string	No
DecidedPolicyVersionId	form	int?	No
CreatedAt	form	DateTime	No
UpdatedAt	form	DateTime?	No
QualifiedLine	form	string	No
Candidates	form	List<CoverageCandidate>	No
Blocked	form	List<CoverageBlockedCandidate>	No
Offers	form	List<CoverageOfferInfo>	No
Approvals	form	List<CoverageApprovalInfo>	No
Timeline	form	List<CoverageGapEventInfo>	No
MoveOptions	form	List<CoverageMoveOption>	No
OrderExpl	form	CoverageExplanation	No
AssignmentMode	form	string	No
NoShow	form	CoverageNoShowState	No
Leave	form	CoverageLeaveState	No
CustomerName	form	string	No

**CoverageExplanation** Parameters:
Name	Parameter	Data Type	Required
PlainSentence	form	string	No
RuleId	form	string	No
RuleName	form	string	No
Demand	form	string	No
Source	form	CoverageExplanationSource	No
Kind	form	string	No
WhyItExists	form	string	No
WhatWouldChangeIt	form	string	No
Override	form	CoverageExplanationOverride	No
Drill	form	string	No

**CoverageExplanationSource** Parameters:
Name	Parameter	Data Type	Required	Description
PolicyName	form	string	No
CascadeLevel	form	string	No

**CoverageExplanationOverride** Parameters:
Name	Parameter	Data Type	Required	Description
Who	form	string	No
Consequence	form	string	No

**CoverageCandidate** Parameters:
Name	Parameter	Data Type	Required
ContactId	form	int	No
Name	form	string	No
FirstName	form	string	No
Initials	form	string	No
Rank	form	int	No
DiffLine	form	string	No
CostLine	form	string	No
CostTone	form	string	No
RankExpl	form	CoverageExplanation	No
MarginPct	form	decimal?	No
MarginTone	form	string	No
Loaded	form	decimal?	No
Billed	form	decimal?	No
OtHours	form	decimal?	No
OtPremium	form	decimal?	No
Checks	form	List<CoverageCandidateCheck>	No
Preview	form	List<CoverageEffect>	No
Confirm	form	List<CoverageEffect>	No
HasWarn	form	bool	No

**CoverageCandidateCheck** Parameters:
Name	Parameter	Data Type	Required
CheckId	form	string	No
Result	form	string	No
Expl	form	CoverageExplanation	No

**CoverageEffect** Parameters:
Name	Parameter	Data Type	Required
Icon	form	string	No
Text	form	string	No
RuleId	form	string	No
Expl	form	CoverageExplanation	No

**CoverageBlockedCandidate** Parameters:
Name	Parameter	Data Type	Required
ContactId	form	int	No
Name	form	string	No
Initials	form	string	No
Reason	form	string	No
ChangeChip	form	string	No
Expl	form	CoverageExplanation	No

**CoverageOfferInfo** Parameters:
Name	Parameter	Data Type	Required
CoverageOfferId	form	int	No
ContactId	form	int	No
Name	form	string	No
Ring	form	int	No
Channel	form	string	No
Status	form	string	No
SentAtUtc	form	DateTime	No
RespondedAtUtc	form	DateTime?	No

**CoverageApprovalInfo** Parameters:
Name	Parameter	Data Type	Required
CoverageApprovalId	form	int	No
CoverageGapId	form	int	No
Type	form	string	No
Status	form	string	No
RequestedAtUtc	form	DateTime	No
Effects	form	List<CoverageEffect>	No
ContactId	form	int?	No
ContactName	form	string	No
DecidedAtUtc	form	DateTime?	No
DecisionNote	form	string	No

**CoverageGapEventInfo** Parameters:
Name	Parameter	Data Type	Required
EventType	form	string	No
Channel	form	string	No
Detail	form	string	No
ContactName	form	string	No
AtUtc	form	DateTime	No

**CoverageMoveOption** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Label	form	string	No
Detail	form	string	No
Expl	form	CoverageExplanation	No

**CoverageNoShowState** Parameters:
Name	Parameter	Data Type	Required
GraceUntilUtc	form	DateTime	No
Attempts	form	List<CoverageNoShowAttempt>	No
DeclaredAtUtc	form	DateTime?	No
AttendanceNote	form	bool	No
FalseAlarm	form	bool	No

**CoverageNoShowAttempt** Parameters:
Name	Parameter	Data Type	Required
AtUtc	form	DateTime	No
Channel	form	string	No
Note	form	string	No

**CoverageLeaveState** Parameters:
Name	Parameter	Data Type	Required
Fmla	form	bool	No
Began	form	DateTime	No
EstReturn	form	DateTime?	No
CheckpointDays	form	int	No
NextCheckpointUtc	form	DateTime?	No
Checkpoints	form	List<CoverageLeaveCheckpoint>	No
InterimContactId	form	int?	No
InterimName	form	string	No
InterimStart	form	DateTime?	No
InterimEnd	form	DateTime?	No
RequisitionOpened	form	bool	No
StaffPostingId	form	int?	No
ChainedGapIds	form	List<int>	No
ParentLeaveGapId	form	int?	No
RestoredAtUtc	form	DateTime?	No

**CoverageLeaveCheckpoint** Parameters:
Name	Parameter	Data Type	Required
AtUtc	form	DateTime	No
Note	form	string	No
ByName	form	string	No

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.

GET /v1/coverage/gaps HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Gaps: 
	[
		{
			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
		}
	],
	PolicyName: String,
	LockLine: String,
	AssignmentMode: String,
	CanApprove: False,
	CanEditPolicy: False,
	CanSeePay: False,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}