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 .jsv suffix or ?format=jsv

HTTP + JSV

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