Trendsic Platform Service

CoverageBoardRequest

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

**CoverageBoardRequest** Parameters:
Name	Parameter	Data Type	Required	Description
BranchId	query	Guid?	No

**CoverageBoardResponse** Parameters:
Name	Parameter	Data Type	Required
ResponseStatus	form	ResponseStatus	No
Shifts	form	List<CoverageBoardShift>	No
Approvals	form	List<CoverageBoardApproval>	No
History	form	List<CoverageBoardHistoryRow>	No
CanApprove	form	bool	No

**CoverageBoardShift** Parameters:
Name	Parameter	Data Type	Required
CoverageGapId	form	int	No
State	form	string	No
Day	form	string	No
Window	form	string	No
Site	form	string	No
Role	form	string	No
Poster	form	string	No
ExpiryLabel	form	string	No
ExpiresSoon	form	bool	No
EligibleCount	form	int	No
IneligibleCount	form	int	No
OfferedCount	form	int	No
ClaimsCount	form	int	No
ClaimantName	form	string	No
AudienceTier	form	string	No
Matrix	form	List<CoverageSelfMatrixRow>	No
NotYetOffered	form	int	No

**CoverageSelfMatrixRow** Parameters:
Name	Parameter	Data Type	Required
Name	form	string	No
Note	form	string	No
Tone	form	string	No

**CoverageBoardApproval** Parameters:
Name	Parameter	Data Type	Required
CoverageApprovalId	form	int	No
CoverageGapId	form	int	No
Claimant	form	string	No
Poster	form	string	No
Day	form	string	No
Window	form	string	No
Site	form	string	No
Role	form	string	No
OtText	form	string	No
OtNote	form	string	No
OtWarn	form	bool	No
MarginText	form	string	No
MarginNote	form	string	No
MarginTone	form	string	No
EligText	form	string	No
EligNote	form	string	No
EligWarn	form	bool	No
Channel	form	string	No

**CoverageBoardHistoryRow** Parameters:
Name	Parameter	Data Type	Required
Kind	form	string	No
Title	form	string	No
Detail	form	string	No
Outcome	form	string	No
WhenLabel	form	string	No

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
}