Trendsic Platform Service

CoveragePolicySaveRequest

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

import Foundation
import ServiceStack

public class CoveragePolicySaveRequest : Codable
{
    public var coveragePolicyId:Int
    public var doc:CoveragePolicyDoc
    public var changeNote:String

    required public init(){}
}

public class CoveragePolicyDoc : Codable
{
    public var intro:String
    public var lockLine:String
    public var templateName:String
    public var prefs:CoveragePolicyPrefs
    public var rules:[CoverageRuleDef] = []

    required public init(){}
}

public class CoveragePolicyPrefs : Codable
{
    public var assignmentMode:String
    public var restHours:Int
    public var otThresholdHours:Int
    public var ringWaitMinutes:Int
    public var quietStart:String
    public var quietEnd:String
    public var rescheduleAllowed:Bool
    public var quietMode:String
    public var rings:[CoverageRingDef] = []

    required public init(){}
}

public class CoverageRingDef : Codable
{
    public var key:String
    public var label:String
    public var sub:String
    public var waitMinutes:Int?
    public var enabled:Bool

    required public init(){}
}

public class CoverageRuleDef : Codable
{
    public var ruleId:String
    public var name:String
    public var kind:String
    public var demand:String
    public var sourcePolicyName:String
    public var cascadeLevel:String
    public var why:String
    public var change:String
    public var overrideWho:String
    public var overrideConsequence:String
    public var noNote:String
    public var params:[String:String] = [:]
    public var doc:[CoverageRuleDocSection] = []
    public var tune:CoverageRuleTune

    required public init(){}
}

public class CoverageRuleDocSection : Codable
{
    public var h:String
    public var t:String

    required public init(){}
}

public class CoverageRuleTune : Codable
{
    public var intro:String
    public var options:[CoverageRuleTuneOption] = []

    required public init(){}
}

public class CoverageRuleTuneOption : Codable
{
    public var label:String
    public var sub:String

    required public init(){}
}

public class CoverageCascadeResponse : Codable
{
    public var policy:CoveragePolicy
    public var doc:CoveragePolicyDoc
    public var versionNumber:Int
    public var versions:[CoveragePolicyVersionInfo] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class CoveragePolicy : Codable
{
    public var coveragePolicyId:Int
    public var coveragePolicyUID:String
    public var name:String
    public var scopeLevel:String
    public var branchId:String?
    public var branchName:String
    public var workTypeKey:String
    public var jobID:Int?
    public var jobName:String
    public var currentVersion:Int
    public var isActive:Bool
    public var createdAt:Date
    public var updatedAt:Date?

    required public init(){}
}

public class CoveragePolicyVersionInfo : Codable
{
    public var coveragePolicyVersionId:Int
    public var coveragePolicyId:Int
    public var versionNumber:Int
    public var changeNote:String
    public var changedByName:String
    public var createdAtUtc:Date
    public var doc:CoveragePolicyDoc

    required public init(){}
}

Swift CoveragePolicySaveRequest DTOs

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

HTTP + OTHER

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"CoveragePolicyId":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/jsonl
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"}}}