Trendsic Platform Service

<back to all web services

CoverageTemplatesRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/policies/templates
import Foundation
import ServiceStack

public class CoverageTemplatesRequest : Codable
{
    required public init(){}
}

public class CoverageTemplatesResponse : Codable
{
    public var templates:[CoverageTemplateInfo] = []
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class CoverageTemplateInfo : Codable
{
    public var key:String
    public var name:String
    public var sub:String
    public var doc:CoveragePolicyDoc

    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(){}
}


Swift CoverageTemplatesRequest DTOs

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

HTTP + XML

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

GET /v1/coverage/policies/templates HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CoverageTemplatesResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
    <d2p1:ErrorCode>String</d2p1:ErrorCode>
    <d2p1:Message>String</d2p1:Message>
    <d2p1:StackTrace>String</d2p1:StackTrace>
    <d2p1:Errors>
      <d2p1:ResponseError>
        <d2p1:ErrorCode>String</d2p1:ErrorCode>
        <d2p1:FieldName>String</d2p1:FieldName>
        <d2p1:Message>String</d2p1:Message>
        <d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1:KeyValueOfstringstring>
        </d2p1:Meta>
      </d2p1:ResponseError>
    </d2p1:Errors>
    <d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
      <d3p1:KeyValueOfstringstring>
        <d3p1:Key>String</d3p1:Key>
        <d3p1:Value>String</d3p1:Value>
      </d3p1:KeyValueOfstringstring>
    </d2p1:Meta>
  </ResponseStatus>
  <Templates>
    <CoverageTemplateInfo>
      <Doc>
        <Intro>String</Intro>
        <LockLine>String</LockLine>
        <Prefs>
          <AssignmentMode>String</AssignmentMode>
          <OtThresholdHours>0</OtThresholdHours>
          <QuietEnd>String</QuietEnd>
          <QuietMode>String</QuietMode>
          <QuietStart>String</QuietStart>
          <RescheduleAllowed>false</RescheduleAllowed>
          <RestHours>0</RestHours>
          <RingWaitMinutes>0</RingWaitMinutes>
          <Rings>
            <CoverageRingDef>
              <Enabled>false</Enabled>
              <Key>String</Key>
              <Label>String</Label>
              <Sub>String</Sub>
              <WaitMinutes>0</WaitMinutes>
            </CoverageRingDef>
          </Rings>
        </Prefs>
        <Rules>
          <CoverageRuleDef>
            <CascadeLevel>String</CascadeLevel>
            <Change>String</Change>
            <Demand>String</Demand>
            <Doc>
              <CoverageRuleDocSection>
                <H>String</H>
                <T>String</T>
              </CoverageRuleDocSection>
            </Doc>
            <Kind>String</Kind>
            <Name>String</Name>
            <NoNote>String</NoNote>
            <OverrideConsequence>String</OverrideConsequence>
            <OverrideWho>String</OverrideWho>
            <Params xmlns:d7p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
              <d7p1:KeyValueOfstringstring>
                <d7p1:Key>String</d7p1:Key>
                <d7p1:Value>String</d7p1:Value>
              </d7p1:KeyValueOfstringstring>
            </Params>
            <RuleId>String</RuleId>
            <SourcePolicyName>String</SourcePolicyName>
            <Tune>
              <Intro>String</Intro>
              <Options>
                <CoverageRuleTuneOption>
                  <Label>String</Label>
                  <Sub>String</Sub>
                </CoverageRuleTuneOption>
              </Options>
            </Tune>
            <Why>String</Why>
          </CoverageRuleDef>
        </Rules>
        <TemplateName>String</TemplateName>
      </Doc>
      <Key>String</Key>
      <Name>String</Name>
      <Sub>String</Sub>
    </CoverageTemplateInfo>
  </Templates>
</CoverageTemplatesResponse>