Trendsic Platform Service

CoverageSurgePreviewRequest

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

**CoverageSurgePreviewRequest** Parameters:
Name	Parameter	Data Type	Required	Description
ScopeDate	query	DateTime?	No

**CoverageSurgePreviewResponse** Parameters:
Name	Parameter	Data Type	Required
Banner	form	string	No
Title	form	string	No
Sub	form	string	No
Items	form	List<CoverageSurgeGap>	No
PoolCount	form	int	No
Conseq	form	List<CoverageEffect>	No
GuardLine	form	string	No
ResponseStatus	form	ResponseStatus	No

**CoverageSurgeGap** Parameters:
Name	Parameter	Data Type	Required
CoverageGapId	form	int	No
Label	form	string	No
Note	form	string	No
Track	form	string	No

**CoverageEffect** Parameters:
Name	Parameter	Data Type	Required
Icon	form	string	No
Text	form	string	No
RuleId	form	string	No
Expl	form	CoverageExplanation	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

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/surge/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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

{
	Banner: String,
	Title: String,
	Sub: String,
	Items: 
	[
		{
			CoverageGapId: 0,
			Label: String,
			Note: String,
			Track: String
		}
	],
	PoolCount: 0,
	Conseq: 
	[
		{
			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
			}
		}
	],
	GuardLine: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}