| GET | /v1/coverage/surge/preview |
|---|
"use strict";
export class CoverageSurgeGap {
/** @param {{CoverageGapId?:number,Label?:string,Note?:string,Track?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
CoverageGapId;
/** @type {string} */
Label;
/** @type {string} */
Note;
/** @type {string} */
Track;
}
export class CoverageExplanationSource {
/** @param {{PolicyName?:string,CascadeLevel?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PolicyName;
/** @type {string} */
CascadeLevel;
}
export class CoverageExplanationOverride {
/** @param {{Who?:string,Consequence?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Who;
/** @type {string} */
Consequence;
}
export class CoverageExplanation {
/** @param {{PlainSentence?:string,RuleId?:string,RuleName?:string,Demand?:string,Source?:CoverageExplanationSource,Kind?:string,WhyItExists?:string,WhatWouldChangeIt?:string,Override?:CoverageExplanationOverride,Drill?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
PlainSentence;
/** @type {string} */
RuleId;
/** @type {string} */
RuleName;
/** @type {string} */
Demand;
/** @type {CoverageExplanationSource} */
Source;
/** @type {string} */
Kind;
/** @type {string} */
WhyItExists;
/** @type {string} */
WhatWouldChangeIt;
/** @type {CoverageExplanationOverride} */
Override;
/** @type {string} */
Drill;
}
export class CoverageEffect {
/** @param {{Icon?:string,Text?:string,RuleId?:string,Expl?:CoverageExplanation}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Icon;
/** @type {string} */
Text;
/** @type {string} */
RuleId;
/** @type {CoverageExplanation} */
Expl;
}
export class CoverageSurgePreviewResponse {
/** @param {{Banner?:string,Title?:string,Sub?:string,Items?:CoverageSurgeGap[],PoolCount?:number,Conseq?:CoverageEffect[],GuardLine?:string,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Banner;
/** @type {string} */
Title;
/** @type {string} */
Sub;
/** @type {CoverageSurgeGap[]} */
Items = [];
/** @type {number} */
PoolCount;
/** @type {CoverageEffect[]} */
Conseq = [];
/** @type {string} */
GuardLine;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class CoverageSurgePreviewRequest {
/** @param {{ScopeDate?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {?string} */
ScopeDate;
}
JavaScript CoverageSurgePreviewRequest 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.
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
}
}
}