| 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 .xml suffix or ?format=xml
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/xml
HTTP/1.1 200 OK
Content-Type: application/xml
Content-Length: length
<CoverageBoardResponse xmlns:i="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://schemas.datacontract.org/2004/07/CRM.AgencyPlatform.API.Internal">
<Approvals>
<CoverageBoardApproval>
<Channel>String</Channel>
<Claimant>String</Claimant>
<CoverageApprovalId>0</CoverageApprovalId>
<CoverageGapId>0</CoverageGapId>
<Day>String</Day>
<EligNote>String</EligNote>
<EligText>String</EligText>
<EligWarn>false</EligWarn>
<MarginNote>String</MarginNote>
<MarginText>String</MarginText>
<MarginTone>String</MarginTone>
<OtNote>String</OtNote>
<OtText>String</OtText>
<OtWarn>false</OtWarn>
<Poster>String</Poster>
<Role>String</Role>
<Site>String</Site>
<Window>String</Window>
</CoverageBoardApproval>
</Approvals>
<CanApprove>false</CanApprove>
<History>
<CoverageBoardHistoryRow>
<Detail>String</Detail>
<Kind>String</Kind>
<Outcome>String</Outcome>
<Title>String</Title>
<WhenLabel>String</WhenLabel>
</CoverageBoardHistoryRow>
</History>
<ResponseStatus xmlns:d2p1="http://schemas.servicestack.net/types">
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:Message>String</d2p1:Message>
<d2p1:StackTrace>String</d2p1:StackTrace>
<d2p1:Errors>
<d2p1:ResponseError>
<d2p1:ErrorCode>String</d2p1:ErrorCode>
<d2p1:FieldName>String</d2p1:FieldName>
<d2p1:Message>String</d2p1:Message>
<d2p1:Meta xmlns:d5p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d5p1:KeyValueOfstringstring>
<d5p1:Key>String</d5p1:Key>
<d5p1:Value>String</d5p1:Value>
</d5p1:KeyValueOfstringstring>
</d2p1:Meta>
</d2p1:ResponseError>
</d2p1:Errors>
<d2p1:Meta xmlns:d3p1="http://schemas.microsoft.com/2003/10/Serialization/Arrays">
<d3p1:KeyValueOfstringstring>
<d3p1:Key>String</d3p1:Key>
<d3p1:Value>String</d3p1:Value>
</d3p1:KeyValueOfstringstring>
</d2p1:Meta>
</ResponseStatus>
<Shifts>
<CoverageBoardShift>
<AudienceTier>String</AudienceTier>
<ClaimantName>String</ClaimantName>
<ClaimsCount>0</ClaimsCount>
<CoverageGapId>0</CoverageGapId>
<Day>String</Day>
<EligibleCount>0</EligibleCount>
<ExpiresSoon>false</ExpiresSoon>
<ExpiryLabel>String</ExpiryLabel>
<IneligibleCount>0</IneligibleCount>
<Matrix>
<CoverageSelfMatrixRow>
<Name>String</Name>
<Note>String</Note>
<Tone>String</Tone>
</CoverageSelfMatrixRow>
</Matrix>
<NotYetOffered>0</NotYetOffered>
<OfferedCount>0</OfferedCount>
<Poster>String</Poster>
<Role>String</Role>
<Site>String</Site>
<State>String</State>
<Window>String</Window>
</CoverageBoardShift>
</Shifts>
</CoverageBoardResponse>