Trendsic Platform Service

<back to all web services

CoverageBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/board
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 CoverageBoardApproval
    {
        public virtual int CoverageApprovalId { get; set; }
        public virtual int CoverageGapId { get; set; }
        public virtual string Claimant { get; set; }
        public virtual string Poster { get; set; }
        public virtual string Day { get; set; }
        public virtual string Window { get; set; }
        public virtual string Site { get; set; }
        public virtual string Role { get; set; }
        public virtual string OtText { get; set; }
        public virtual string OtNote { get; set; }
        public virtual bool OtWarn { get; set; }
        public virtual string MarginText { get; set; }
        public virtual string MarginNote { get; set; }
        public virtual string MarginTone { get; set; }
        public virtual string EligText { get; set; }
        public virtual string EligNote { get; set; }
        public virtual bool EligWarn { get; set; }
        public virtual string Channel { get; set; }
    }

    public partial class CoverageBoardHistoryRow
    {
        public virtual string Kind { get; set; }
        public virtual string Title { get; set; }
        public virtual string Detail { get; set; }
        public virtual string Outcome { get; set; }
        public virtual string WhenLabel { get; set; }
    }

    public partial class CoverageBoardRequest
    {
        public virtual Guid? BranchId { get; set; }
    }

    public partial class CoverageBoardResponse
    {
        public virtual ResponseStatus ResponseStatus { get; set; }
        public virtual List<CoverageBoardShift> Shifts { get; set; } = [];
        public virtual List<CoverageBoardApproval> Approvals { get; set; } = [];
        public virtual List<CoverageBoardHistoryRow> History { get; set; } = [];
        public virtual bool CanApprove { get; set; }
    }

    public partial class CoverageBoardShift
    {
        public virtual int CoverageGapId { get; set; }
        public virtual string State { get; set; }
        public virtual string Day { get; set; }
        public virtual string Window { get; set; }
        public virtual string Site { get; set; }
        public virtual string Role { get; set; }
        public virtual string Poster { get; set; }
        public virtual string ExpiryLabel { get; set; }
        public virtual bool ExpiresSoon { get; set; }
        public virtual int EligibleCount { get; set; }
        public virtual int IneligibleCount { get; set; }
        public virtual int OfferedCount { get; set; }
        public virtual int ClaimsCount { get; set; }
        public virtual string ClaimantName { get; set; }
        public virtual string AudienceTier { get; set; }
        public virtual List<CoverageSelfMatrixRow> Matrix { get; set; } = [];
        public virtual int NotYetOffered { get; set; }
    }

    public partial class CoverageSelfMatrixRow
    {
        public virtual string Name { get; set; }
        public virtual string Note { get; set; }
        public virtual string Tone { get; set; }
    }

}

C# CoverageBoardRequest 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.

GET /v1/coverage/board HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: application/json
HTTP/1.1 200 OK
Content-Type: application/json
Content-Length: length

{"ResponseStatus":{"ErrorCode":"String","Message":"String","StackTrace":"String","Errors":[{"ErrorCode":"String","FieldName":"String","Message":"String","Meta":{"String":"String"}}],"Meta":{"String":"String"}},"Shifts":[{"CoverageGapId":0,"State":"String","Day":"String","Window":"String","Site":"String","Role":"String","Poster":"String","ExpiryLabel":"String","ExpiresSoon":false,"EligibleCount":0,"IneligibleCount":0,"OfferedCount":0,"ClaimsCount":0,"ClaimantName":"String","AudienceTier":"String","Matrix":[{"Name":"String","Note":"String","Tone":"String"}],"NotYetOffered":0}],"Approvals":[{"CoverageApprovalId":0,"CoverageGapId":0,"Claimant":"String","Poster":"String","Day":"String","Window":"String","Site":"String","Role":"String","OtText":"String","OtNote":"String","OtWarn":false,"MarginText":"String","MarginNote":"String","MarginTone":"String","EligText":"String","EligNote":"String","EligWarn":false,"Channel":"String"}],"History":[{"Kind":"String","Title":"String","Detail":"String","Outcome":"String","WhenLabel":"String"}],"CanApprove":false}