Trendsic Platform Service

<back to all web services

CoveragePolicySaveRequest

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

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class CoverageCascadeResponse
            Public Overridable Property Policy As CoveragePolicy
            Public Overridable Property Doc As CoveragePolicyDoc
            Public Overridable Property VersionNumber As Integer
            Public Overridable Property Versions As List(Of CoveragePolicyVersionInfo) = New List(Of CoveragePolicyVersionInfo)
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class CoveragePolicy
            Public Overridable Property CoveragePolicyId As Integer
            Public Overridable Property CoveragePolicyUID As Guid
            Public Overridable Property Name As String
            Public Overridable Property ScopeLevel As String
            Public Overridable Property BranchId As Guid?
            Public Overridable Property BranchName As String
            Public Overridable Property WorkTypeKey As String
            Public Overridable Property JobID As Integer?
            Public Overridable Property JobName As String
            Public Overridable Property CurrentVersion As Integer
            Public Overridable Property IsActive As Boolean
            Public Overridable Property CreatedAt As Date
            Public Overridable Property UpdatedAt As Date?
        End Class

        Public Partial Class CoveragePolicyDoc
            Public Overridable Property Intro As String
            Public Overridable Property LockLine As String
            Public Overridable Property TemplateName As String
            Public Overridable Property Prefs As CoveragePolicyPrefs
            Public Overridable Property Rules As List(Of CoverageRuleDef) = New List(Of CoverageRuleDef)
        End Class

        Public Partial Class CoveragePolicyPrefs
            Public Overridable Property AssignmentMode As String
            Public Overridable Property RestHours As Integer
            Public Overridable Property OtThresholdHours As Integer
            Public Overridable Property RingWaitMinutes As Integer
            Public Overridable Property QuietStart As String
            Public Overridable Property QuietEnd As String
            Public Overridable Property RescheduleAllowed As Boolean
            Public Overridable Property QuietMode As String
            Public Overridable Property Rings As List(Of CoverageRingDef) = New List(Of CoverageRingDef)
        End Class

        Public Partial Class CoveragePolicySaveRequest
            Public Overridable Property CoveragePolicyId As Integer
            Public Overridable Property Doc As CoveragePolicyDoc
            Public Overridable Property ChangeNote As String
        End Class

        Public Partial Class CoveragePolicyVersionInfo
            Public Overridable Property CoveragePolicyVersionId As Integer
            Public Overridable Property CoveragePolicyId As Integer
            Public Overridable Property VersionNumber As Integer
            Public Overridable Property ChangeNote As String
            Public Overridable Property ChangedByName As String
            Public Overridable Property CreatedAtUtc As Date
            Public Overridable Property Doc As CoveragePolicyDoc
        End Class

        Public Partial Class CoverageRingDef
            Public Overridable Property Key As String
            Public Overridable Property Label As String
            Public Overridable Property [Sub] As String
            Public Overridable Property WaitMinutes As Integer?
            Public Overridable Property Enabled As Boolean
        End Class

        Public Partial Class CoverageRuleDef
            Public Overridable Property RuleId As String
            Public Overridable Property Name As String
            Public Overridable Property Kind As String
            Public Overridable Property Demand As String
            Public Overridable Property SourcePolicyName As String
            Public Overridable Property CascadeLevel As String
            Public Overridable Property Why As String
            Public Overridable Property Change As String
            Public Overridable Property OverrideWho As String
            Public Overridable Property OverrideConsequence As String
            Public Overridable Property NoNote As String
            Public Overridable Property Params As Dictionary(Of String, String) = New Dictionary(Of String, String)
            Public Overridable Property Doc As List(Of CoverageRuleDocSection) = New List(Of CoverageRuleDocSection)
            Public Overridable Property Tune As CoverageRuleTune
        End Class

        Public Partial Class CoverageRuleDocSection
            Public Overridable Property H As String
            Public Overridable Property T As String
        End Class

        Public Partial Class CoverageRuleTune
            Public Overridable Property Intro As String
            Public Overridable Property Options As List(Of CoverageRuleTuneOption) = New List(Of CoverageRuleTuneOption)
        End Class

        Public Partial Class CoverageRuleTuneOption
            Public Overridable Property Label As String
            Public Overridable Property [Sub] As String
        End Class
    End Namespace
End Namespace

VB.NET 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"}}}