Trendsic Platform Service

CoverageGapsRequest

The following routes are available for this service:
GET	/v1/coverage/gaps

import Foundation
import ServiceStack

public class CoverageGapsRequest : Codable
{
    public var branchId:String?

    required public init(){}
}

public class CoverageGapsResponse : Codable
{
    public var gaps:[CoverageGap] = []
    public var policyName:String
    public var lockLine:String
    public var assignmentMode:String
    public var canApprove:Bool
    public var canEditPolicy:Bool
    public var canSeePay:Bool
    public var responseStatus:ResponseStatus

    required public init(){}
}

public class CoverageGap : Codable
{
    public var coverageGapId:Int
    public var coverageGapUID:String
    public var branchId:String?
    public var status:String
    public var track:String
    public var outContactID:Int?
    public var outName:String
    public var outInitials:String
    public var jobID:Int?
    public var jobName:String
    public var projectID:Int?
    public var workerScheduleItemID:Int?
    public var windowStart:Date
    public var windowEnd:Date
    public var reason:String
    public var mustFill:Bool
    public var mustFillExpl:CoverageExplanation
    public var filledByContactID:Int?
    public var filledByName:String
    public var recordNo:String
    public var decidedPolicyVersionId:Int?
    public var createdAt:Date
    public var updatedAt:Date?
    public var qualifiedLine:String
    public var candidates:[CoverageCandidate] = []
    public var blocked:[CoverageBlockedCandidate] = []
    public var offers:[CoverageOfferInfo] = []
    public var approvals:[CoverageApprovalInfo] = []
    public var timeline:[CoverageGapEventInfo] = []
    public var moveOptions:[CoverageMoveOption] = []
    public var orderExpl:CoverageExplanation
    public var assignmentMode:String
    public var noShow:CoverageNoShowState
    public var leave:CoverageLeaveState
    public var customerName:String

    required public init(){}
}

public class CoverageExplanation : Codable
{
    public var plainSentence:String
    public var ruleId:String
    public var ruleName:String
    public var demand:String
    public var source:CoverageExplanationSource
    public var kind:String
    public var whyItExists:String
    public var whatWouldChangeIt:String
    public var `override`:CoverageExplanationOverride
    public var drill:String

    required public init(){}
}

public class CoverageExplanationSource : Codable
{
    public var policyName:String
    public var cascadeLevel:String

    required public init(){}
}

public class CoverageExplanationOverride : Codable
{
    public var who:String
    public var consequence:String

    required public init(){}
}

public class CoverageCandidate : Codable
{
    public var contactId:Int
    public var name:String
    public var firstName:String
    public var initials:String
    public var rank:Int
    public var diffLine:String
    public var costLine:String
    public var costTone:String
    public var rankExpl:CoverageExplanation
    public var marginPct:Double?
    public var marginTone:String
    public var loaded:Double?
    public var billed:Double?
    public var otHours:Double?
    public var otPremium:Double?
    public var checks:[CoverageCandidateCheck] = []
    public var preview:[CoverageEffect] = []
    public var confirm:[CoverageEffect] = []
    public var hasWarn:Bool

    required public init(){}
}

public class CoverageCandidateCheck : Codable
{
    public var checkId:String
    public var result:String
    public var expl:CoverageExplanation

    required public init(){}
}

public class CoverageEffect : Codable
{
    public var icon:String
    public var text:String
    public var ruleId:String
    public var expl:CoverageExplanation

    required public init(){}
}

public class CoverageBlockedCandidate : Codable
{
    public var contactId:Int
    public var name:String
    public var initials:String
    public var reason:String
    public var changeChip:String
    public var expl:CoverageExplanation

    required public init(){}
}

public class CoverageOfferInfo : Codable
{
    public var coverageOfferId:Int
    public var contactId:Int
    public var name:String
    public var ring:Int
    public var channel:String
    public var status:String
    public var sentAtUtc:Date
    public var respondedAtUtc:Date?

    required public init(){}
}

public class CoverageApprovalInfo : Codable
{
    public var coverageApprovalId:Int
    public var coverageGapId:Int
    public var type:String
    public var status:String
    public var requestedAtUtc:Date
    public var effects:[CoverageEffect] = []
    public var contactId:Int?
    public var contactName:String
    public var decidedAtUtc:Date?
    public var decisionNote:String

    required public init(){}
}

public class CoverageGapEventInfo : Codable
{
    public var eventType:String
    public var channel:String
    public var detail:String
    public var contactName:String
    public var atUtc:Date

    required public init(){}
}

