Trendsic Platform Service

<back to all web services

CoverageBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/board
import java.math.*;
import java.util.*;
import java.io.InputStream;
import net.servicestack.client.*;

public class dtos
{

    public static class CoverageBoardRequest
    {
        public UUID BranchId = null;
        
        public UUID getBranchId() { return BranchId; }
        public CoverageBoardRequest setBranchId(UUID value) { this.BranchId = value; return this; }
    }

    public static class CoverageBoardResponse
    {
        public ResponseStatus ResponseStatus = null;
        public ArrayList<CoverageBoardShift> Shifts = new ArrayList<CoverageBoardShift>();
        public ArrayList<CoverageBoardApproval> Approvals = new ArrayList<CoverageBoardApproval>();
        public ArrayList<CoverageBoardHistoryRow> History = new ArrayList<CoverageBoardHistoryRow>();
        public Boolean CanApprove = null;
        
        public ResponseStatus getResponseStatus() { return ResponseStatus; }
        public CoverageBoardResponse setResponseStatus(ResponseStatus value) { this.ResponseStatus = value; return this; }
        public ArrayList<CoverageBoardShift> getShifts() { return Shifts; }
        public CoverageBoardResponse setShifts(ArrayList<CoverageBoardShift> value) { this.Shifts = value; return this; }
        public ArrayList<CoverageBoardApproval> getApprovals() { return Approvals; }
        public CoverageBoardResponse setApprovals(ArrayList<CoverageBoardApproval> value) { this.Approvals = value; return this; }
        public ArrayList<CoverageBoardHistoryRow> getHistory() { return History; }
        public CoverageBoardResponse setHistory(ArrayList<CoverageBoardHistoryRow> value) { this.History = value; return this; }
        public Boolean isCanApprove() { return CanApprove; }
        public CoverageBoardResponse setCanApprove(Boolean value) { this.CanApprove = value; return this; }
    }

    public static class CoverageBoardShift
    {
        public Integer CoverageGapId = null;
        public String State = null;
        public String Day = null;
        public String Window = null;
        public String Site = null;
        public String Role = null;
        public String Poster = null;
        public String ExpiryLabel = null;
        public Boolean ExpiresSoon = null;
        public Integer EligibleCount = null;
        public Integer IneligibleCount = null;
        public Integer OfferedCount = null;
        public Integer ClaimsCount = null;
        public String ClaimantName = null;
        public String AudienceTier = null;
        public ArrayList<CoverageSelfMatrixRow> Matrix = new ArrayList<CoverageSelfMatrixRow>();
        public Integer NotYetOffered = null;
        
        public Integer getCoverageGapId() { return CoverageGapId; }
        public CoverageBoardShift setCoverageGapId(Integer value) { this.CoverageGapId = value; return this; }
        public String getState() { return State; }
        public CoverageBoardShift setState(String value) { this.State = value; return this; }
        public String getDay() { return Day; }
        public CoverageBoardShift setDay(String value) { this.Day = value; return this; }
        public String getWindow() { return Window; }
        public CoverageBoardShift setWindow(String value) { this.Window = value; return this; }
        public String getSite() { return Site; }
        public CoverageBoardShift setSite(String value) { this.Site = value; return this; }
        public String getRole() { return Role; }
        public CoverageBoardShift setRole(String value) { this.Role = value; return this; }
        public String getPoster() { return Poster; }
        public CoverageBoardShift setPoster(String value) { this.Poster = value; return this; }
        public String getExpiryLabel() { return ExpiryLabel; }
        public CoverageBoardShift setExpiryLabel(String value) { this.ExpiryLabel = value; return this; }
        public Boolean isExpiresSoon() { return ExpiresSoon; }
        public CoverageBoardShift setExpiresSoon(Boolean value) { this.ExpiresSoon = value; return this; }
        public Integer getEligibleCount() { return EligibleCount; }
        public CoverageBoardShift setEligibleCount(Integer value) { this.EligibleCount = value; return this; }
        public Integer getIneligibleCount() { return IneligibleCount; }
        public CoverageBoardShift setIneligibleCount(Integer value) { this.IneligibleCount = value; return this; }
        public Integer getOfferedCount() { return OfferedCount; }
        public CoverageBoardShift setOfferedCount(Integer value) { this.OfferedCount = value; return this; }
        public Integer getClaimsCount() { return ClaimsCount; }
        public CoverageBoardShift setClaimsCount(Integer value) { this.ClaimsCount = value; return this; }
        public String getClaimantName() { return ClaimantName; }
        public CoverageBoardShift setClaimantName(String value) { this.ClaimantName = value; return this; }
        public String getAudienceTier() { return AudienceTier; }
        public CoverageBoardShift setAudienceTier(String value) { this.AudienceTier = value; return this; }
        public ArrayList<CoverageSelfMatrixRow> getMatrix() { return Matrix; }
        public CoverageBoardShift setMatrix(ArrayList<CoverageSelfMatrixRow> value) { this.Matrix = value; return this; }
        public Integer getNotYetOffered() { return NotYetOffered; }
        public CoverageBoardShift setNotYetOffered(Integer value) { this.NotYetOffered = value; return this; }
    }

