Trendsic Platform Service

<back to all web services

CoverageBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/board
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CoverageBoardRequest
{
    open var BranchId:UUID? = null
}

open class CoverageBoardResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Shifts:ArrayList<CoverageBoardShift> = ArrayList<CoverageBoardShift>()
    open var Approvals:ArrayList<CoverageBoardApproval> = ArrayList<CoverageBoardApproval>()
    open var History:ArrayList<CoverageBoardHistoryRow> = ArrayList<CoverageBoardHistoryRow>()
    open var CanApprove:Boolean? = null
}

open class CoverageBoardShift
{
    open var CoverageGapId:Int? = null
    open var State:String? = null
    open var Day:String? = null
    open var Window:String? = null
    open var Site:String? = null
    open var Role:String? = null
    open var Poster:String? = null
    open var ExpiryLabel:String? = null
    open var ExpiresSoon:Boolean? = null
    open var EligibleCount:Int? = null
    open var IneligibleCount:Int? = null
    open var OfferedCount:Int? = null
    open var ClaimsCount:Int? = null
    open var ClaimantName:String? = null
    open var AudienceTier:String? = null
    open var Matrix:ArrayList<CoverageSelfMatrixRow> = ArrayList<CoverageSelfMatrixRow>()
    open var NotYetOffered:Int? = null
}

open class CoverageSelfMatrixRow
{
    open var Name:String? = null
    open var Note:String? = null
    open var Tone:String? = null
}

open class CoverageBoardApproval
{
    open var CoverageApprovalId:Int? = null
    open var CoverageGapId:Int? = null
    open var Claimant:String? = null
    open var Poster:String? = null
    open var Day:String? = null
    open var Window:String? = null
    open var Site:String? = null
    open var Role:String? = null
    open var OtText:String? = null
    open var OtNote:String? = null
    open var OtWarn:Boolean? = null
    open var MarginText:String? = null
    open var MarginNote:String? = null
    open var MarginTone:String? = null
    open var EligText:String? = null
    open var EligNote:String? = null
    open var EligWarn:Boolean? = null
    open var Channel:String? = null
}

open class CoverageBoardHistoryRow
{
    open var Kind:String? = null
    open var Title:String? = null
    open var Detail:String? = null
    open var Outcome:String? = null
    open var WhenLabel:String? = null
}

Kotlin CoverageBoardRequest DTOs

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

HTTP + 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>