Trendsic Platform Service

CoverageBoardRequest

The following routes are available for this service:
GET,OPTIONS	/v1/coverage/board

import Foundation
import ServiceStack

public class CoverageBoardRequest : Codable
{
    public var branchId:String?

    required public init(){}
}

public class CoverageBoardResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var shifts:[CoverageBoardShift] = []
    public var approvals:[CoverageBoardApproval] = []
    public var history:[CoverageBoardHistoryRow] = []
    public var canApprove:Bool

    required public init(){}
}

public class CoverageBoardShift : Codable
{
    public var coverageGapId:Int
    public var state:String
    public var day:String
    public var window:String
    public var site:String
    public var role:String
    public var poster:String
    public var expiryLabel:String
    public var expiresSoon:Bool
    public var eligibleCount:Int
    public var ineligibleCount:Int
    public var offeredCount:Int
    public var claimsCount:Int
    public var claimantName:String
    public var audienceTier:String
    public var matrix:[CoverageSelfMatrixRow] = []
    public var notYetOffered:Int

    required public init(){}
}

public class CoverageSelfMatrixRow : Codable
{
    public var name:String
    public var note:String
    public var tone:String

    required public init(){}
}

public class CoverageBoardApproval : Codable
{
    public var coverageApprovalId:Int
    public var coverageGapId:Int
    public var claimant:String
    public var poster:String
    public var day:String
    public var window:String
    public var site:String
    public var role:String
    public var otText:String
    public var otNote:String
    public var otWarn:Bool
    public var marginText:String
    public var marginNote:String
    public var marginTone:String
    public var eligText:String
    public var eligNote:String
    public var eligWarn:Bool
    public var channel:String

    required public init(){}
}

public class CoverageBoardHistoryRow : Codable
{
    public var kind:String
    public var title:String
    public var detail:String
    public var outcome:String
    public var whenLabel:String

    required public init(){}
}

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