Trendsic Platform Service

<back to all web services

CoverageTemplatesRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/policies/templates
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 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 CoverageTemplateInfo() = 
        member val Key:String = null with get,set
        member val Name:String = null with get,set
        member val Sub:String = null with get,set
        member val Doc:CoveragePolicyDoc = null with get,set

    [<AllowNullLiteral>]
    type CoverageTemplatesResponse() = 
        member val Templates:ResizeArray<CoverageTemplateInfo> = new ResizeArray<CoverageTemplateInfo>() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CoverageTemplatesRequest() = 
        class end

F# 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>