| GET | /v1/coverage/weather/preview |
|---|
"use strict";
export class CoverageWeatherItem {
/** @param {{JobID?:number,JobName?:string,CrewCount?:number,Note?:string,Tone?:string,MustFill?:boolean,PrevailingWage?:boolean}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {number} */
JobID;
/** @type {string} */
JobName;
/** @type {number} */
CrewCount;
/** @type {string} */
Note;
/** @type {string} */
Tone;
/** @type {boolean} */
MustFill;
/** @type {boolean} */
PrevailingWage;
}
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 CoverageWeatherPreviewResponse {
/** @param {{Banner?:string,ScopeLine?:string,Items?:CoverageWeatherItem[],Conseq?:CoverageEffect[],CustomerCount?:number,ResponseStatus?:ResponseStatus}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
Banner;
/** @type {string} */
ScopeLine;
/** @type {CoverageWeatherItem[]} */
Items = [];
/** @type {CoverageEffect[]} */
Conseq = [];
/** @type {number} */
CustomerCount;
/** @type {ResponseStatus} */
ResponseStatus;
}
export class CoverageWeatherPreviewRequest {
/** @param {{ScopeDate?:string,BranchId?:string}} [init] */
constructor(init) { Object.assign(this, init) }
/** @type {string} */
ScopeDate;
/** @type {?string} */
BranchId;
}
JavaScript CoverageWeatherPreviewRequest DTOs
To override the Content-type in your clients, use the HTTP Accept Header, append the .csv suffix or ?format=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"}}}