Trendsic Platform Service

<back to all web services

CoverageSurgePreviewRequest

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

public class CoverageSurgePreviewRequest : Codable
{
    public var scopeDate:Date?

    required public init(){}
}

public class CoverageSurgePreviewResponse : Codable
{
    public var banner:String
    public var title:String
    public var sub:String
    public var items:[CoverageSurgeGap] = []
    public var poolCount:Int
    public var conseq:[CoverageEffect] = []
    public var guardLine:String
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class CoverageSurgeGap : Codable
{
    public var coverageGapId:Int
    public var label:String
    public var note:String
    public var track:String

    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 CoverageSurgePreviewRequest 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/coverage/surge/preview HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CoverageSurgePreviewResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Banner>String</Banner>
  <Conseq>
    <CoverageEffect>
      <Expl>
        <Demand>String</Demand>
        <Drill>String</Drill>
        <Kind>String</Kind>
        <Override>
          <Consequence>String</Consequence>
          <Who>String</Who>
        </Override>
        <PlainSentence>String</PlainSentence>
        <RuleId>String</RuleId>
        <RuleName>String</RuleName>
        <Source>
          <CascadeLevel>String</CascadeLevel>
          <PolicyName>String</PolicyName>
        </Source>
        <WhatWouldChangeIt>String</WhatWouldChangeIt>
        <WhyItExists>String</WhyItExists>
      </Expl>
      <Icon>String</Icon>
      <RuleId>String</RuleId>
      <Text>String</Text>
    </CoverageEffect>
  </Conseq>
  <GuardLine>String</GuardLine>
  <Items>
    <CoverageSurgeGap>
      <CoverageGapId>0</CoverageGapId>
      <Label>String</Label>
      <Note>String</Note>
      <Track>String</Track>
    </CoverageSurgeGap>
  </Items>
  <PoolCount>0</PoolCount>
  <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>
  <Sub>String</Sub>
  <Title>String</Title>
</CoverageSurgePreviewResponse>