Trendsic Platform Service

<back to all web services

CoveragePolicyCreateRequest

Requires Authentication
The following routes are available for this service:
POST/v1/coverage/policies
CoveragePolicyCreateRequest Parameters:
NameParameterData TypeRequiredDescription
NamebodystringNo
ScopeLevelbodystringNo
BranchIdbodyGuid?No
WorkTypeKeybodystringNo
JobIDbodyint?No
DocbodyCoveragePolicyDocNo
ChangeNotebodystringNo
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
CoverageCascadeResponse Parameters:
NameParameterData TypeRequiredDescription
PolicyformCoveragePolicyNo
DocformCoveragePolicyDocNo
VersionNumberformintNo
VersionsformList<CoveragePolicyVersionInfo>No
ResponseStatusformResponseStatusNo
CoveragePolicy Parameters:
NameParameterData TypeRequiredDescription
CoveragePolicyIdformintNo
CoveragePolicyUIDformGuidNo
NameformstringNo
ScopeLevelformstringNo
BranchIdformGuid?No
BranchNameformstringNo
WorkTypeKeyformstringNo
JobIDformint?No
JobNameformstringNo
CurrentVersionformintNo
IsActiveformboolNo
CreatedAtformDateTimeNo
UpdatedAtformDateTime?No
CoveragePolicyVersionInfo Parameters:
NameParameterData TypeRequiredDescription
CoveragePolicyVersionIdformintNo
CoveragePolicyIdformintNo
VersionNumberformintNo
ChangeNoteformstringNo
ChangedByNameformstringNo
CreatedAtUtcformDateTimeNo
DocformCoveragePolicyDocNo

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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: application/json
Content-Type: application/json
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: application/json
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-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000"},"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-01T00:00:00.0000000","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"}}}