Trendsic Platform Service

<back to all web services

CoverageSwapProposeRequest

Requires Authentication
The following routes are available for this service:
POST/v1/coverage/swap
using System;
using System.IO;
using System.Collections;
using System.Collections.Generic;
using System.Runtime.Serialization;
using ServiceStack;
using ServiceStack.DataAnnotations;
using CRM.AgencyPlatform.API.Internal;

namespace CRM.AgencyPlatform.API.Internal
{
    public partial class CoverageApprovalInfo
    {
        public virtual int CoverageApprovalId { get; set; }
        public virtual int CoverageGapId { get; set; }
        public virtual string Type { get; set; }
        public virtual string Status { get; set; }
        public virtual DateTime RequestedAtUtc { get; set; }
        public virtual List<CoverageEffect> Effects { get; set; } = [];
        public virtual int? ContactId { get; set; }
        public virtual string ContactName { get; set; }
        public virtual DateTime? DecidedAtUtc { get; set; }
        public virtual string DecisionNote { get; set; }
    }

    public partial class CoverageBlockedCandidate
    {
        public virtual int ContactId { get; set; }
        public virtual string Name { get; set; }
        public virtual string Initials { get; set; }
        public virtual string Reason { get; set; }
        public virtual string ChangeChip { get; set; }
        public virtual CoverageExplanation Expl { get; set; }
    }

    public partial class CoverageCandidate
    {
        public virtual int ContactId { get; set; }
        public virtual string Name { get; set; }
        public virtual string FirstName { get; set; }
        public virtual string Initials { get; set; }
        public virtual int Rank { get; set; }
        public virtual string DiffLine { get; set; }
        public virtual string CostLine { get; set; }
        public virtual string CostTone { get; set; }
        public virtual CoverageExplanation RankExpl { get; set; }
        public virtual decimal? MarginPct { get; set; }
        public virtual string MarginTone { get; set; }
        public virtual decimal? Loaded { get; set; }
        public virtual decimal? Billed { get; set; }
        public virtual decimal? OtHours { get; set; }
        public virtual decimal? OtPremium { get; set; }
        public virtual List<CoverageCandidateCheck> Checks { get; set; } = [];
        public virtual List<CoverageEffect> Preview { get; set; } = [];
        public virtual List<CoverageEffect> Confirm { get; set; } = [];
        public virtual bool HasWarn { get; set; }
    }

    public partial class CoverageCandidateCheck
    {
        public virtual string CheckId { get; set; }
        public virtual string Result { get; set; }
        public virtual CoverageExplanation Expl { get; set; }
    }

    public partial class CoverageEffect
    {
        public virtual string Icon { get; set; }
        public virtual string Text { get; set; }
        public virtual string RuleId { get; set; }
        public virtual CoverageExplanation Expl { get; set; }
    }

    public partial class CoverageExplanation
    {
        public virtual string PlainSentence { get; set; }
        public virtual string RuleId { get; set; }
        public virtual string RuleName { get; set; }
        public virtual string Demand { get; set; }
        public virtual CoverageExplanationSource Source { get; set; }
        public virtual string Kind { get; set; }
        public virtual string WhyItExists { get; set; }
        public virtual string WhatWouldChangeIt { get; set; }
        public virtual CoverageExplanationOverride Override { get; set; }
        public virtual string Drill { get; set; }
    }

    public partial class CoverageExplanationOverride
    {
        public virtual string Who { get; set; }
        public virtual string Consequence { get; set; }
    }

    public partial class CoverageExplanationSource
    {
        public virtual string PolicyName { get; set; }
        public virtual string CascadeLevel { get; set; }
    }

