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 java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CoverageSurgePreviewRequest
{
    open var ScopeDate:Date? = null
}

open class CoverageSurgePreviewResponse
{
    open var Banner:String? = null
    open var Title:String? = null
    open var Sub:String? = null
    open var Items:ArrayList<CoverageSurgeGap> = ArrayList<CoverageSurgeGap>()
    open var PoolCount:Int? = null
    open var Conseq:ArrayList<CoverageEffect> = ArrayList<CoverageEffect>()
    open var GuardLine:String? = null
    open var ResponseStatus:ResponseStatus? = null
}

open class CoverageSurgeGap
{
    open var CoverageGapId:Int? = null
    open var Label:String? = null
    open var Note:String? = null
    open var Track:String? = null
}

open class CoverageEffect
{
    open var Icon:String? = null
    open var Text:String? = null
    open var RuleId:String? = null
    open var Expl:CoverageExplanation? = null
}

open class CoverageExplanation
{
    open var PlainSentence:String? = null
    open var RuleId:String? = null
    open var RuleName:String? = null
    open var Demand:String? = null
    open var Source:CoverageExplanationSource? = null
    open var Kind:String? = null
    open var WhyItExists:String? = null
    open var WhatWouldChangeIt:String? = null
    open var Override:CoverageExplanationOverride? = null
    open var Drill:String? = null
}

open class CoverageExplanationSource
{
    open var PolicyName:String? = null
    open var CascadeLevel:String? = null
}

open class CoverageExplanationOverride
{
    open var Who:String? = null
    open var Consequence:String? = null
}

Kotlin 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
		}
	}
}