| GET,OPTIONS | /v1/coverage/board |
|---|
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
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>