Trendsic Platform Service

<back to all web services

CoverageSurgePreviewRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/surge/preview
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CoverageSurgeGap() = 
        member val CoverageGapId:Int32 = new Int32() with get,set
        member val Label:String = null with get,set
        member val Note:String = null with get,set
        member val Track:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageExplanationSource() = 
        member val PolicyName:String = null with get,set
        member val CascadeLevel:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageExplanationOverride() = 
        member val Who:String = null with get,set
        member val Consequence:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageExplanation() = 
        member val PlainSentence:String = null with get,set
        member val RuleId:String = null with get,set
        member val RuleName:String = null with get,set
        member val Demand:String = null with get,set
        member val Source:CoverageExplanationSource = null with get,set
        member val Kind:String = null with get,set
        member val WhyItExists:String = null with get,set
        member val WhatWouldChangeIt:String = null with get,set
        member val Override:CoverageExplanationOverride = null with get,set
        member val Drill:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageEffect() = 
        member val Icon:String = null with get,set
        member val Text:String = null with get,set
        member val RuleId:String = null with get,set
        member val Expl:CoverageExplanation = null with get,set

    [<AllowNullLiteral>]
    type CoverageSurgePreviewResponse() = 
        member val Banner:String = null with get,set
        member val Title:String = null with get,set
        member val Sub:String = null with get,set
        member val Items:ResizeArray<CoverageSurgeGap> = new ResizeArray<CoverageSurgeGap>() with get,set
        member val PoolCount:Int32 = new Int32() with get,set
        member val Conseq:ResizeArray<CoverageEffect> = new ResizeArray<CoverageEffect>() with get,set
        member val GuardLine:String = null with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CoverageSurgePreviewRequest() = 
        member val ScopeDate:Nullable<DateTime> = new Nullable<DateTime>() with get,set

F# CoverageSurgePreviewRequest 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/surge/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,
	Title: String,
	Sub: String,
	Items: 
	[
		{
			CoverageGapId: 0,
			Label: String,
			Note: String,
			Track: String
		}
	],
	PoolCount: 0,
	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
			}
		}
	],
	GuardLine: String,
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}