Trendsic Platform Service

<back to all web services

CoverageBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/board
namespace CRM.AgencyPlatform.API.Internal

open System
open System.IO
open System.Collections
open System.Collections.Generic
open System.Runtime.Serialization
open ServiceStack
open ServiceStack.DataAnnotations

    [<AllowNullLiteral>]
    type CoverageSelfMatrixRow() = 
        member val Name:String = null with get,set
        member val Note:String = null with get,set
        member val Tone:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageBoardShift() = 
        member val CoverageGapId:Int32 = new Int32() with get,set
        member val State:String = null with get,set
        member val Day:String = null with get,set
        member val Window:String = null with get,set
        member val Site:String = null with get,set
        member val Role:String = null with get,set
        member val Poster:String = null with get,set
        member val ExpiryLabel:String = null with get,set
        member val ExpiresSoon:Boolean = new Boolean() with get,set
        member val EligibleCount:Int32 = new Int32() with get,set
        member val IneligibleCount:Int32 = new Int32() with get,set
        member val OfferedCount:Int32 = new Int32() with get,set
        member val ClaimsCount:Int32 = new Int32() with get,set
        member val ClaimantName:String = null with get,set
        member val AudienceTier:String = null with get,set
        member val Matrix:ResizeArray<CoverageSelfMatrixRow> = new ResizeArray<CoverageSelfMatrixRow>() with get,set
        member val NotYetOffered:Int32 = new Int32() with get,set

    [<AllowNullLiteral>]
    type CoverageBoardApproval() = 
        member val CoverageApprovalId:Int32 = new Int32() with get,set
        member val CoverageGapId:Int32 = new Int32() with get,set
        member val Claimant:String = null with get,set
        member val Poster:String = null with get,set
        member val Day:String = null with get,set
        member val Window:String = null with get,set
        member val Site:String = null with get,set
        member val Role:String = null with get,set
        member val OtText:String = null with get,set
        member val OtNote:String = null with get,set
        member val OtWarn:Boolean = new Boolean() with get,set
        member val MarginText:String = null with get,set
        member val MarginNote:String = null with get,set
        member val MarginTone:String = null with get,set
        member val EligText:String = null with get,set
        member val EligNote:String = null with get,set
        member val EligWarn:Boolean = new Boolean() with get,set
        member val Channel:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageBoardHistoryRow() = 
        member val Kind:String = null with get,set
        member val Title:String = null with get,set
        member val Detail:String = null with get,set
        member val Outcome:String = null with get,set
        member val WhenLabel:String = null with get,set

    [<AllowNullLiteral>]
    type CoverageBoardResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Shifts:ResizeArray<CoverageBoardShift> = new ResizeArray<CoverageBoardShift>() with get,set
        member val Approvals:ResizeArray<CoverageBoardApproval> = new ResizeArray<CoverageBoardApproval>() with get,set
        member val History:ResizeArray<CoverageBoardHistoryRow> = new ResizeArray<CoverageBoardHistoryRow>() with get,set
        member val CanApprove:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CoverageBoardRequest() = 
        member val BranchId:Nullable<Guid> = new Nullable<Guid>() with get,set

F# CoverageBoardRequest DTOs

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

To embed the response in a jsonp callback, append ?callback=myCallback

HTTP + JSON

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

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