Trendsic Platform Service

<back to all web services

CoverageSelfBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/self/board
"use strict";
export class CoverageSelfBoardShift {
    /** @param {{CoverageGapId?:number,Day?:string,Window?:string,Site?:string,Role?:string,Poster?:string,Expiry?:string,Why?:string,NeedsApproval?:boolean,Pending?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CoverageGapId;
    /** @type {string} */
    Day;
    /** @type {string} */
    Window;
    /** @type {string} */
    Site;
    /** @type {string} */
    Role;
    /** @type {string} */
    Poster;
    /** @type {string} */
    Expiry;
    /** @type {string} */
    Why;
    /** @type {boolean} */
    NeedsApproval;
    /** @type {boolean} */
    Pending;
}
export class CoverageSelfEligibility {
    /** @param {{Tone?:string,Text?:string,CanClaim?:boolean,ClaimLabel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Tone;
    /** @type {string} */
    Text;
    /** @type {boolean} */
    CanClaim;
    /** @type {string} */
    ClaimLabel;
}
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 CoverageSelfCard {
    /** @param {{CoverageGapId?:number,Kind?:string,Status?:string,ShiftDay?:string,ShiftWindow?:string,ShiftStartUtc?:string,Site?:string,RoleNeeded?:string,ExpiryLabel?:string,PosterName?:string,EligibleCount?:number,IneligibleCount?:number,MyEligibility?:CoverageSelfEligibility,Matrix?:CoverageSelfMatrixRow[],SwapState?:string,SwapFromName?:string,SwapTargetName?:string,OfferShift?:string,WantShift?:string,ConflictOk?:boolean,ConflictLabel?:string,CanRespond?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CoverageGapId;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Status;
    /** @type {string} */
    ShiftDay;
    /** @type {string} */
    ShiftWindow;
    /** @type {?string} */
    ShiftStartUtc;
    /** @type {string} */
    Site;
    /** @type {string} */
    RoleNeeded;
    /** @type {string} */
    ExpiryLabel;
    /** @type {string} */
    PosterName;
    /** @type {number} */
    EligibleCount;
    /** @type {number} */
    IneligibleCount;
    /** @type {CoverageSelfEligibility} */
    MyEligibility;
    /** @type {CoverageSelfMatrixRow[]} */
    Matrix = [];
    /** @type {string} */
    SwapState;
    /** @type {string} */
    SwapFromName;
    /** @type {string} */
    SwapTargetName;
    /** @type {string} */
    OfferShift;
    /** @type {string} */
    WantShift;
    /** @type {boolean} */
    ConflictOk;
    /** @type {string} */
    ConflictLabel;
    /** @type {boolean} */
    CanRespond;
}
export class CoverageSelfBoardResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Eligible?:CoverageSelfBoardShift[],Ineligible?:CoverageSelfBoardShift[],MyPosted?:CoverageSelfCard}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CoverageSelfBoardShift[]} */
    Eligible = [];
    /** @type {CoverageSelfBoardShift[]} */
    Ineligible = [];
    /** @type {CoverageSelfCard} */
    MyPosted;
}
export class CoverageSelfBoardRequest {
    constructor(init) { Object.assign(this, init) }
}

JavaScript CoverageSelfBoardRequest 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/self/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"}},"Eligible":[{"CoverageGapId":0,"Day":"String","Window":"String","Site":"String","Role":"String","Poster":"String","Expiry":"String","Why":"String","NeedsApproval":false,"Pending":false}],"Ineligible":[{"CoverageGapId":0,"Day":"String","Window":"String","Site":"String","Role":"String","Poster":"String","Expiry":"String","Why":"String","NeedsApproval":false,"Pending":false}],"MyPosted":{"CoverageGapId":0,"Kind":"String","Status":"String","ShiftDay":"String","ShiftWindow":"String","ShiftStartUtc":"0001-01-01T00:00:00.0000000","Site":"String","RoleNeeded":"String","ExpiryLabel":"String","PosterName":"String","EligibleCount":0,"IneligibleCount":0,"MyEligibility":{"Tone":"String","Text":"String","CanClaim":false,"ClaimLabel":"String"},"Matrix":[{"Name":"String","Note":"String","Tone":"String"}],"SwapState":"String","SwapFromName":"String","SwapTargetName":"String","OfferShift":"String","WantShift":"String","ConflictOk":false,"ConflictLabel":"String","CanRespond":false}}