    public static class CoverageSelfMatrixRow
    {
        public String Name = null;
        public String Note = null;
        public String Tone = null;
        
        public String getName() { return Name; }
        public CoverageSelfMatrixRow setName(String value) { this.Name = value; return this; }
        public String getNote() { return Note; }
        public CoverageSelfMatrixRow setNote(String value) { this.Note = value; return this; }
        public String getTone() { return Tone; }
        public CoverageSelfMatrixRow setTone(String value) { this.Tone = value; return this; }
    }

    public static class CoverageBoardApproval
    {
        public Integer CoverageApprovalId = null;
        public Integer CoverageGapId = null;
        public String Claimant = null;
        public String Poster = null;
        public String Day = null;
        public String Window = null;
        public String Site = null;
        public String Role = null;
        public String OtText = null;
        public String OtNote = null;
        public Boolean OtWarn = null;
        public String MarginText = null;
        public String MarginNote = null;
        public String MarginTone = null;
        public String EligText = null;
        public String EligNote = null;
        public Boolean EligWarn = null;
        public String Channel = null;
        
        public Integer getCoverageApprovalId() { return CoverageApprovalId; }
        public CoverageBoardApproval setCoverageApprovalId(Integer value) { this.CoverageApprovalId = value; return this; }
        public Integer getCoverageGapId() { return CoverageGapId; }
        public CoverageBoardApproval setCoverageGapId(Integer value) { this.CoverageGapId = value; return this; }
        public String getClaimant() { return Claimant; }
        public CoverageBoardApproval setClaimant(String value) { this.Claimant = value; return this; }
        public String getPoster() { return Poster; }
        public CoverageBoardApproval setPoster(String value) { this.Poster = value; return this; }
        public String getDay() { return Day; }
        public CoverageBoardApproval setDay(String value) { this.Day = value; return this; }
        public String getWindow() { return Window; }
        public CoverageBoardApproval setWindow(String value) { this.Window = value; return this; }
        public String getSite() { return Site; }
        public CoverageBoardApproval setSite(String value) { this.Site = value; return this; }
        public String getRole() { return Role; }
        public CoverageBoardApproval setRole(String value) { this.Role = value; return this; }
        public String getOtText() { return OtText; }
        public CoverageBoardApproval setOtText(String value) { this.OtText = value; return this; }
        public String getOtNote() { return OtNote; }
        public CoverageBoardApproval setOtNote(String value) { this.OtNote = value; return this; }
        public Boolean isOtWarn() { return OtWarn; }
        public CoverageBoardApproval setOtWarn(Boolean value) { this.OtWarn = value; return this; }
        public String getMarginText() { return MarginText; }
        public CoverageBoardApproval setMarginText(String value) { this.MarginText = value; return this; }
        public String getMarginNote() { return MarginNote; }
        public CoverageBoardApproval setMarginNote(String value) { this.MarginNote = value; return this; }
        public String getMarginTone() { return MarginTone; }
        public CoverageBoardApproval setMarginTone(String value) { this.MarginTone = value; return this; }
        public String getEligText() { return EligText; }
        public CoverageBoardApproval setEligText(String value) { this.EligText = value; return this; }
        public String getEligNote() { return EligNote; }
        public CoverageBoardApproval setEligNote(String value) { this.EligNote = value; return this; }
        public Boolean isEligWarn() { return EligWarn; }
        public CoverageBoardApproval setEligWarn(Boolean value) { this.EligWarn = value; return this; }
        public String getChannel() { return Channel; }
        public CoverageBoardApproval setChannel(String value) { this.Channel = value; return this; }
    }

    public static class CoverageBoardHistoryRow
    {
        public String Kind = null;
        public String Title = null;
        public String Detail = null;
        public String Outcome = null;
        public String WhenLabel = null;
        
        public String getKind() { return Kind; }
        public CoverageBoardHistoryRow setKind(String value) { this.Kind = value; return this; }
        public String getTitle() { return Title; }
        public CoverageBoardHistoryRow setTitle(String value) { this.Title = value; return this; }
        public String getDetail() { return Detail; }
        public CoverageBoardHistoryRow setDetail(String value) { this.Detail = value; return this; }
        public String getOutcome() { return Outcome; }
        public CoverageBoardHistoryRow setOutcome(String value) { this.Outcome = value; return this; }
        public String getWhenLabel() { return WhenLabel; }
        public CoverageBoardHistoryRow setWhenLabel(String value) { this.WhenLabel = value; return this; }
    }

}

Java CoverageBoardRequest DTOs

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

HTTP + CSV

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: text/csv
HTTP/1.1 200 OK
Content-Type: text/csv
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}