    public partial class CoverageGap
    {
        public virtual int CoverageGapId { get; set; }
        public virtual Guid CoverageGapUID { get; set; }
        public virtual Guid? BranchId { get; set; }
        public virtual string Status { get; set; }
        public virtual string Track { get; set; }
        public virtual int? OutContactID { get; set; }
        public virtual string OutName { get; set; }
        public virtual string OutInitials { get; set; }
        public virtual int? JobID { get; set; }
        public virtual string JobName { get; set; }
        public virtual int? ProjectID { get; set; }
        public virtual int? WorkerScheduleItemID { get; set; }
        public virtual DateTime WindowStart { get; set; }
        public virtual DateTime WindowEnd { get; set; }
        public virtual string Reason { get; set; }
        public virtual bool MustFill { get; set; }
        public virtual CoverageExplanation MustFillExpl { get; set; }
        public virtual int? FilledByContactID { get; set; }
        public virtual string FilledByName { get; set; }
        public virtual string RecordNo { get; set; }
        public virtual int? DecidedPolicyVersionId { get; set; }
        public virtual DateTime CreatedAt { get; set; }
        public virtual DateTime? UpdatedAt { get; set; }
        public virtual string QualifiedLine { get; set; }
        public virtual List<CoverageCandidate> Candidates { get; set; } = [];
        public virtual List<CoverageBlockedCandidate> Blocked { get; set; } = [];
        public virtual List<CoverageOfferInfo> Offers { get; set; } = [];
        public virtual List<CoverageApprovalInfo> Approvals { get; set; } = [];
        public virtual List<CoverageGapEventInfo> Timeline { get; set; } = [];
        public virtual List<CoverageMoveOption> MoveOptions { get; set; } = [];
        public virtual CoverageExplanation OrderExpl { get; set; }
        public virtual string AssignmentMode { get; set; }
        public virtual CoverageNoShowState NoShow { get; set; }
        public virtual CoverageLeaveState Leave { get; set; }
        public virtual string CustomerName { get; set; }
    }

    public partial class CoverageGapEventInfo
    {
        public virtual string EventType { get; set; }
        public virtual string Channel { get; set; }
        public virtual string Detail { get; set; }
        public virtual string ContactName { get; set; }
        public virtual DateTime AtUtc { get; set; }
    }

    public partial class CoverageGapResponse
    {
        public virtual CoverageGap Gap { get; set; }
        public virtual int? ChainedPreview { get; set; }
        public virtual bool CanSeePay { get; set; }
        public virtual ResponseStatus ResponseStatus { get; set; }
    }

    public partial class CoverageLeaveCheckpoint
    {
        public virtual DateTime AtUtc { get; set; }
        public virtual string Note { get; set; }
        public virtual string ByName { get; set; }
    }

    public partial class CoverageLeaveState
    {
        public virtual bool Fmla { get; set; }
        public virtual DateTime Began { get; set; }
        public virtual DateTime? EstReturn { get; set; }
        public virtual int CheckpointDays { get; set; }
        public virtual DateTime? NextCheckpointUtc { get; set; }
        public virtual List<CoverageLeaveCheckpoint> Checkpoints { get; set; } = [];
        public virtual int? InterimContactId { get; set; }
        public virtual string InterimName { get; set; }
        public virtual DateTime? InterimStart { get; set; }
        public virtual DateTime? InterimEnd { get; set; }
        public virtual bool RequisitionOpened { get; set; }
        public virtual int? StaffPostingId { get; set; }
        public virtual List<int> ChainedGapIds { get; set; } = [];
        public virtual int? ParentLeaveGapId { get; set; }
        public virtual DateTime? RestoredAtUtc { get; set; }
    }

    public partial class CoverageMoveOption
    {
        public virtual string Key { get; set; }
        public virtual string Label { get; set; }
        public virtual string Detail { get; set; }
        public virtual CoverageExplanation Expl { get; set; }
    }

    public partial class CoverageNoShowAttempt
    {
        public virtual DateTime AtUtc { get; set; }
        public virtual string Channel { get; set; }
        public virtual string Note { get; set; }
    }

