Trendsic Platform Service

<back to all web services

CoverageNoShowDeclareRequest

Requires Authentication
The following routes are available for this service:
POST/v1/coverage/gaps/{CoverageGapId}/noshow/declare
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 CoverageExplanationSource() = 
        member val PolicyName:String = null with get,set
        member val CascadeLevel:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageExplanationOverride() = 
        member val Who:String = null with get,set
        member val Consequence:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageExplanation() = 
        member val PlainSentence:String = null with get,set
        member val RuleId:String = null with get,set
        member val RuleName:String = null with get,set
        member val Demand:String = null with get,set
        member val Source:CoverageExplanationSource = null with get,set
        member val Kind:String = null with get,set
        member val WhyItExists:String = null with get,set
        member val WhatWouldChangeIt:String = null with get,set
        member val Override:CoverageExplanationOverride = null with get,set
        member val Drill:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageCandidateCheck() = 
        member val CheckId:String = null with get,set
        member val Result:String = null with get,set
        member val Expl:CoverageExplanation = null with get,set

    [<AllowNullLiteral>]
    type CoverageEffect() = 
        member val Icon:String = null with get,set
        member val Text:String = null with get,set
        member val RuleId:String = null with get,set
        member val Expl:CoverageExplanation = null with get,set

    [<AllowNullLiteral>]
    type CoverageCandidate() = 
        member val ContactId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val FirstName:String = null with get,set
        member val Initials:String = null with get,set
        member val Rank:Int32 = new Int32() with get,set
        member val DiffLine:String = null with get,set
        member val CostLine:String = null with get,set
        member val CostTone:String = null with get,set
        member val RankExpl:CoverageExplanation = null with get,set
        member val MarginPct:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val MarginTone:String = null with get,set
        member val Loaded:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Billed:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OtHours:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val OtPremium:Nullable<Decimal> = new Nullable<Decimal>() with get,set
        member val Checks:ResizeArray<CoverageCandidateCheck> = new ResizeArray<CoverageCandidateCheck>() with get,set
        member val Preview:ResizeArray<CoverageEffect> = new ResizeArray<CoverageEffect>() with get,set
        member val Confirm:ResizeArray<CoverageEffect> = new ResizeArray<CoverageEffect>() with get,set
        member val HasWarn:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CoverageBlockedCandidate() = 
        member val ContactId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Initials:String = null with get,set
        member val Reason:String = null with get,set
        member val ChangeChip:String = null with get,set
        member val Expl:CoverageExplanation = null with get,set

    [<AllowNullLiteral>]
    type CoverageOfferInfo() = 
        member val CoverageOfferId:Int32 = new Int32() with get,set
        member val ContactId:Int32 = new Int32() with get,set
        member val Name:String = null with get,set
        member val Ring:Int32 = new Int32() with get,set
        member val Channel:String = null with get,set
        member val Status:String = null with get,set
        member val SentAtUtc:DateTime = new DateTime() with get,set
        member val RespondedAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type CoverageApprovalInfo() = 
        member val CoverageApprovalId:Int32 = new Int32() with get,set
        member val CoverageGapId:Int32 = new Int32() with get,set
        member val Type:String = null with get,set
        member val Status:String = null with get,set
        member val RequestedAtUtc:DateTime = new DateTime() with get,set
        member val Effects:ResizeArray<CoverageEffect> = new ResizeArray<CoverageEffect>() with get,set
        member val ContactId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ContactName:String = null with get,set
        member val DecidedAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val DecisionNote:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageGapEventInfo() = 
        member val EventType:String = null with get,set
        member val Channel:String = null with get,set
        member val Detail:String = null with get,set
        member val ContactName:String = null with get,set
        member val AtUtc:DateTime = new DateTime() with get,set

    [<AllowNullLiteral>]
    type CoverageMoveOption() = 
        member val Key:String = null with get,set
        member val Label:String = null with get,set
        member val Detail:String = null with get,set
        member val Expl:CoverageExplanation = null with get,set

    [<AllowNullLiteral>]
    type CoverageNoShowAttempt() = 
        member val AtUtc:DateTime = new DateTime() with get,set
        member val Channel:String = null with get,set
        member val Note:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageNoShowState() = 
        member val GraceUntilUtc:DateTime = new DateTime() with get,set
        member val Attempts:ResizeArray<CoverageNoShowAttempt> = new ResizeArray<CoverageNoShowAttempt>() with get,set
        member val DeclaredAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val AttendanceNote:Boolean = new Boolean() with get,set
        member val FalseAlarm:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CoverageLeaveCheckpoint() = 
        member val AtUtc:DateTime = new DateTime() with get,set
        member val Note:String = null with get,set
        member val ByName:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageLeaveState() = 
        member val Fmla:Boolean = new Boolean() with get,set
        member val Began:DateTime = new DateTime() with get,set
        member val EstReturn:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val CheckpointDays:Int32 = new Int32() with get,set
        member val NextCheckpointUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Checkpoints:ResizeArray<CoverageLeaveCheckpoint> = new ResizeArray<CoverageLeaveCheckpoint>() with get,set
        member val InterimContactId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val InterimName:String = null with get,set
        member val InterimStart:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val InterimEnd:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val RequisitionOpened:Boolean = new Boolean() with get,set
        member val StaffPostingId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val ChainedGapIds:ResizeArray<Int32> = new ResizeArray<Int32>() with get,set
        member val ParentLeaveGapId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val RestoredAtUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set

    [<AllowNullLiteral>]
    type CoverageGap() = 
        member val CoverageGapId:Int32 = new Int32() with get,set
        member val CoverageGapUID:Guid = new Guid() with get,set
        member val BranchId:Nullable<Guid> = new Nullable<Guid>() with get,set
        member val Status:String = null with get,set
        member val Track:String = null with get,set
        member val OutContactID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val OutName:String = null with get,set
        member val OutInitials:String = null with get,set
        member val JobID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val JobName:String = null with get,set
        member val ProjectID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val WorkerScheduleItemID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val WindowStart:DateTime = new DateTime() with get,set
        member val WindowEnd:DateTime = new DateTime() with get,set
        member val Reason:String = null with get,set
        member val MustFill:Boolean = new Boolean() with get,set
        member val MustFillExpl:CoverageExplanation = null with get,set
        member val FilledByContactID:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val FilledByName:String = null with get,set
        member val RecordNo:String = null with get,set
        member val DecidedPolicyVersionId:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CreatedAt:DateTime = new DateTime() with get,set
        member val UpdatedAt:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val QualifiedLine:String = null with get,set
        member val Candidates:ResizeArray<CoverageCandidate> = new ResizeArray<CoverageCandidate>() with get,set
        member val Blocked:ResizeArray<CoverageBlockedCandidate> = new ResizeArray<CoverageBlockedCandidate>() with get,set
        member val Offers:ResizeArray<CoverageOfferInfo> = new ResizeArray<CoverageOfferInfo>() with get,set
        member val Approvals:ResizeArray<CoverageApprovalInfo> = new ResizeArray<CoverageApprovalInfo>() with get,set
        member val Timeline:ResizeArray<CoverageGapEventInfo> = new ResizeArray<CoverageGapEventInfo>() with get,set
        member val MoveOptions:ResizeArray<CoverageMoveOption> = new ResizeArray<CoverageMoveOption>() with get,set
        member val OrderExpl:CoverageExplanation = null with get,set
        member val AssignmentMode:String = null with get,set
        member val NoShow:CoverageNoShowState = null with get,set
        member val Leave:CoverageLeaveState = null with get,set
        member val CustomerName:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageGapResponse() = 
        member val Gap:CoverageGap = null with get,set
        member val ChainedPreview:Nullable<Int32> = new Nullable<Int32>() with get,set
        member val CanSeePay:Boolean = new Boolean() with get,set
        member val ResponseStatus:ResponseStatus = null with get,set

    [<AllowNullLiteral>]
    type CoverageNoShowDeclareRequest() = 
        member val CoverageGapId:Int32 = new Int32() with get,set
        member val AttendanceNote:Boolean = new Boolean() with get,set

F# CoverageNoShowDeclareRequest 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/declare HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/xml
Content-Type: application/xml
Content-Length: length

<CoverageNoShowDeclareRequest xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
  <AttendanceNote>false</AttendanceNote>
  <CoverageGapId>0</CoverageGapId>
</CoverageNoShowDeclareRequest>
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>