Trendsic Platform Service

<back to all web services

CoveragePolicyCreateRequest

Requires Authentication
The following routes are available for this service:
POST/v1/coverage/policies
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CoveragePolicy() = 
        member val CoveragePolicyId:Int32 = new Int32() with get,set
        member val CoveragePolicyUID:Guid = new Guid() with get,set
        member val Name:String = null with get,set
        member val ScopeLevel:String = null with get,set
        member val BranchId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val BranchName:String = null with get,set
        member val WorkTypeKey:String = null with get,set
        member val JobID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val JobName:String = null with get,set
        member val CurrentVersion:Int32 = new Int32() with get,set
        member val IsActive:Boolean = new Boolean() with get,set
        member val CreatedAt:DateTime = new DateTime() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type CoverageRingDef() = 
        member val Key:String = null with get,set
        member val Label:String = null with get,set
        member val Sub:String = null with get,set
        member val WaitMinutes:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Enabled:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CoveragePolicyPrefs() = 
        member val AssignmentMode:String = null with get,set
        member val RestHours:Int32 = new Int32() with get,set
        member val OtThresholdHours:Int32 = new Int32() with get,set
        member val RingWaitMinutes:Int32 = new Int32() with get,set
        member val QuietStart:String = null with get,set
        member val QuietEnd:String = null with get,set
        member val RescheduleAllowed:Boolean = new Boolean() with get,set
        member val QuietMode:String = null with get,set
        member val Rings:ResizeArray<CoverageRingDef> = new ResizeArray<CoverageRingDef>() with get,set

    [<AllowNullLiteral>]
    type CoverageRuleDocSection() = 
        member val H:String = null with get,set
        member val T:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageRuleTuneOption() = 
        member val Label:String = null with get,set
        member val Sub:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageRuleTune() = 
        member val Intro:String = null with get,set
        member val Options:ResizeArray<CoverageRuleTuneOption> = new ResizeArray<CoverageRuleTuneOption>() with get,set

    [<AllowNullLiteral>]
    type CoverageRuleDef() = 
        member val RuleId:String = null with get,set
        member val Name:String = null with get,set
        member val Kind:String = null with get,set
        member val Demand:String = null with get,set
        member val SourcePolicyName:String = null with get,set
        member val CascadeLevel:String = null with get,set
        member val Why:String = null with get,set
        member val Change:String = null with get,set
        member val OverrideWho:String = null with get,set
        member val OverrideConsequence:String = null with get,set
        member val NoNote:String = null with get,set
        member val Params:Dictionary<String, String> = new Dictionary<String, String>() with get,set
        member val Doc:ResizeArray<CoverageRuleDocSection> = new ResizeArray<CoverageRuleDocSection>() with get,set
        member val Tune:CoverageRuleTune = null with get,set

    [<AllowNullLiteral>]
    type CoveragePolicyDoc() = 
        member val Intro:String = null with get,set
        member val LockLine:String = null with get,set
        member val TemplateName:String = null with get,set
        member val Prefs:CoveragePolicyPrefs = null with get,set
        member val Rules:ResizeArray<CoverageRuleDef> = new ResizeArray<CoverageRuleDef>() with get,set

    [<AllowNullLiteral>]
    type CoveragePolicyVersionInfo() = 
        member val CoveragePolicyVersionId:Int32 = new Int32() with get,set
        member val CoveragePolicyId:Int32 = new Int32() with get,set
        member val VersionNumber:Int32 = new Int32() with get,set
        member val ChangeNote:String = null with get,set
        member val ChangedByName:String = null with get,set
        member val CreatedAtUtc:DateTime = new DateTime() with get,set
        member val Doc:CoveragePolicyDoc = null with get,set

    [<AllowNullLiteral>]
    type CoverageCascadeResponse() = 
        member val Policy:CoveragePolicy = null with get,set
        member val Doc:CoveragePolicyDoc = null with get,set
        member val VersionNumber:Int32 = new Int32() with get,set
        member val Versions:ResizeArray<CoveragePolicyVersionInfo> = new ResizeArray<CoveragePolicyVersionInfo>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CoveragePolicyCreateRequest() = 
        member val Name:String = null with get,set
        member val ScopeLevel:String = null with get,set
        member val BranchId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val WorkTypeKey:String = null with get,set
        member val JobID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val Doc:CoveragePolicyDoc = null with get,set
        member val ChangeNote:String = null with get,set

F# CoveragePolicyCreateRequest 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 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"}}}