Trendsic Platform Service

<back to all web services

CoverageSurgePreviewRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/surge/preview
CoverageSurgePreviewRequest Parameters:
NameParameterData TypeRequiredDescription
ScopeDatequeryDateTime?No
CoverageSurgePreviewResponse Parameters:
NameParameterData TypeRequiredDescription
BannerformstringNo
TitleformstringNo
SubformstringNo
ItemsformList<CoverageSurgeGap>No
PoolCountformintNo
ConseqformList<CoverageEffect>No
GuardLineformstringNo
ResponseStatusformResponseStatusNo
CoverageSurgeGap Parameters:
NameParameterData TypeRequiredDescription
CoverageGapIdformintNo
LabelformstringNo
NoteformstringNo
TrackformstringNo
CoverageEffect Parameters:
NameParameterData TypeRequiredDescription
IconformstringNo
TextformstringNo
RuleIdformstringNo
ExplformCoverageExplanationNo
CoverageExplanation Parameters:
NameParameterData TypeRequiredDescription
PlainSentenceformstringNo
RuleIdformstringNo
RuleNameformstringNo
DemandformstringNo
SourceformCoverageExplanationSourceNo
KindformstringNo
WhyItExistsformstringNo
WhatWouldChangeItformstringNo
OverrideformCoverageExplanationOverrideNo
DrillformstringNo
CoverageExplanationSource Parameters:
NameParameterData TypeRequiredDescription
PolicyNameformstringNo
CascadeLevelformstringNo
CoverageExplanationOverride Parameters:
NameParameterData TypeRequiredDescription
WhoformstringNo
ConsequenceformstringNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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/json
HTTP/1.1 200 OK
Content-Type: application/json
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"}}}