Trendsic Platform Service

<back to all web services

CoverageWeatherPreviewRequest

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

public class CoverageWeatherPreviewRequest : Codable
{
    public var scopeDate:Date
    public var branchId:String?

    required public init(){}
}

public class CoverageWeatherPreviewResponse : Codable
{
    public var banner:String
    public var scopeLine:String
    public var items:[CoverageWeatherItem] = []
    public var conseq:[CoverageEffect] = []
    public var customerCount:Int
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class CoverageWeatherItem : Codable
{
    public var jobID:Int
    public var jobName:String
    public var crewCount:Int
    public var note:String
    public var tone:String
    public var mustFill:Bool
    public var prevailingWage:Bool

    required public init(){}
}

public class CoverageEffect : Codable
{
    public var icon:String
    public var text:String
    public var ruleId:String
    public var expl:CoverageExplanation

    required public init(){}
}

public class CoverageExplanation : Codable
{
    public var plainSentence:String
    public var ruleId:String
    public var ruleName:String
    public var demand:String
    public var source:CoverageExplanationSource
    public var kind:String
    public var whyItExists:String
    public var whatWouldChangeIt:String
    public var `override`:CoverageExplanationOverride
    public var drill:String

    required public init(){}
}

public class CoverageExplanationSource : Codable
{
    public var policyName:String
    public var cascadeLevel:String

    required public init(){}
}

public class CoverageExplanationOverride : Codable
{
    public var who:String
    public var consequence:String

    required public init(){}
}


Swift CoverageWeatherPreviewRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=jsv

HTTP + JSV

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/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
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
		}
	}
}