Trendsic Platform Service

CoveragePolicyCreateRequest

The following routes are available for this service:
POST	/v1/coverage/policies


export class CoveragePolicy
{
    public CoveragePolicyId: number;
    public CoveragePolicyUID: string;
    public Name: string;
    public ScopeLevel: string;
    public BranchId?: string;
    public BranchName: string;
    public WorkTypeKey: string;
    public JobID?: number;
    public JobName: string;
    public CurrentVersion: number;
    public IsActive: boolean;
    public CreatedAt: string;
    public UpdatedAt?: string;

    public constructor(init?: Partial<CoveragePolicy>) { (Object as any).assign(this, init); }
}

export class CoverageRingDef
{
    public Key: string;
    public Label: string;
    public Sub: string;
    public WaitMinutes?: number;
    public Enabled: boolean;

    public constructor(init?: Partial<CoverageRingDef>) { (Object as any).assign(this, init); }
}

export class CoveragePolicyPrefs
{
    public AssignmentMode: string;
    public RestHours: number;
    public OtThresholdHours: number;
    public RingWaitMinutes: number;
    public QuietStart: string;
    public QuietEnd: string;
    public RescheduleAllowed: boolean;
    public QuietMode: string;
    public Rings: CoverageRingDef[] = [];

    public constructor(init?: Partial<CoveragePolicyPrefs>) { (Object as any).assign(this, init); }
}

export class CoverageRuleDocSection
{
    public H: string;
    public T: string;

    public constructor(init?: Partial<CoverageRuleDocSection>) { (Object as any).assign(this, init); }
}

export class CoverageRuleTuneOption
{
    public Label: string;
    public Sub: string;

    public constructor(init?: Partial<CoverageRuleTuneOption>) { (Object as any).assign(this, init); }
}

export class CoverageRuleTune
{
    public Intro: string;
    public Options: CoverageRuleTuneOption[] = [];

    public constructor(init?: Partial<CoverageRuleTune>) { (Object as any).assign(this, init); }
}

export class CoverageRuleDef
{
    public RuleId: string;
    public Name: string;
    public Kind: string;
    public Demand: string;
    public SourcePolicyName: string;
    public CascadeLevel: string;
    public Why: string;
    public Change: string;
    public OverrideWho: string;
    public OverrideConsequence: string;
    public NoNote: string;
    public Params: { [index:string]: string; } = {};
    public Doc: CoverageRuleDocSection[] = [];
    public Tune: CoverageRuleTune;

    public constructor(init?: Partial<CoverageRuleDef>) { (Object as any).assign(this, init); }
}

export class CoveragePolicyDoc
{
    public Intro: string;
    public LockLine: string;
    public TemplateName: string;
    public Prefs: CoveragePolicyPrefs;
    public Rules: CoverageRuleDef[] = [];

    public constructor(init?: Partial<CoveragePolicyDoc>) { (Object as any).assign(this, init); }
}

export class CoveragePolicyVersionInfo
{
    public CoveragePolicyVersionId: number;
    public CoveragePolicyId: number;
    public VersionNumber: number;
    public ChangeNote: string;
    public ChangedByName: string;
    public CreatedAtUtc: string;
    public Doc: CoveragePolicyDoc;

    public constructor(init?: Partial<CoveragePolicyVersionInfo>) { (Object as any).assign(this, init); }
}

export class CoverageCascadeResponse
{
    public Policy: CoveragePolicy;
    public Doc: CoveragePolicyDoc;
    public VersionNumber: number;
    public Versions: CoveragePolicyVersionInfo[] = [];
    public ResponseStatus: ResponseStatus;

    public constructor(init?: Partial<CoverageCascadeResponse>) { (Object as any).assign(this, init); }
}

export class CoveragePolicyCreateRequest
{
    public Name: string;
    public ScopeLevel: string;
    public BranchId?: string;
    public WorkTypeKey: string;
    public JobID?: number;
    public Doc: CoveragePolicyDoc;
    public ChangeNote: string;

    public constructor(init?: Partial<CoveragePolicyCreateRequest>) { (Object as any).assign(this, init); }
}

TypeScript CoveragePolicyCreateRequest 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.

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

<CoveragePolicyCreateRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
  <ChangeNote>String</ChangeNote>
  <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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1: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>
  <JobID>0</JobID>
  <Name>String</Name>
  <ScopeLevel>String</ScopeLevel>
  <WorkTypeKey>String</WorkTypeKey>
</CoveragePolicyCreateRequest>

HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CoverageCascadeResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <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:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:KeyValueOfstringstring>
            <d5p1:Key>String</d5p1:Key>
            <d5p1:Value>String</d5p1:Value>
          </d5p1: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>
  <Policy>
    <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
    <BranchName>String</BranchName>
    <CoveragePolicyId>0</CoveragePolicyId>
    <CoveragePolicyUID>00000000-0000-0000-0000-000000000000</CoveragePolicyUID>
    <CreatedAt>0001-01-01T00:00:00</CreatedAt>
    <CurrentVersion>0</CurrentVersion>
    <IsActive>false</IsActive>
    <JobID>0</JobID>
    <JobName>String</JobName>
    <Name>String</Name>
    <ScopeLevel>String</ScopeLevel>
    <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
    <WorkTypeKey>String</WorkTypeKey>
  </Policy>
  <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>
  <VersionNumber>0</VersionNumber>
  <Versions>
    <CoveragePolicyVersionInfo>
      <ChangeNote>String</ChangeNote>
      <ChangedByName>String</ChangedByName>
      <CoveragePolicyId>0</CoveragePolicyId>
      <CoveragePolicyVersionId>0</CoveragePolicyVersionId>
      <CreatedAtUtc>0001-01-01T00:00:00</CreatedAtUtc>
      <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>
      <VersionNumber>0</VersionNumber>
    </CoveragePolicyVersionInfo>
  </Versions>
</CoverageCascadeResponse>