Trendsic Platform Service

<back to all web services

CoverageSurgePreviewRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/surge/preview
Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class CoverageEffect
            Public Overridable Property Icon As String
            Public Overridable Property Text As String
            Public Overridable Property RuleId As String
            Public Overridable Property Expl As CoverageExplanation
        End Class

        Public Partial Class CoverageExplanation
            Public Overridable Property PlainSentence As String
            Public Overridable Property RuleId As String
            Public Overridable Property RuleName As String
            Public Overridable Property Demand As String
            Public Overridable Property Source As CoverageExplanationSource
            Public Overridable Property Kind As String
            Public Overridable Property WhyItExists As String
            Public Overridable Property WhatWouldChangeIt As String
            Public Overridable Property Override As CoverageExplanationOverride
            Public Overridable Property Drill As String
        End Class

        Public Partial Class CoverageExplanationOverride
            Public Overridable Property Who As String
            Public Overridable Property Consequence As String
        End Class

        Public Partial Class CoverageExplanationSource
            Public Overridable Property PolicyName As String
            Public Overridable Property CascadeLevel As String
        End Class

        Public Partial Class CoverageSurgeGap
            Public Overridable Property CoverageGapId As Integer
            Public Overridable Property Label As String
            Public Overridable Property Note As String
            Public Overridable Property Track As String
        End Class

        Public Partial Class CoverageSurgePreviewRequest
            Public Overridable Property ScopeDate As Date?
        End Class

        Public Partial Class CoverageSurgePreviewResponse
            Public Overridable Property Banner As String
            Public Overridable Property Title As String
            Public Overridable Property [Sub] As String
            Public Overridable Property Items As List(Of CoverageSurgeGap) = New List(Of CoverageSurgeGap)
            Public Overridable Property PoolCount As Integer
            Public Overridable Property Conseq As List(Of CoverageEffect) = New List(Of CoverageEffect)
            Public Overridable Property GuardLine As String
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class
    End Namespace
End Namespace

VB.NET 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>