Trendsic Platform Service

<back to all web services

CoverageSelfCardRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/self/card/{CoverageGapId}
import Foundation
import ServiceStack

public class CoverageSelfCardRequest : Codable
{
    public var coverageGapId:Int

    required public init(){}
}

public class CoverageSelfCardResponse : Codable
{
    public var responseStatus:ResponseStatus
    public var card:CoverageSelfCard

    required public init(){}
}

public class CoverageSelfCard : Codable
{
    public var coverageGapId:Int
    public var kind:String
    public var status:String
    public var shiftDay:String
    public var shiftWindow:String
    public var shiftStartUtc:Date?
    public var site:String
    public var roleNeeded:String
    public var expiryLabel:String
    public var posterName:String
    public var eligibleCount:Int
    public var ineligibleCount:Int
    public var myEligibility:CoverageSelfEligibility
    public var matrix:[CoverageSelfMatrixRow] = []
    public var swapState:String
    public var swapFromName:String
    public var swapTargetName:String
    public var offerShift:String
    public var wantShift:String
    public var conflictOk:Bool
    public var conflictLabel:String
    public var canRespond:Bool

    required public init(){}
}

public class CoverageSelfEligibility : Codable
{
    public var tone:String
    public var text:String
    public var canClaim:Bool
    public var claimLabel:String

    required public init(){}
}

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

    required public init(){}
}


Swift CoverageSelfCardRequest 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/card/{CoverageGapId} 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
		}
	},
	Card: 
	{
		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
	}
}