Trendsic Platform Service

<back to all web services

CoveragePolicySaveRequest

Requires Authentication
The following routes are available for this service:
POST/v1/coverage/policies/{CoveragePolicyId}
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class CoverageCascadeResponse
    {
        public virtual CoveragePolicy Policy { get; set; }
        public virtual CoveragePolicyDoc Doc { get; set; }
        public virtual int VersionNumber { get; set; }
        public virtual List<CoveragePolicyVersionInfo> Versions { get; set; } = [];
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class CoveragePolicy
    {
        public virtual int CoveragePolicyId { get; set; }
        public virtual Guid CoveragePolicyUID { get; set; }
        public virtual string Name { get; set; }
        public virtual string ScopeLevel { get; set; }
        public virtual Guid? BranchId { get; set; }
        public virtual string BranchName { get; set; }
        public virtual string WorkTypeKey { get; set; }
        public virtual int? JobID { get; set; }
        public virtual string JobName { get; set; }
        public virtual int CurrentVersion { get; set; }
        public virtual bool IsActive { get; set; }
        public virtual DateTime CreatedAt { get; set; }
        public virtual DateTime? UpdatedAt { get; set; }
    }

    public partial class CoveragePolicyDoc
    {
        public virtual string Intro { get; set; }
        public virtual string LockLine { get; set; }
        public virtual string TemplateName { get; set; }
        public virtual CoveragePolicyPrefs Prefs { get; set; }
        public virtual List<CoverageRuleDef> Rules { get; set; } = [];
    }

    public partial class CoveragePolicyPrefs
    {
        public virtual string AssignmentMode { get; set; }
        public virtual int RestHours { get; set; }
        public virtual int OtThresholdHours { get; set; }
        public virtual int RingWaitMinutes { get; set; }
        public virtual string QuietStart { get; set; }
        public virtual string QuietEnd { get; set; }
        public virtual bool RescheduleAllowed { get; set; }
        public virtual string QuietMode { get; set; }
        public virtual List<CoverageRingDef> Rings { get; set; } = [];
    }

    public partial class CoveragePolicySaveRequest
    {
        public virtual int CoveragePolicyId { get; set; }
        public virtual CoveragePolicyDoc Doc { get; set; }
        public virtual string ChangeNote { get; set; }
    }

    public partial class CoveragePolicyVersionInfo
    {
        public virtual int CoveragePolicyVersionId { get; set; }
        public virtual int CoveragePolicyId { get; set; }
        public virtual int VersionNumber { get; set; }
        public virtual string ChangeNote { get; set; }
        public virtual string ChangedByName { get; set; }
        public virtual DateTime CreatedAtUtc { get; set; }
        public virtual CoveragePolicyDoc Doc { get; set; }
    }

    public partial class CoverageRingDef
    {
        public virtual string Key { get; set; }
        public virtual string Label { get; set; }
        public virtual string Sub { get; set; }
        public virtual int? WaitMinutes { get; set; }
        public virtual bool Enabled { get; set; }
    }

    public partial class CoverageRuleDef
    {
        public virtual string RuleId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Kind { get; set; }
        public virtual string Demand { get; set; }
        public virtual string SourcePolicyName { get; set; }
        public virtual string CascadeLevel { get; set; }
        public virtual string Why { get; set; }
        public virtual string Change { get; set; }
        public virtual string OverrideWho { get; set; }
        public virtual string OverrideConsequence { get; set; }
        public virtual string NoNote { get; set; }
        public virtual Dictionary<string, string> Params { get; set; } = new();
        public virtual List<CoverageRuleDocSection> Doc { get; set; } = [];
        public virtual CoverageRuleTune Tune { get; set; }
    }

    public partial class CoverageRuleDocSection
    {
        public virtual string H { get; set; }
        public virtual string T { get; set; }
    }

    public partial class CoverageRuleTune
    {
        public virtual string Intro { get; set; }
        public virtual List<CoverageRuleTuneOption> Options { get; set; } = [];
    }

    public partial class CoverageRuleTuneOption
    {
        public virtual string Label { get; set; }
        public virtual string Sub { get; set; }
    }

}

C# CoveragePolicySaveRequest DTOs

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/{CoveragePolicyId} HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
Content-Type: application/json
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: 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"}}}