Trendsic Platform Service

CoveragePolicyCreateRequest

The following routes are available for this service:
POST	/v1/coverage/policies

**CoveragePolicyCreateRequest** Parameters:
Name	Parameter	Data Type	Required
Name	body	string	No
ScopeLevel	body	string	No
BranchId	body	Guid?	No
WorkTypeKey	body	string	No
JobID	body	int?	No
Doc	body	CoveragePolicyDoc	No
ChangeNote	body	string	No

**CoveragePolicyDoc** Parameters:
Name	Parameter	Data Type	Required
Intro	form	string	No
LockLine	form	string	No
TemplateName	form	string	No
Prefs	form	CoveragePolicyPrefs	No
Rules	form	List<CoverageRuleDef>	No

**CoveragePolicyPrefs** Parameters:
Name	Parameter	Data Type	Required
AssignmentMode	form	string	No
RestHours	form	int	No
OtThresholdHours	form	int	No
RingWaitMinutes	form	int	No
QuietStart	form	string	No
QuietEnd	form	string	No
RescheduleAllowed	form	bool	No
QuietMode	form	string	No
Rings	form	List<CoverageRingDef>	No

**CoverageRingDef** Parameters:
Name	Parameter	Data Type	Required
Key	form	string	No
Label	form	string	No
Sub	form	string	No
WaitMinutes	form	int?	No
Enabled	form	bool	No

**CoverageRuleDef** Parameters:
Name	Parameter	Data Type	Required
RuleId	form	string	No
Name	form	string	No
Kind	form	string	No
Demand	form	string	No
SourcePolicyName	form	string	No
CascadeLevel	form	string	No
Why	form	string	No
Change	form	string	No
OverrideWho	form	string	No
OverrideConsequence	form	string	No
NoNote	form	string	No
Params	form	Dictionary<string, string>	No
Doc	form	List<CoverageRuleDocSection>	No
Tune	form	CoverageRuleTune	No

**CoverageRuleDocSection** Parameters:
Name	Parameter	Data Type	Required	Description
H	form	string	No
T	form	string	No

**CoverageRuleTune** Parameters:
Name	Parameter	Data Type	Required	Description
Intro	form	string	No
Options	form	List<CoverageRuleTuneOption>	No

**CoverageRuleTuneOption** Parameters:
Name	Parameter	Data Type	Required	Description
Label	form	string	No
Sub	form	string	No

**CoverageCascadeResponse** Parameters:
Name	Parameter	Data Type	Required
Policy	form	CoveragePolicy	No
Doc	form	CoveragePolicyDoc	No
VersionNumber	form	int	No
Versions	form	List<CoveragePolicyVersionInfo>	No
ResponseStatus	form	ResponseStatus	No

**CoveragePolicy** Parameters:
Name	Parameter	Data Type	Required
CoveragePolicyId	form	int	No
CoveragePolicyUID	form	Guid	No
Name	form	string	No
ScopeLevel	form	string	No
BranchId	form	Guid?	No
BranchName	form	string	No
WorkTypeKey	form	string	No
JobID	form	int?	No
JobName	form	string	No
CurrentVersion	form	int	No
IsActive	form	bool	No
CreatedAt	form	DateTime	No
UpdatedAt	form	DateTime?	No

**CoveragePolicyVersionInfo** Parameters:
Name	Parameter	Data Type	Required
CoveragePolicyVersionId	form	int	No
CoveragePolicyId	form	int	No
VersionNumber	form	int	No
ChangeNote	form	string	No
ChangedByName	form	string	No
CreatedAtUtc	form	DateTime	No
Doc	form	CoveragePolicyDoc	No

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.

POST /v1/coverage/policies HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	Name: String,
	ScopeLevel: String,
	BranchId: 00000000000000000000000000000000,
	WorkTypeKey: String,
	JobID: 0,
	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
						}
					]
				}
			}
		]
	},
	ChangeNote: String
}

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