Trendsic Platform Service

<back to all web services

CoverageWeatherPreviewRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/weather/preview
CoverageWeatherPreviewRequest Parameters:
NameParameterData TypeRequiredDescription
ScopeDatequeryDateTimeNo
BranchIdqueryGuid?No
CoverageWeatherPreviewResponse Parameters:
NameParameterData TypeRequiredDescription
BannerformstringNo
ScopeLineformstringNo
ItemsformList<CoverageWeatherItem>No
ConseqformList<CoverageEffect>No
CustomerCountformintNo
ResponseStatusformResponseStatusNo
CoverageWeatherItem Parameters:
NameParameterData TypeRequiredDescription
JobIDformintNo
JobNameformstringNo
CrewCountformintNo
NoteformstringNo
ToneformstringNo
MustFillformboolNo
PrevailingWageformboolNo
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 .csv suffix or ?format=csv

HTTP + CSV

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

GET /v1/coverage/weather/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
Content-Length: length

{"Banner":"String","ScopeLine":"String","Items":[{"JobID":0,"JobName":"String","CrewCount":0,"Note":"String","Tone":"String","MustFill":false,"PrevailingWage":false}],"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"}}],"CustomerCount":0,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}