Trendsic Platform Service

<back to all web services

CoverageWeatherPreviewRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/weather/preview

export class CoverageWeatherItem
{
    public JobID: number;
    public JobName: string;
    public CrewCount: number;
    public Note: string;
    public Tone: string;
    public MustFill: boolean;
    public PrevailingWage: boolean;

    public constructor(init?: Partial<CoverageWeatherItem>) { (Object as any).assign(this, init); }
}

export class CoverageExplanationSource
{
    public PolicyName: string;
    public CascadeLevel: string;

    public constructor(init?: Partial<CoverageExplanationSource>) { (Object as any).assign(this, init); }
}

export class CoverageExplanationOverride
{
    public Who: string;
    public Consequence: string;

    public constructor(init?: Partial<CoverageExplanationOverride>) { (Object as any).assign(this, init); }
}

export class CoverageExplanation
{
    public PlainSentence: string;
    public RuleId: string;
    public RuleName: string;
    public Demand: string;
    public Source: CoverageExplanationSource;
    public Kind: string;
    public WhyItExists: string;
    public WhatWouldChangeIt: string;
    public Override: CoverageExplanationOverride;
    public Drill: string;

    public constructor(init?: Partial<CoverageExplanation>) { (Object as any).assign(this, init); }
}

export class CoverageEffect
{
    public Icon: string;
    public Text: string;
    public RuleId: string;
    public Expl: CoverageExplanation;

    public constructor(init?: Partial<CoverageEffect>) { (Object as any).assign(this, init); }
}

export class CoverageWeatherPreviewResponse
{
    public Banner: string;
    public ScopeLine: string;
    public Items: CoverageWeatherItem[] = [];
    public Conseq: CoverageEffect[] = [];
    public CustomerCount: number;
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CoverageWeatherPreviewResponse>) { (Object as any).assign(this, init); }
}

export class CoverageWeatherPreviewRequest
{
    public ScopeDate: string;
    public BranchId?: string;

    public constructor(init?: Partial<CoverageWeatherPreviewRequest>) { (Object as any).assign(this, init); }
}

TypeScript CoverageWeatherPreviewRequest DTOs

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"}}}