| 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 .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/weather/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
<CoverageWeatherPreviewResponse 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>
<CustomerCount>0</CustomerCount>
<Items>
<CoverageWeatherItem>
<CrewCount>0</CrewCount>
<JobID>0</JobID>
<JobName>String</JobName>
<MustFill>false</MustFill>
<Note>String</Note>
<PrevailingWage>false</PrevailingWage>
<Tone>String</Tone>
</CoverageWeatherItem>
</Items>
<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>
<ScopeLine>String</ScopeLine>
</CoverageWeatherPreviewResponse>