Trendsic Platform Service

<back to all web services

CoverageTemplatesRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/policies/templates
CoverageTemplatesResponse Parameters:
NameParameterData TypeRequiredDescription
TemplatesformList<CoverageTemplateInfo>No
ResponseStatusformResponseStatusNo
CoverageTemplateInfo Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
NameformstringNo
SubformstringNo
DocformCoveragePolicyDocNo
CoveragePolicyDoc Parameters:
NameParameterData TypeRequiredDescription
IntroformstringNo
LockLineformstringNo
TemplateNameformstringNo
PrefsformCoveragePolicyPrefsNo
RulesformList<CoverageRuleDef>No
CoveragePolicyPrefs Parameters:
NameParameterData TypeRequiredDescription
AssignmentModeformstringNo
RestHoursformintNo
OtThresholdHoursformintNo
RingWaitMinutesformintNo
QuietStartformstringNo
QuietEndformstringNo
RescheduleAllowedformboolNo
QuietModeformstringNo
RingsformList<CoverageRingDef>No
CoverageRingDef Parameters:
NameParameterData TypeRequiredDescription
KeyformstringNo
LabelformstringNo
SubformstringNo
WaitMinutesformint?No
EnabledformboolNo
CoverageRuleDef Parameters:
NameParameterData TypeRequiredDescription
RuleIdformstringNo
NameformstringNo
KindformstringNo
DemandformstringNo
SourcePolicyNameformstringNo
CascadeLevelformstringNo
WhyformstringNo
ChangeformstringNo
OverrideWhoformstringNo
OverrideConsequenceformstringNo
NoNoteformstringNo
ParamsformDictionary<string, string>No
DocformList<CoverageRuleDocSection>No
TuneformCoverageRuleTuneNo
CoverageRuleDocSection Parameters:
NameParameterData TypeRequiredDescription
HformstringNo
TformstringNo
CoverageRuleTune Parameters:
NameParameterData TypeRequiredDescription
IntroformstringNo
OptionsformList<CoverageRuleTuneOption>No
CoverageRuleTuneOption Parameters:
NameParameterData TypeRequiredDescription
LabelformstringNo
SubformstringNo

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