Trendsic Platform Service

<back to all web services

CoverageCascadeRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/cascade
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CoverageCascadeRequest
{
    open var CoveragePolicyId:Int? = null
    open var VersionNumber:Int? = null
}

open class CoverageCascadeResponse
{
    open var Policy:CoveragePolicy? = null
    open var Doc:CoveragePolicyDoc? = null
    open var VersionNumber:Int? = null
    open var Versions:ArrayList<CoveragePolicyVersionInfo> = ArrayList<CoveragePolicyVersionInfo>()
    open var ResponseStatus:ResponseStatus? = null
}

open class CoveragePolicy
{
    open var CoveragePolicyId:Int? = null
    open var CoveragePolicyUID:UUID? = null
    open var Name:String? = null
    open var ScopeLevel:String? = null
    open var BranchId:UUID? = null
    open var BranchName:String? = null
    open var WorkTypeKey:String? = null
    open var JobID:Int? = null
    open var JobName:String? = null
    open var CurrentVersion:Int? = null
    open var IsActive:Boolean? = null
    open var CreatedAt:Date? = null
    open var UpdatedAt:Date? = null
}

open class CoveragePolicyDoc
{
    open var Intro:String? = null
    open var LockLine:String? = null
    open var TemplateName:String? = null
    open var Prefs:CoveragePolicyPrefs? = null
    open var Rules:ArrayList<CoverageRuleDef> = ArrayList<CoverageRuleDef>()
}

open class CoveragePolicyPrefs
{
    open var AssignmentMode:String? = null
    open var RestHours:Int? = null
    open var OtThresholdHours:Int? = null
    open var RingWaitMinutes:Int? = null
    open var QuietStart:String? = null
    open var QuietEnd:String? = null
    open var RescheduleAllowed:Boolean? = null
    open var QuietMode:String? = null
    open var Rings:ArrayList<CoverageRingDef> = ArrayList<CoverageRingDef>()
}

open class CoverageRingDef
{
    open var Key:String? = null
    open var Label:String? = null
    open var Sub:String? = null
    open var WaitMinutes:Int? = null
    open var Enabled:Boolean? = null
}

open class CoverageRuleDef
{
    open var RuleId:String? = null
    open var Name:String? = null
    open var Kind:String? = null
    open var Demand:String? = null
    open var SourcePolicyName:String? = null
    open var CascadeLevel:String? = null
    open var Why:String? = null
    open var Change:String? = null
    open var OverrideWho:String? = null
    open var OverrideConsequence:String? = null
    open var NoNote:String? = null
    open var Params:HashMap<String,String> = HashMap<String,String>()
    open var Doc:ArrayList<CoverageRuleDocSection> = ArrayList<CoverageRuleDocSection>()
    open var Tune:CoverageRuleTune? = null
}

open class CoverageRuleDocSection
{
    open var H:String? = null
    open var T:String? = null
}

open class CoverageRuleTune
{
    open var Intro:String? = null
    open var Options:ArrayList<CoverageRuleTuneOption> = ArrayList<CoverageRuleTuneOption>()
}

open class CoverageRuleTuneOption
{
    open var Label:String? = null
    open var Sub:String? = null
}

open class CoveragePolicyVersionInfo
{
    open var CoveragePolicyVersionId:Int? = null
    open var CoveragePolicyId:Int? = null
    open var VersionNumber:Int? = null
    open var ChangeNote:String? = null
    open var ChangedByName:String? = null
    open var CreatedAtUtc:Date? = null
    open var Doc:CoveragePolicyDoc? = null
}

Kotlin CoverageCascadeRequest 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/cascade HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Policy: 
	{
		CoveragePolicyId: 0,
		CoveragePolicyUID: 00000000000000000000000000000000,
		Name: String,
		ScopeLevel: String,
		BranchId: 00000000000000000000000000000000,
		BranchName: String,
		WorkTypeKey: String,
		JobID: 0,
		JobName: String,
		CurrentVersion: 0,
		IsActive: False,
		CreatedAt: 0001-01-01,
		UpdatedAt: 0001-01-01
	},
	Doc: 
	{
		Intro: String,
		LockLine: String,
		TemplateName: String,
		Prefs: 
		{
			AssignmentMode: String,
			RestHours: 0,
			OtThresholdHours: 0,
			RingWaitMinutes: 0,
			QuietStart: String,
			QuietEnd: String,
			RescheduleAllowed: False,
			QuietMode: String,
			Rings: 
			[
				{
					Key: String,
					Label: String,
					Sub: String,
					WaitMinutes: 0,
					Enabled: False
				}
			]
		},
		Rules: 
		[
			{
				RuleId: String,
				Name: String,
				Kind: String,
				Demand: String,
				SourcePolicyName: String,
				CascadeLevel: String,
				Why: String,
				Change: String,
				OverrideWho: String,
				OverrideConsequence: String,
				NoNote: String,
				Params: 
				{
					String: String
				},
				Doc: 
				[
					{
						H: String,
						T: String
					}
				],
				Tune: 
				{
					Intro: String,
					Options: 
					[
						{
							Label: String,
							Sub: String
						}
					]
				}
			}
		]
	},
	VersionNumber: 0,
	Versions: 
	[
		{
			CoveragePolicyVersionId: 0,
			CoveragePolicyId: 0,
			VersionNumber: 0,
			ChangeNote: String,
			ChangedByName: String,
			CreatedAtUtc: 0001-01-01,
			Doc: 
			{
				Intro: String,
				LockLine: String,
				TemplateName: String,
				Prefs: 
				{
					AssignmentMode: String,
					RestHours: 0,
					OtThresholdHours: 0,
					RingWaitMinutes: 0,
					QuietStart: String,
					QuietEnd: String,
					RescheduleAllowed: False,
					QuietMode: String,
					Rings: 
					[
						{
							Key: String,
							Label: String,
							Sub: String,
							WaitMinutes: 0,
							Enabled: False
						}
					]
				},
				Rules: 
				[
					{
						RuleId: String,
						Name: String,
						Kind: String,
						Demand: String,
						SourcePolicyName: String,
						CascadeLevel: String,
						Why: String,
						Change: String,
						OverrideWho: String,
						OverrideConsequence: String,
						NoNote: String,
						Params: 
						{
							String: String
						},
						Doc: 
						[
							{
								H: String,
								T: String
							}
						],
						Tune: 
						{
							Intro: String,
							Options: 
							[
								{
									Label: String,
									Sub: String
								}
							]
						}
					}
				]
			}
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}