    public partial class CoverageNoShowState
    {
        public virtual DateTime GraceUntilUtc { get; set; }
        public virtual List<CoverageNoShowAttempt> Attempts { get; set; } = [];
        public virtual DateTime? DeclaredAtUtc { get; set; }
        public virtual bool AttendanceNote { get; set; }
        public virtual bool FalseAlarm { get; set; }
    }

    public partial class CoverageOfferInfo
    {
        public virtual int CoverageOfferId { get; set; }
        public virtual int ContactId { get; set; }
        public virtual string Name { get; set; }
        public virtual int Ring { get; set; }
        public virtual string Channel { get; set; }
        public virtual string Status { get; set; }
        public virtual DateTime SentAtUtc { get; set; }
        public virtual DateTime? RespondedAtUtc { get; set; }
    }

    public partial class CoverageSwapProposeRequest
    {
        public virtual int AItemId { get; set; }
        public virtual int BItemId { get; set; }
        public virtual bool Directed { get; set; }
    }

}

C# CoverageSwapProposeRequest DTOs

To override the Content-type in your clients, use the HTTP Accept Header, append the .json suffix or ?format=json

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

The following are sample HTTP requests and responses. The placeholders shown need to be replaced with actual values.

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

{"AItemId":0,"BItemId":0,"Directed":false}

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

