Trendsic Platform Service

<back to all web services

BranchWeatherRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/weather/branch
"use strict";
export class WeatherDay {
    /** @param {{Date?:string,DayLabel?:string,ShortForecast?:string,TempHi?:number,TempLo?:number,TempUnit?:string,Pop?:number,Severity?:string,HasAlert?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Date;
    /** @type {string} */
    DayLabel;
    /** @type {string} */
    ShortForecast;
    /** @type {?number} */
    TempHi;
    /** @type {?number} */
    TempLo;
    /** @type {string} */
    TempUnit;
    /** @type {?number} */
    Pop;
    /** @type {string} */
    Severity;
    /** @type {boolean} */
    HasAlert;
}
export class WeatherForecastResponse {
    /** @param {{BranchName?:string,Resolved?:boolean,AlertHeadline?:string,Days?:WeatherDay[],ResponseStatus?:ResponseStatus}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    BranchName;
    /** @type {boolean} */
    Resolved;
    /** @type {string} */
    AlertHeadline;
    /** @type {WeatherDay[]} */
    Days = [];
    /** @type {ResponseStatus} */
    ResponseStatus;
}
export class BranchWeatherRequest {
    /** @param {{BranchId?:string,Start?:string,Days?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    BranchId;
    /** @type {string} */
    Start;
    /** @type {?number} */
    Days;
}

JavaScript BranchWeatherRequest DTOs

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/weather/branch HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json

HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"BranchName":"String","Resolved":false,"AlertHeadline":"String","Days":[{"Date":"String","DayLabel":"String","ShortForecast":"String","TempHi":0,"TempLo":0,"TempUnit":"String","Pop":0,"Severity":"String","HasAlert":false}],"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}