Trendsic Platform Service

<back to all web services

CoverageTemplatesRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/policies/templates

export class CoverageRingDef
{
    public Key: string;
    public Label: string;
    public Sub: string;
    public WaitMinutes?: number;
    public Enabled: boolean;

    public constructor(init?: Partial<CoverageRingDef>) { (Object as any).assign(this, init); }
}

export class CoveragePolicyPrefs
{
    public AssignmentMode: string;
    public RestHours: number;
    public OtThresholdHours: number;
    public RingWaitMinutes: number;
    public QuietStart: string;
    public QuietEnd: string;
    public RescheduleAllowed: boolean;
    public QuietMode: string;
    public Rings: CoverageRingDef[] = [];

    public constructor(init?: Partial<CoveragePolicyPrefs>) { (Object as any).assign(this, init); }
}

export class CoverageRuleDocSection
{
    public H: string;
    public T: string;

    public constructor(init?: Partial<CoverageRuleDocSection>) { (Object as any).assign(this, init); }
}

export class CoverageRuleTuneOption
{
    public Label: string;
    public Sub: string;

    public constructor(init?: Partial<CoverageRuleTuneOption>) { (Object as any).assign(this, init); }
}

export class CoverageRuleTune
{
    public Intro: string;
    public Options: CoverageRuleTuneOption[] = [];

    public constructor(init?: Partial<CoverageRuleTune>) { (Object as any).assign(this, init); }
}

export class CoverageRuleDef
{
    public RuleId: string;
    public Name: string;
    public Kind: string;
    public Demand: string;
    public SourcePolicyName: string;
    public CascadeLevel: string;
    public Why: string;
    public Change: string;
    public OverrideWho: string;
    public OverrideConsequence: string;
    public NoNote: string;
    public Params: { [index:string]: string; } = {};
    public Doc: CoverageRuleDocSection[] = [];
    public Tune: CoverageRuleTune;

    public constructor(init?: Partial<CoverageRuleDef>) { (Object as any).assign(this, init); }
}

export class CoveragePolicyDoc
{
    public Intro: string;
    public LockLine: string;
    public TemplateName: string;
    public Prefs: CoveragePolicyPrefs;
    public Rules: CoverageRuleDef[] = [];

    public constructor(init?: Partial<CoveragePolicyDoc>) { (Object as any).assign(this, init); }
}

export class CoverageTemplateInfo
{
    public Key: string;
    public Name: string;
    public Sub: string;
    public Doc: CoveragePolicyDoc;

    public constructor(init?: Partial<CoverageTemplateInfo>) { (Object as any).assign(this, init); }
}

export class CoverageTemplatesResponse
{
    public Templates: CoverageTemplateInfo[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CoverageTemplatesResponse>) { (Object as any).assign(this, init); }
}

export class CoverageTemplatesRequest
{

    public constructor(init?: Partial<CoverageTemplatesRequest>) { (Object as any).assign(this, init); }
}

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

{
	Templates: 
	[
		{
			Key: String,
			Name: String,
			Sub: String,
			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
		}
	}
}