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 .xml suffix or ?format=xml

HTTP + XML

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/xml

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

<WeatherForecastResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AlertHeadline>String</AlertHeadline>
  <BranchName>String</BranchName>
  <Days>
    <WeatherDay>
      <Date>String</Date>
      <DayLabel>String</DayLabel>
      <HasAlert>false</HasAlert>
      <Pop>0</Pop>
      <Severity>String</Severity>
      <ShortForecast>String</ShortForecast>
      <TempHi>0</TempHi>
      <TempLo>0</TempLo>
      <TempUnit>String</TempUnit>
    </WeatherDay>
  </Days>
  <Resolved>false</Resolved>
  <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>
</WeatherForecastResponse>