| 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 .xml suffix or ?format=xml
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: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CoverageSurgePreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Banner>String</Banner>
<Conseq>
<CoverageEffect>
<Expl>
<Demand>String</Demand>
<Drill>String</Drill>
<Kind>String</Kind>
<Override>
<Consequence>String</Consequence>
<Who>String</Who>
</Override>
<PlainSentence>String</PlainSentence>
<RuleId>String</RuleId>
<RuleName>String</RuleName>
<Source>
<CascadeLevel>String</CascadeLevel>
<PolicyName>String</PolicyName>
</Source>
<WhatWouldChangeIt>String</WhatWouldChangeIt>
<WhyItExists>String</WhyItExists>
</Expl>
<Icon>String</Icon>
<RuleId>String</RuleId>
<Text>String</Text>
</CoverageEffect>
</Conseq>
<GuardLine>String</GuardLine>
<Items>
<CoverageSurgeGap>
<CoverageGapId>0</CoverageGapId>
<Label>String</Label>
<Note>String</Note>
<Track>String</Track>
</CoverageSurgeGap>
</Items>
<PoolCount>0</PoolCount>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Sub>String</Sub>
<Title>String</Title>
</CoverageSurgePreviewResponse>