{"Gap":{"CoverageGapId":0,"CoverageGapUID":"00000000000000000000000000000000","BranchId":"00000000000000000000000000000000","Status":"String","Track":"String","OutContactID":0,"OutName":"String","OutInitials":"String","JobID":0,"JobName":"String","ProjectID":0,"WorkerScheduleItemID":0,"WindowStart":"0001-01-01T00:00:00.0000000","WindowEnd":"0001-01-01T00:00:00.0000000","Reason":"String","MustFill":false,"MustFillExpl":{"PlainSentence":"String","RuleId":"String","RuleName":"String","Demand":"String","Source":{"PolicyName":"String","CascadeLevel":"String"},"Kind":"String","WhyItExists":"String","WhatWouldChangeIt":"String","Override":{"Who":"String","Consequence":"String"},"Drill":"String"},"FilledByContactID":0,"FilledByName":"String","RecordNo":"String","DecidedPolicyVersionId":0,"CreatedAt":"0001-01-01T00:00:00.0000000","UpdatedAt":"0001-01-01T00:00:00.0000000","QualifiedLine":"String","Candidates":[{"ContactId":0,"Name":"String","FirstName":"String","Initials":"String","Rank":0,"DiffLine":"String","CostLine":"String","CostTone":"String","RankExpl":{"PlainSentence":"String","RuleId":"String","RuleName":"String","Demand":"String","Source":{"PolicyName":"String","CascadeLevel":"String"},"Kind":"String","WhyItExists":"String","WhatWouldChangeIt":"String","Override":{"Who":"String","Consequence":"String"},"Drill":"String"},"MarginPct":0,"MarginTone":"String","Loaded":0,"Billed":0,"OtHours":0,"OtPremium":0,"Checks":[{"CheckId":"String","Result":"String","Expl":{"PlainSentence":"String","RuleId":"String","RuleName":"String","Demand":"String","Source":{"PolicyName":"String","CascadeLevel":"String"},"Kind":"String","WhyItExists":"String","WhatWouldChangeIt":"String","Override":{"Who":"String","Consequence":"String"},"Drill":"String"}}],"Preview":[{"Icon":"String","Text":"String","RuleId":"String","Expl":{"PlainSentence":"String","RuleId":"String","RuleName":"String","Demand":"String","Source":{"PolicyName":"String","CascadeLevel":"String"},"Kind":"String","WhyItExists":"String","WhatWouldChangeIt":"String","Override":{"Who":"String","Consequence":"String"},"Drill":"String"}}],"Confirm":[{"Icon":"String","Text":"String","RuleId":"String","Expl":{"PlainSentence":"String","RuleId":"String","RuleName":"String","Demand":"String","Source":{"PolicyName":"String","CascadeLevel":"String"},"Kind":"String","WhyItExists":"String","WhatWouldChangeIt":"String","Override":{"Who":"String","Consequence":"String"},"Drill":"String"}}],"HasWarn":false}],"Blocked":[{"ContactId":0,"Name":"String","Initials":"String","Reason":"String","ChangeChip":"String","Expl":{"PlainSentence":"String","RuleId":"String","RuleName":"String","Demand":"String","Source":{"PolicyName":"String","CascadeLevel":"String"},"Kind":"String","WhyItExists":"String","WhatWouldChangeIt":"String","Override":{"Who":"String","Consequence":"String"},"Drill":"String"}}],"Offers":[{"CoverageOfferId":0,"ContactId":0,"Name":"String","Ring":0,"Channel":"String","Status":"String","SentAtUtc":"0001-01-01T00:00:00.0000000","RespondedAtUtc":"0001-01-01T00:00:00.0000000"}],"Approvals":[{"CoverageApprovalId":0,"CoverageGapId":0,"Type":"String","Status":"String","RequestedAtUtc":"0001-01-01T00:00:00.0000000","Effects":[{"Icon":"String","Text":"String","RuleId":"String","Expl":{"PlainSentence":"String","RuleId":"String","RuleName":"String","Demand":"String","Source":{"PolicyName":"String","CascadeLevel":"String"},"Kind":"String","WhyItExists":"String","WhatWouldChangeIt":"String","Override":{"Who":"String","Consequence":"String"},"Drill":"String"}}],"ContactId":0,"ContactName":"String","DecidedAtUtc":"0001-01-01T00:00:00.0000000","DecisionNote":"String"}],"Timeline":[{"EventType":"String","Channel":"String","Detail":"String","ContactName":"String","AtUtc":"0001-01-01T00:00:00.0000000"}],"MoveOptions":[{"Key":"String","Label":"String","Detail":"String","Expl":{"PlainSentence":"String","RuleId":"String","RuleName":"String","Demand":"String","Source":{"PolicyName":"String","CascadeLevel":"String"},"Kind":"String","WhyItExists":"String","WhatWouldChangeIt":"String","Override":{"Who":"String","Consequence":"String"},"Drill":"String"}}],"OrderExpl":{"PlainSentence":"String","RuleId":"String","RuleName":"String","Demand":"String","Source":{"PolicyName":"String","CascadeLevel":"String"},"Kind":"String","WhyItExists":"String","WhatWouldChangeIt":"String","Override":{"Who":"String","Consequence":"String"},"Drill":"String"},"AssignmentMode":"String","NoShow":{"GraceUntilUtc":"0001-01-01T00:00:00.0000000","Attempts":[{"AtUtc":"0001-01-01T00:00:00.0000000","Channel":"String","Note":"String"}],"DeclaredAtUtc":"0001-01-01T00:00:00.0000000","AttendanceNote":false,"FalseAlarm":false},"Leave":{"Fmla":false,"Began":"0001-01-01T00:00:00.0000000","EstReturn":"0001-01-01T00:00:00.0000000","CheckpointDays":0,"NextCheckpointUtc":"0001-01-01T00:00:00.0000000","Checkpoints":[{"AtUtc":"0001-01-01T00:00:00.0000000","Note":"String","ByName":"String"}],"InterimContactId":0,"InterimName":"String","InterimStart":"0001-01-01T00:00:00.0000000","InterimEnd":"0001-01-01T00:00:00.0000000","RequisitionOpened":false,"StaffPostingId":0,"ChainedGapIds":[0],"ParentLeaveGapId":0,"RestoredAtUtc":"0001-01-01T00:00:00.0000000"},"CustomerName":"String"},"ChainedPreview":0,"CanSeePay":false,"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}}}