Trendsic Platform Service

<back to all web services

CoverageBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/board
"use strict";
export class CoverageSelfMatrixRow {
    /** @param {{Name?:string,Note?:string,Tone?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Note;
    /** @type {string} */
    Tone;
}
export class CoverageBoardShift {
    /** @param {{CoverageGapId?:number,State?:string,Day?:string,Window?:string,Site?:string,Role?:string,Poster?:string,ExpiryLabel?:string,ExpiresSoon?:boolean,EligibleCount?:number,IneligibleCount?:number,OfferedCount?:number,ClaimsCount?:number,ClaimantName?:string,AudienceTier?:string,Matrix?:CoverageSelfMatrixRow[],NotYetOffered?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CoverageGapId;
    /** @type {string} */
    State;
    /** @type {string} */
    Day;
    /** @type {string} */
    Window;
    /** @type {string} */
    Site;
    /** @type {string} */
    Role;
    /** @type {string} */
    Poster;
    /** @type {string} */
    ExpiryLabel;
    /** @type {boolean} */
    ExpiresSoon;
    /** @type {number} */
    EligibleCount;
    /** @type {number} */
    IneligibleCount;
    /** @type {number} */
    OfferedCount;
    /** @type {number} */
    ClaimsCount;
    /** @type {string} */
    ClaimantName;
    /** @type {string} */
    AudienceTier;
    /** @type {CoverageSelfMatrixRow[]} */
    Matrix = [];
    /** @type {number} */
    NotYetOffered;
}
export class CoverageBoardApproval {
    /** @param {{CoverageApprovalId?:number,CoverageGapId?:number,Claimant?:string,Poster?:string,Day?:string,Window?:string,Site?:string,Role?:string,OtText?:string,OtNote?:string,OtWarn?:boolean,MarginText?:string,MarginNote?:string,MarginTone?:string,EligText?:string,EligNote?:string,EligWarn?:boolean,Channel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CoverageApprovalId;
    /** @type {number} */
    CoverageGapId;
    /** @type {string} */
    Claimant;
    /** @type {string} */
    Poster;
    /** @type {string} */
    Day;
    /** @type {string} */
    Window;
    /** @type {string} */
    Site;
    /** @type {string} */
    Role;
    /** @type {string} */
    OtText;
    /** @type {string} */
    OtNote;
    /** @type {boolean} */
    OtWarn;
    /** @type {string} */
    MarginText;
    /** @type {string} */
    MarginNote;
    /** @type {string} */
    MarginTone;
    /** @type {string} */
    EligText;
    /** @type {string} */
    EligNote;
    /** @type {boolean} */
    EligWarn;
    /** @type {string} */
    Channel;
}
export class CoverageBoardHistoryRow {
    /** @param {{Kind?:string,Title?:string,Detail?:string,Outcome?:string,WhenLabel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Kind;
    /** @type {string} */
    Title;
    /** @type {string} */
    Detail;
    /** @type {string} */
    Outcome;
    /** @type {string} */
    WhenLabel;
}
export class CoverageBoardResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Shifts?:CoverageBoardShift[],Approvals?:CoverageBoardApproval[],History?:CoverageBoardHistoryRow[],CanApprove?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CoverageBoardShift[]} */
    Shifts = [];
    /** @type {CoverageBoardApproval[]} */
    Approvals = [];
    /** @type {CoverageBoardHistoryRow[]} */
    History = [];
    /** @type {boolean} */
    CanApprove;
}
export class CoverageBoardRequest {
    /** @param {{BranchId?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {?string} */
    BranchId;
}

JavaScript 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}