Trendsic Platform Service

<back to all web services

CoverageSelfBoardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/self/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 CoverageSelfBoardShift() = 
        member val CoverageGapId:Int32 = new Int32() 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 Expiry:String = null with get,set
        member val Why:String = null with get,set
        member val NeedsApproval:Boolean = new Boolean() with get,set
        member val Pending:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CoverageSelfEligibility() = 
        member val Tone:String = null with get,set
        member val Text:String = null with get,set
        member val CanClaim:Boolean = new Boolean() with get,set
        member val ClaimLabel:String = null with get,set

    [<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 CoverageSelfCard() = 
        member val CoverageGapId:Int32 = new Int32() with get,set
        member val Kind:String = null with get,set
        member val Status:String = null with get,set
        member val ShiftDay:String = null with get,set
        member val ShiftWindow:String = null with get,set
        member val ShiftStartUtc:Nullable<DateTime> = new Nullable<DateTime>() with get,set
        member val Site:String = null with get,set
        member val RoleNeeded:String = null with get,set
        member val ExpiryLabel:String = null with get,set
        member val PosterName:String = null with get,set
        member val EligibleCount:Int32 = new Int32() with get,set
        member val IneligibleCount:Int32 = new Int32() with get,set
        member val MyEligibility:CoverageSelfEligibility = null with get,set
        member val Matrix:ResizeArray<CoverageSelfMatrixRow> = new ResizeArray<CoverageSelfMatrixRow>() with get,set
        member val SwapState:String = null with get,set
        member val SwapFromName:String = null with get,set
        member val SwapTargetName:String = null with get,set
        member val OfferShift:String = null with get,set
        member val WantShift:String = null with get,set
        member val ConflictOk:Boolean = new Boolean() with get,set
        member val ConflictLabel:String = null with get,set
        member val CanRespond:Boolean = new Boolean() with get,set

    [<AllowNullLiteral>]
    type CoverageSelfBoardResponse() = 
        member val ResponseStatus:ResponseStatus = null with get,set
        member val Eligible:ResizeArray<CoverageSelfBoardShift> = new ResizeArray<CoverageSelfBoardShift>() with get,set
        member val Ineligible:ResizeArray<CoverageSelfBoardShift> = new ResizeArray<CoverageSelfBoardShift>() with get,set
        member val MyPosted:CoverageSelfCard = null with get,set

    [<AllowNullLiteral>]
    type CoverageSelfBoardRequest() = 
        class end

F# CoverageSelfBoardRequest 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/self/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
		}
	},
	Eligible: 
	[
		{
			CoverageGapId: 0,
			Day: String,
			Window: String,
			Site: String,
			Role: String,
			Poster: String,
			Expiry: String,
			Why: String,
			NeedsApproval: False,
			Pending: False
		}
	],
	Ineligible: 
	[
		{
			CoverageGapId: 0,
			Day: String,
			Window: String,
			Site: String,
			Role: String,
			Poster: String,
			Expiry: String,
			Why: String,
			NeedsApproval: False,
			Pending: False
		}
	],
	MyPosted: 
	{
		CoverageGapId: 0,
		Kind: String,
		Status: String,
		ShiftDay: String,
		ShiftWindow: String,
		ShiftStartUtc: 0001-01-01,
		Site: String,
		RoleNeeded: String,
		ExpiryLabel: String,
		PosterName: String,
		EligibleCount: 0,
		IneligibleCount: 0,
		MyEligibility: 
		{
			Tone: String,
			Text: String,
			CanClaim: False,
			ClaimLabel: String
		},
		Matrix: 
		[
			{
				Name: String,
				Note: String,
				Tone: String
			}
		],
		SwapState: String,
		SwapFromName: String,
		SwapTargetName: String,
		OfferShift: String,
		WantShift: String,
		ConflictOk: False,
		ConflictLabel: String,
		CanRespond: False
	}
}