Trendsic Platform Service

<back to all web services

CoverageBoardRequest

Imports System
Imports System.IO
Imports System.Collections
Imports System.Collections.Generic
Imports System.Runtime.Serialization
Imports ServiceStack
Imports ServiceStack.DataAnnotations
Imports CRM.AgencyPlatform.API.Internal

Namespace Global

    Namespace CRM.AgencyPlatform.API.Internal

        Public Partial Class CoverageBoardApproval
            Public Overridable Property CoverageApprovalId As Integer
            Public Overridable Property CoverageGapId As Integer
            Public Overridable Property Claimant As String
            Public Overridable Property Poster As String
            Public Overridable Property Day As String
            Public Overridable Property Window As String
            Public Overridable Property Site As String
            Public Overridable Property Role As String
            Public Overridable Property OtText As String
            Public Overridable Property OtNote As String
            Public Overridable Property OtWarn As Boolean
            Public Overridable Property MarginText As String
            Public Overridable Property MarginNote As String
            Public Overridable Property MarginTone As String
            Public Overridable Property EligText As String
            Public Overridable Property EligNote As String
            Public Overridable Property EligWarn As Boolean
            Public Overridable Property Channel As String
        End Class

        Public Partial Class CoverageBoardHistoryRow
            Public Overridable Property Kind As String
            Public Overridable Property Title As String
            Public Overridable Property Detail As String
            Public Overridable Property Outcome As String
            Public Overridable Property WhenLabel As String
        End Class

        Public Partial Class CoverageBoardRequest
            Public Overridable Property BranchId As Guid?
        End Class

        Public Partial Class CoverageBoardResponse
            Public Overridable Property ResponseStatus As ResponseStatus
            Public Overridable Property Shifts As List(Of CoverageBoardShift) = New List(Of CoverageBoardShift)
            Public Overridable Property Approvals As List(Of CoverageBoardApproval) = New List(Of CoverageBoardApproval)
            Public Overridable Property History As List(Of CoverageBoardHistoryRow) = New List(Of CoverageBoardHistoryRow)
            Public Overridable Property CanApprove As Boolean
        End Class

        Public Partial Class CoverageBoardShift
            Public Overridable Property CoverageGapId As Integer
            Public Overridable Property State As String
            Public Overridable Property Day As String
            Public Overridable Property Window As String
            Public Overridable Property Site As String
            Public Overridable Property Role As String
            Public Overridable Property Poster As String
            Public Overridable Property ExpiryLabel As String
            Public Overridable Property ExpiresSoon As Boolean
            Public Overridable Property EligibleCount As Integer
            Public Overridable Property IneligibleCount As Integer
            Public Overridable Property OfferedCount As Integer
            Public Overridable Property ClaimsCount As Integer
            Public Overridable Property ClaimantName As String
            Public Overridable Property AudienceTier As String
            Public Overridable Property Matrix As List(Of CoverageSelfMatrixRow) = New List(Of CoverageSelfMatrixRow)
            Public Overridable Property NotYetOffered As Integer
        End Class

        Public Partial Class CoverageSelfMatrixRow
            Public Overridable Property Name As String
            Public Overridable Property Note As String
            Public Overridable Property Tone As String
        End Class
    End Namespace
End Namespace

VB.NET CoverageBoardRequest DTOs

GET /v1/coverage/board HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv

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