Trendsic Platform Service

<back to all web services

CoverageBoardRequest

export class CoverageSelfMatrixRow
{
    public Name: string;
    public Note: string;
    public Tone: string;

    public constructor(init?: Partial<CoverageSelfMatrixRow>) { (Object as any).assign(this, init); }
}

export class CoverageBoardShift
{
    public CoverageGapId: number;
    public State: string;
    public Day: string;
    public Window: string;
    public Site: string;
    public Role: string;
    public Poster: string;
    public ExpiryLabel: string;
    public ExpiresSoon: boolean;
    public EligibleCount: number;
    public IneligibleCount: number;
    public OfferedCount: number;
    public ClaimsCount: number;
    public ClaimantName: string;
    public AudienceTier: string;
    public Matrix: CoverageSelfMatrixRow[] = [];
    public NotYetOffered: number;

    public constructor(init?: Partial<CoverageBoardShift>) { (Object as any).assign(this, init); }
}

export class CoverageBoardApproval
{
    public CoverageApprovalId: number;
    public CoverageGapId: number;
    public Claimant: string;
    public Poster: string;
    public Day: string;
    public Window: string;
    public Site: string;
    public Role: string;
    public OtText: string;
    public OtNote: string;
    public OtWarn: boolean;
    public MarginText: string;
    public MarginNote: string;
    public MarginTone: string;
    public EligText: string;
    public EligNote: string;
    public EligWarn: boolean;
    public Channel: string;

    public constructor(init?: Partial<CoverageBoardApproval>) { (Object as any).assign(this, init); }
}

export class CoverageBoardHistoryRow
{
    public Kind: string;
    public Title: string;
    public Detail: string;
    public Outcome: string;
    public WhenLabel: string;

    public constructor(init?: Partial<CoverageBoardHistoryRow>) { (Object as any).assign(this, init); }
}

export class CoverageBoardResponse
{
    public ResponseStatus: ResponseStatus;
    public Shifts: CoverageBoardShift[] = [];
    public Approvals: CoverageBoardApproval[] = [];
    public History: CoverageBoardHistoryRow[] = [];
    public CanApprove: boolean;

    public constructor(init?: Partial<CoverageBoardResponse>) { (Object as any).assign(this, init); }
}

export class CoverageBoardRequest
{
    public BranchId?: string;

    public constructor(init?: Partial<CoverageBoardRequest>) { (Object as any).assign(this, init); }
}

TypeScript CoverageBoardRequest DTOs

GET /v1/coverage/board HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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