Trendsic Platform Service

<back to all web services

CoverageSurgePreviewRequest

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

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class CoverageEffect
    {
        public virtual string Icon { get; set; }
        public virtual string Text { get; set; }
        public virtual string RuleId { get; set; }
        public virtual CoverageExplanation Expl { get; set; }
    }

    public partial class CoverageExplanation
    {
        public virtual string PlainSentence { get; set; }
        public virtual string RuleId { get; set; }
        public virtual string RuleName { get; set; }
        public virtual string Demand { get; set; }
        public virtual CoverageExplanationSource Source { get; set; }
        public virtual string Kind { get; set; }
        public virtual string WhyItExists { get; set; }
        public virtual string WhatWouldChangeIt { get; set; }
        public virtual CoverageExplanationOverride Override { get; set; }
        public virtual string Drill { get; set; }
    }

    public partial class CoverageExplanationOverride
    {
        public virtual string Who { get; set; }
        public virtual string Consequence { get; set; }
    }

    public partial class CoverageExplanationSource
    {
        public virtual string PolicyName { get; set; }
        public virtual string CascadeLevel { get; set; }
    }

    public partial class CoverageSurgeGap
    {
        public virtual int CoverageGapId { get; set; }
        public virtual string Label { get; set; }
        public virtual string Note { get; set; }
        public virtual string Track { get; set; }
    }

    public partial class CoverageSurgePreviewRequest
    {
        public virtual DateTime? ScopeDate { get; set; }
    }

    public partial class CoverageSurgePreviewResponse
    {
        public virtual string Banner { get; set; }
        public virtual string Title { get; set; }
        public virtual string Sub { get; set; }
        public virtual List<CoverageSurgeGap> Items { get; set; } = [];
        public virtual int PoolCount { get; set; }
        public virtual List<CoverageEffect> Conseq { get; set; } = [];
        public virtual string GuardLine { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

}

C# 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
		}
	}
}