Trendsic Platform Service

<back to all web services

CoverageNoShowAttemptRequest

Requires Authentication
The following routes are available for this service:
POST/v1/coverage/gaps/{CoverageGapId}/noshow/attempt
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 CoverageApprovalInfo
            Public Overridable Property CoverageApprovalId As Integer
            Public Overridable Property CoverageGapId As Integer
            Public Overridable Property Type As String
            Public Overridable Property Status As String
            Public Overridable Property RequestedAtUtc As Date
            Public Overridable Property Effects As List(Of CoverageEffect) = New List(Of CoverageEffect)
            Public Overridable Property ContactId As Integer?
            Public Overridable Property ContactName As String
            Public Overridable Property DecidedAtUtc As Date?
            Public Overridable Property DecisionNote As String
        End Class

        Public Partial Class CoverageBlockedCandidate
            Public Overridable Property ContactId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Initials As String
            Public Overridable Property Reason As String
            Public Overridable Property ChangeChip As String
            Public Overridable Property Expl As CoverageExplanation
        End Class

        Public Partial Class CoverageCandidate
            Public Overridable Property ContactId As Integer
            Public Overridable Property Name As String
            Public Overridable Property FirstName As String
            Public Overridable Property Initials As String
            Public Overridable Property Rank As Integer
            Public Overridable Property DiffLine As String
            Public Overridable Property CostLine As String
            Public Overridable Property CostTone As String
            Public Overridable Property RankExpl As CoverageExplanation
            Public Overridable Property MarginPct As Decimal?
            Public Overridable Property MarginTone As String
            Public Overridable Property Loaded As Decimal?
            Public Overridable Property Billed As Decimal?
            Public Overridable Property OtHours As Decimal?
            Public Overridable Property OtPremium As Decimal?
            Public Overridable Property Checks As List(Of CoverageCandidateCheck) = New List(Of CoverageCandidateCheck)
            Public Overridable Property Preview As List(Of CoverageEffect) = New List(Of CoverageEffect)
            Public Overridable Property Confirm As List(Of CoverageEffect) = New List(Of CoverageEffect)
            Public Overridable Property HasWarn As Boolean
        End Class

        Public Partial Class CoverageCandidateCheck
            Public Overridable Property CheckId As String
            Public Overridable Property Result As String
            Public Overridable Property Expl As CoverageExplanation
        End Class

        Public Partial Class CoverageEffect
            Public Overridable Property Icon As String
            Public Overridable Property Text As String
            Public Overridable Property RuleId As String
            Public Overridable Property Expl As CoverageExplanation
        End Class

        Public Partial Class CoverageExplanation
            Public Overridable Property PlainSentence As String
            Public Overridable Property RuleId As String
            Public Overridable Property RuleName As String
            Public Overridable Property Demand As String
            Public Overridable Property Source As CoverageExplanationSource
            Public Overridable Property Kind As String
            Public Overridable Property WhyItExists As String
            Public Overridable Property WhatWouldChangeIt As String
            Public Overridable Property Override As CoverageExplanationOverride
            Public Overridable Property Drill As String
        End Class

        Public Partial Class CoverageExplanationOverride
            Public Overridable Property Who As String
            Public Overridable Property Consequence As String
        End Class

        Public Partial Class CoverageExplanationSource
            Public Overridable Property PolicyName As String
            Public Overridable Property CascadeLevel As String
        End Class

        Public Partial Class CoverageGap
            Public Overridable Property CoverageGapId As Integer
            Public Overridable Property CoverageGapUID As Guid
            Public Overridable Property BranchId As Guid?
            Public Overridable Property Status As String
            Public Overridable Property Track As String
            Public Overridable Property OutContactID As Integer?
            Public Overridable Property OutName As String
            Public Overridable Property OutInitials As String
            Public Overridable Property JobID As Integer?
            Public Overridable Property JobName As String
            Public Overridable Property ProjectID As Integer?
            Public Overridable Property WorkerScheduleItemID As Integer?
            Public Overridable Property WindowStart As Date
            Public Overridable Property WindowEnd As Date
            Public Overridable Property Reason As String
            Public Overridable Property MustFill As Boolean
            Public Overridable Property MustFillExpl As CoverageExplanation
            Public Overridable Property FilledByContactID As Integer?
            Public Overridable Property FilledByName As String
            Public Overridable Property RecordNo As String
            Public Overridable Property DecidedPolicyVersionId As Integer?
            Public Overridable Property CreatedAt As Date
            Public Overridable Property UpdatedAt As Date?
            Public Overridable Property QualifiedLine As String
            Public Overridable Property Candidates As List(Of CoverageCandidate) = New List(Of CoverageCandidate)
            Public Overridable Property Blocked As List(Of CoverageBlockedCandidate) = New List(Of CoverageBlockedCandidate)
            Public Overridable Property Offers As List(Of CoverageOfferInfo) = New List(Of CoverageOfferInfo)
            Public Overridable Property Approvals As List(Of CoverageApprovalInfo) = New List(Of CoverageApprovalInfo)
            Public Overridable Property Timeline As List(Of CoverageGapEventInfo) = New List(Of CoverageGapEventInfo)
            Public Overridable Property MoveOptions As List(Of CoverageMoveOption) = New List(Of CoverageMoveOption)
            Public Overridable Property OrderExpl As CoverageExplanation
            Public Overridable Property AssignmentMode As String
            Public Overridable Property NoShow As CoverageNoShowState
            Public Overridable Property Leave As CoverageLeaveState
            Public Overridable Property CustomerName As String
        End Class

        Public Partial Class CoverageGapEventInfo
            Public Overridable Property EventType As String
            Public Overridable Property Channel As String
            Public Overridable Property Detail As String
            Public Overridable Property ContactName As String
            Public Overridable Property AtUtc As Date
        End Class

        Public Partial Class CoverageGapResponse
            Public Overridable Property Gap As CoverageGap
            Public Overridable Property ChainedPreview As Integer?
            Public Overridable Property CanSeePay As Boolean
            Public Overridable Property ResponseStatus As ResponseStatus
        End Class

        Public Partial Class CoverageLeaveCheckpoint
            Public Overridable Property AtUtc As Date
            Public Overridable Property Note As String
            Public Overridable Property ByName As String
        End Class

        Public Partial Class CoverageLeaveState
            Public Overridable Property Fmla As Boolean
            Public Overridable Property Began As Date
            Public Overridable Property EstReturn As Date?
            Public Overridable Property CheckpointDays As Integer
            Public Overridable Property NextCheckpointUtc As Date?
            Public Overridable Property Checkpoints As List(Of CoverageLeaveCheckpoint) = New List(Of CoverageLeaveCheckpoint)
            Public Overridable Property InterimContactId As Integer?
            Public Overridable Property InterimName As String
            Public Overridable Property InterimStart As Date?
            Public Overridable Property InterimEnd As Date?
            Public Overridable Property RequisitionOpened As Boolean
            Public Overridable Property StaffPostingId As Integer?
            Public Overridable Property ChainedGapIds As List(Of Integer) = New List(Of Integer)
            Public Overridable Property ParentLeaveGapId As Integer?
            Public Overridable Property RestoredAtUtc As Date?
        End Class

        Public Partial Class CoverageMoveOption
            Public Overridable Property Key As String
            Public Overridable Property Label As String
            Public Overridable Property Detail As String
            Public Overridable Property Expl As CoverageExplanation
        End Class

        Public Partial Class CoverageNoShowAttempt
            Public Overridable Property AtUtc As Date
            Public Overridable Property Channel As String
            Public Overridable Property Note As String
        End Class

        Public Partial Class CoverageNoShowAttemptRequest
            Public Overridable Property CoverageGapId As Integer
            Public Overridable Property Channel As String
            Public Overridable Property Note As String
        End Class

        Public Partial Class CoverageNoShowState
            Public Overridable Property GraceUntilUtc As Date
            Public Overridable Property Attempts As List(Of CoverageNoShowAttempt) = New List(Of CoverageNoShowAttempt)
            Public Overridable Property DeclaredAtUtc As Date?
            Public Overridable Property AttendanceNote As Boolean
            Public Overridable Property FalseAlarm As Boolean
        End Class

        Public Partial Class CoverageOfferInfo
            Public Overridable Property CoverageOfferId As Integer
            Public Overridable Property ContactId As Integer
            Public Overridable Property Name As String
            Public Overridable Property Ring As Integer
            Public Overridable Property Channel As String
            Public Overridable Property Status As String
            Public Overridable Property SentAtUtc As Date
            Public Overridable Property RespondedAtUtc As Date?
        End Class
    End Namespace
End Namespace

VB.NET CoverageNoShowAttemptRequest 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/gaps/{CoverageGapId}/noshow/attempt HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CoverageNoShowAttemptRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <Channel>String</Channel>
  <CoverageGapId>0</CoverageGapId>
  <Note>String</Note>
</CoverageNoShowAttemptRequest>
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length

<CoverageGapResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <CanSeePay>false</CanSeePay>
  <ChainedPreview>0</ChainedPreview>
  <Gap>
    <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:d4p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
        <d4p1:int>0</d4p1: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>
  </Gap>
  <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>
</CoverageGapResponse>