Trendsic Platform Service

<back to all web services

CoverageBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/board
CoverageBoardRequest Parameters:
NameParameterData TypeRequiredDescription
BranchIdqueryGuid?No
CoverageBoardResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
ShiftsformList<CoverageBoardShift>No
ApprovalsformList<CoverageBoardApproval>No
HistoryformList<CoverageBoardHistoryRow>No
CanApproveformboolNo
CoverageBoardShift Parameters:
NameParameterData TypeRequiredDescription
CoverageGapIdformintNo
StateformstringNo
DayformstringNo
WindowformstringNo
SiteformstringNo
RoleformstringNo
PosterformstringNo
ExpiryLabelformstringNo
ExpiresSoonformboolNo
EligibleCountformintNo
IneligibleCountformintNo
OfferedCountformintNo
ClaimsCountformintNo
ClaimantNameformstringNo
AudienceTierformstringNo
MatrixformList<CoverageSelfMatrixRow>No
NotYetOfferedformintNo
CoverageSelfMatrixRow Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
NoteformstringNo
ToneformstringNo
CoverageBoardApproval Parameters:
NameParameterData TypeRequiredDescription
CoverageApprovalIdformintNo
CoverageGapIdformintNo
ClaimantformstringNo
PosterformstringNo
DayformstringNo
WindowformstringNo
SiteformstringNo
RoleformstringNo
OtTextformstringNo
OtNoteformstringNo
OtWarnformboolNo
MarginTextformstringNo
MarginNoteformstringNo
MarginToneformstringNo
EligTextformstringNo
EligNoteformstringNo
EligWarnformboolNo
ChannelformstringNo
CoverageBoardHistoryRow Parameters:
NameParameterData TypeRequiredDescription
KindformstringNo
TitleformstringNo
DetailformstringNo
OutcomeformstringNo
WhenLabelformstringNo

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

HTTP + OTHER

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/jsonl

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