public class CoverageMoveOption : Codable
{
    public var key:String
    public var label:String
    public var detail:String
    public var expl:CoverageExplanation

    required public init(){}
}

public class CoverageNoShowState : Codable
{
    public var graceUntilUtc:Date
    public var attempts:[CoverageNoShowAttempt] = []
    public var declaredAtUtc:Date?
    public var attendanceNote:Bool
    public var falseAlarm:Bool

    required public init(){}
}

public class CoverageNoShowAttempt : Codable
{
    public var atUtc:Date
    public var channel:String
    public var note:String

    required public init(){}
}

public class CoverageLeaveState : Codable
{
    public var fmla:Bool
    public var began:Date
    public var estReturn:Date?
    public var checkpointDays:Int
    public var nextCheckpointUtc:Date?
    public var checkpoints:[CoverageLeaveCheckpoint] = []
    public var interimContactId:Int?
    public var interimName:String
    public var interimStart:Date?
    public var interimEnd:Date?
    public var requisitionOpened:Bool
    public var staffPostingId:Int?
    public var chainedGapIds:[Int] = []
    public var parentLeaveGapId:Int?
    public var restoredAtUtc:Date?

    required public init(){}
}

public class CoverageLeaveCheckpoint : Codable
{
    public var atUtc:Date
    public var note:String
    public var byName:String

    required public init(){}
}

Swift CoverageGapsRequest 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/gaps HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml

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

<CoverageGapsResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AssignmentMode>String</AssignmentMode>
  <CanApprove>false</CanApprove>
  <CanEditPolicy>false</CanEditPolicy>
  <CanSeePay>false</CanSeePay>
  <Gaps>
    <CoverageGap>
      <Approvals>
        <CoverageApprovalInfo>
          <ContactId>0</ContactId>
          <ContactName>String</ContactName>
          <CoverageApprovalId>0</CoverageApprovalId>
          <CoverageGapId>0</CoverageGapId>
          <DecidedAtUtc>0001-01-01T00:00:00</DecidedAtUtc>
          <DecisionNote>String</DecisionNote>
          <Effects>
            <CoverageEffect>
              <Expl>
                <Demand>String</Demand>
                <Drill>String</Drill>
                <Kind>String</Kind>
                <Override>
                  <Consequence>String</Consequence>
                  <Who>String</Who>
                </Override>
                <PlainSentence>String</PlainSentence>
                <RuleId>String</RuleId>
                <RuleName>String</RuleName>
                <Source>
                  <CascadeLevel>String</CascadeLevel>
                  <PolicyName>String</PolicyName>
                </Source>
                <WhatWouldChangeIt>String</WhatWouldChangeIt>
                <WhyItExists>String</WhyItExists>
              </Expl>
              <Icon>String</Icon>
              <RuleId>String</RuleId>
              <Text>String</Text>
            </CoverageEffect>
          </Effects>
          <RequestedAtUtc>0001-01-01T00:00:00</RequestedAtUtc>
          <Status>String</Status>
          <Type>String</Type>
        </CoverageApprovalInfo>
      </Approvals>
      <AssignmentMode>String</AssignmentMode>
      <Blocked>
        <CoverageBlockedCandidate>
          <ChangeChip>String</ChangeChip>
          <ContactId>0</ContactId>
          <Expl>
            <Demand>String</Demand>
            <Drill>String</Drill>
            <Kind>String</Kind>
            <Override>
              <Consequence>String</Consequence>
              <Who>String</Who>
            </Override>
            <PlainSentence>String</PlainSentence>
            <RuleId>String</RuleId>
            <RuleName>String</RuleName>
            <Source>
              <CascadeLevel>String</CascadeLevel>
              <PolicyName>String</PolicyName>
            </Source>
            <WhatWouldChangeIt>String</WhatWouldChangeIt>
            <WhyItExists>String</WhyItExists>
          </Expl>
          <Initials>String</Initials>
          <Name>String</Name>
          <Reason>String</Reason>
        </CoverageBlockedCandidate>
      </Blocked>
      <BranchId>00000000-0000-0000-0000-000000000000</BranchId>
      <Candidates>
        <CoverageCandidate>
          <Billed>0</Billed>
          <Checks>
            <CoverageCandidateCheck>
              <CheckId>String</CheckId>
              <Expl>
                <Demand>String</Demand>
                <Drill>String</Drill>
                <Kind>String</Kind>
                <Override>
                  <Consequence>String</Consequence>
                  <Who>String</Who>
                </Override>
                <PlainSentence>String</PlainSentence>
                <RuleId>String</RuleId>
                <RuleName>String</RuleName>
                <Source>
                  <CascadeLevel>String</CascadeLevel>
                  <PolicyName>String</PolicyName>
                </Source>
                <WhatWouldChangeIt>String</WhatWouldChangeIt>
                <WhyItExists>String</WhyItExists>
              </Expl>
              <Result>String</Result>
            </CoverageCandidateCheck>
          </Checks>
          <Confirm>
            <CoverageEffect>
              <Expl>
                <Demand>String</Demand>
                <Drill>String</Drill>
                <Kind>String</Kind>
                <Override>
                  <Consequence>String</Consequence>
                  <Who>String</Who>
                </Override>
                <PlainSentence>String</PlainSentence>
                <RuleId>String</RuleId>
                <RuleName>String</RuleName>
                <Source>
                  <CascadeLevel>String</CascadeLevel>
                  <PolicyName>String</PolicyName>
                </Source>
                <WhatWouldChangeIt>String</WhatWouldChangeIt>
                <WhyItExists>String</WhyItExists>
              </Expl>
              <Icon>String</Icon>
              <RuleId>String</RuleId>
              <Text>String</Text>
            </CoverageEffect>
          </Confirm>
          <ContactId>0</ContactId>
          <CostLine>String</CostLine>
          <CostTone>String</CostTone>
          <DiffLine>String</DiffLine>
          <FirstName>String</FirstName>
          <HasWarn>false</HasWarn>
          <Initials>String</Initials>
          <Loaded>0</Loaded>
          <MarginPct>0</MarginPct>
          <MarginTone>String</MarginTone>
          <Name>String</Name>
          <OtHours>0</OtHours>
          <OtPremium>0</OtPremium>
          <Preview>
            <CoverageEffect>
              <Expl>
                <Demand>String</Demand>
                <Drill>String</Drill>
                <Kind>String</Kind>
                <Override>
                  <Consequence>String</Consequence>
                  <Who>String</Who>
                </Override>
                <PlainSentence>String</PlainSentence>
                <RuleId>String</RuleId>
                <RuleName>String</RuleName>
                <Source>
                  <CascadeLevel>String</CascadeLevel>
                  <PolicyName>String</PolicyName>
                </Source>
                <WhatWouldChangeIt>String</WhatWouldChangeIt>
                <WhyItExists>String</WhyItExists>
              </Expl>
              <Icon>String</Icon>
              <RuleId>String</RuleId>
              <Text>String</Text>
            </CoverageEffect>
          </Preview>
          <Rank>0</Rank>
          <RankExpl>
            <Demand>String</Demand>
            <Drill>String</Drill>
            <Kind>String</Kind>
            <Override>
              <Consequence>String</Consequence>
              <Who>String</Who>
            </Override>
            <PlainSentence>String</PlainSentence>
            <RuleId>String</RuleId>
            <RuleName>String</RuleName>
            <Source>
              <CascadeLevel>String</CascadeLevel>
              <PolicyName>String</PolicyName>
            </Source>
            <WhatWouldChangeIt>String</WhatWouldChangeIt>
            <WhyItExists>String</WhyItExists>
          </RankExpl>
        </CoverageCandidate>
      </Candidates>
      <CoverageGapId>0</CoverageGapId>
      <CoverageGapUID>00000000-0000-0000-0000-000000000000</CoverageGapUID>
      <CreatedAt>0001-01-01T00:00:00</CreatedAt>
      <CustomerName>String</CustomerName>
      <DecidedPolicyVersionId>0</DecidedPolicyVersionId>
      <FilledByContactID>0</FilledByContactID>
      <FilledByName>String</FilledByName>
      <JobID>0</JobID>
      <JobName>String</JobName>
      <Leave>
        <Began>0001-01-01T00:00:00</Began>
        <ChainedGapIds xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
          <d5p1:int>0</d5p1:int>
        </ChainedGapIds>
        <CheckpointDays>0</CheckpointDays>
        <Checkpoints>
          <CoverageLeaveCheckpoint>
            <AtUtc>0001-01-01T00:00:00</AtUtc>
            <ByName>String</ByName>
            <Note>String</Note>
          </CoverageLeaveCheckpoint>
        </Checkpoints>
        <EstReturn>0001-01-01T00:00:00</EstReturn>
        <Fmla>false</Fmla>
        <InterimContactId>0</InterimContactId>
        <InterimEnd>0001-01-01T00:00:00</InterimEnd>
        <InterimName>String</InterimName>
        <InterimStart>0001-01-01T00:00:00</InterimStart>
        <NextCheckpointUtc>0001-01-01T00:00:00</NextCheckpointUtc>
        <ParentLeaveGapId>0</ParentLeaveGapId>
        <RequisitionOpened>false</RequisitionOpened>
        <RestoredAtUtc>0001-01-01T00:00:00</RestoredAtUtc>
        <StaffPostingId>0</StaffPostingId>
      </Leave>
      <MoveOptions>
        <CoverageMoveOption>
          <Detail>String</Detail>
          <Expl>
            <Demand>String</Demand>
            <Drill>String</Drill>
            <Kind>String</Kind>
            <Override>
              <Consequence>String</Consequence>
              <Who>String</Who>
            </Override>
            <PlainSentence>String</PlainSentence>
            <RuleId>String</RuleId>
            <RuleName>String</RuleName>
            <Source>
              <CascadeLevel>String</CascadeLevel>
              <PolicyName>String</PolicyName>
            </Source>
            <WhatWouldChangeIt>String</WhatWouldChangeIt>
            <WhyItExists>String</WhyItExists>
          </Expl>
          <Key>String</Key>
          <Label>String</Label>
        </CoverageMoveOption>
      </MoveOptions>
      <MustFill>false</MustFill>
      <MustFillExpl>
        <Demand>String</Demand>
        <Drill>String</Drill>
        <Kind>String</Kind>
        <Override>
          <Consequence>String</Consequence>
          <Who>String</Who>
        </Override>
        <PlainSentence>String</PlainSentence>
        <RuleId>String</RuleId>
        <RuleName>String</RuleName>
        <Source>
          <CascadeLevel>String</CascadeLevel>
          <PolicyName>String</PolicyName>
        </Source>
        <WhatWouldChangeIt>String</WhatWouldChangeIt>
        <WhyItExists>String</WhyItExists>
      </MustFillExpl>
      <NoShow>
        <Attempts>
          <CoverageNoShowAttempt>
            <AtUtc>0001-01-01T00:00:00</AtUtc>
            <Channel>String</Channel>
            <Note>String</Note>
          </CoverageNoShowAttempt>
        </Attempts>
        <AttendanceNote>false</AttendanceNote>
        <DeclaredAtUtc>0001-01-01T00:00:00</DeclaredAtUtc>
        <FalseAlarm>false</FalseAlarm>
        <GraceUntilUtc>0001-01-01T00:00:00</GraceUntilUtc>
      </NoShow>
      <Offers>
        <CoverageOfferInfo>
          <Channel>String</Channel>
          <ContactId>0</ContactId>
          <CoverageOfferId>0</CoverageOfferId>
          <Name>String</Name>
          <RespondedAtUtc>0001-01-01T00:00:00</RespondedAtUtc>
          <Ring>0</Ring>
          <SentAtUtc>0001-01-01T00:00:00</SentAtUtc>
          <Status>String</Status>
        </CoverageOfferInfo>
      </Offers>
      <OrderExpl>
        <Demand>String</Demand>
        <Drill>String</Drill>
        <Kind>String</Kind>
        <Override>
          <Consequence>String</Consequence>
          <Who>String</Who>
        </Override>
        <PlainSentence>String</PlainSentence>
        <RuleId>String</RuleId>
        <RuleName>String</RuleName>
        <Source>
          <CascadeLevel>String</CascadeLevel>
          <PolicyName>String</PolicyName>
        </Source>
        <WhatWouldChangeIt>String</WhatWouldChangeIt>
        <WhyItExists>String</WhyItExists>
      </OrderExpl>
      <OutContactID>0</OutContactID>
      <OutInitials>String</OutInitials>
      <OutName>String</OutName>
      <ProjectID>0</ProjectID>
      <QualifiedLine>String</QualifiedLine>
      <Reason>String</Reason>
      <RecordNo>String</RecordNo>
      <Status>String</Status>
      <Timeline>
        <CoverageGapEventInfo>
          <AtUtc>0001-01-01T00:00:00</AtUtc>
          <Channel>String</Channel>
          <ContactName>String</ContactName>
          <Detail>String</Detail>
          <EventType>String</EventType>
        </CoverageGapEventInfo>
      </Timeline>
      <Track>String</Track>
      <UpdatedAt>0001-01-01T00:00:00</UpdatedAt>
      <WindowEnd>0001-01-01T00:00:00</WindowEnd>
      <WindowStart>0001-01-01T00:00:00</WindowStart>
      <WorkerScheduleItemID>0</WorkerScheduleItemID>
    </CoverageGap>
  </Gaps>
  <LockLine>String</LockLine>
  <PolicyName>String</PolicyName>
  <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>
</CoverageGapsResponse>