Trendsic Platform Service

CoverageSurgePreviewRequest

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


export class CoverageSurgeGap
{
    public CoverageGapId: number;
    public Label: string;
    public Note: string;
    public Track: string;

    public constructor(init?: Partial<CoverageSurgeGap>) { (Object as any).assign(this, init); }
}

export class CoverageExplanationSource
{
    public PolicyName: string;
    public CascadeLevel: string;

    public constructor(init?: Partial<CoverageExplanationSource>) { (Object as any).assign(this, init); }
}

export class CoverageExplanationOverride
{
    public Who: string;
    public Consequence: string;

    public constructor(init?: Partial<CoverageExplanationOverride>) { (Object as any).assign(this, init); }
}

export class CoverageExplanation
{
    public PlainSentence: string;
    public RuleId: string;
    public RuleName: string;
    public Demand: string;
    public Source: CoverageExplanationSource;
    public Kind: string;
    public WhyItExists: string;
    public WhatWouldChangeIt: string;
    public Override: CoverageExplanationOverride;
    public Drill: string;

    public constructor(init?: Partial<CoverageExplanation>) { (Object as any).assign(this, init); }
}

export class CoverageEffect
{
    public Icon: string;
    public Text: string;
    public RuleId: string;
    public Expl: CoverageExplanation;

    public constructor(init?: Partial<CoverageEffect>) { (Object as any).assign(this, init); }
}

export class CoverageSurgePreviewResponse
{
    public Banner: string;
    public Title: string;
    public Sub: string;
    public Items: CoverageSurgeGap[] = [];
    public PoolCount: number;
    public Conseq: CoverageEffect[] = [];
    public GuardLine: string;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CoverageSurgePreviewResponse>) { (Object as any).assign(this, init); }
}

export class CoverageSurgePreviewRequest
{
    public ScopeDate?: string;

    public constructor(init?: Partial<CoverageSurgePreviewRequest>) { (Object as any).assign(this, init); }
}

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

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