| GET | /v1/coverage/weather/preview |
|---|
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| ScopeDate | query | DateTime | No | |
| BranchId | query | Guid? | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Banner | form | string | No | |
| ScopeLine | form | string | No | |
| Items | form | List<CoverageWeatherItem> | No | |
| Conseq | form | List<CoverageEffect> | No | |
| CustomerCount | form | int | No | |
| ResponseStatus | form | ResponseStatus | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| JobID | form | int | No | |
| JobName | form | string | No | |
| CrewCount | form | int | No | |
| Note | form | string | No | |
| Tone | form | string | No | |
| MustFill | form | bool | No | |
| PrevailingWage | form | bool | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Icon | form | string | No | |
| Text | form | string | No | |
| RuleId | form | string | No | |
| Expl | form | CoverageExplanation | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PlainSentence | form | string | No | |
| RuleId | form | string | No | |
| RuleName | form | string | No | |
| Demand | form | string | No | |
| Source | form | CoverageExplanationSource | No | |
| Kind | form | string | No | |
| WhyItExists | form | string | No | |
| WhatWouldChangeIt | form | string | No | |
| Override | form | CoverageExplanationOverride | No | |
| Drill | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| PolicyName | form | string | No | |
| CascadeLevel | form | string | No |
| Name | Parameter | Data Type | Required | Description |
|---|---|---|---|---|
| Who | form | string | No | |
| Consequence | form | string | No |
To override the Content-type in your clients, use the HTTP Accept Header, append the .jsv suffix or ?format=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
}
}
}