Trendsic Platform Service

<back to all web services

CoverageSelfSwapRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/coverage/self/swap
CoverageSelfSwapRequest Parameters:
NameParameterData TypeRequiredDescription
AItemIdbodyintNo
BItemIdbodyintNo
TargetContactIDbodyintNo
BroadcastbodyboolNo
TeamChannelIdbodyintNo
CoverageSelfCardResponse Parameters:
NameParameterData TypeRequiredDescription
ResponseStatusformResponseStatusNo
CardformCoverageSelfCardNo
CoverageSelfCard Parameters:
NameParameterData TypeRequiredDescription
CoverageGapIdformintNo
KindformstringNo
StatusformstringNo
ShiftDayformstringNo
ShiftWindowformstringNo
ShiftStartUtcformDateTime?No
SiteformstringNo
RoleNeededformstringNo
ExpiryLabelformstringNo
PosterNameformstringNo
EligibleCountformintNo
IneligibleCountformintNo
MyEligibilityformCoverageSelfEligibilityNo
MatrixformList<CoverageSelfMatrixRow>No
SwapStateformstringNo
SwapFromNameformstringNo
SwapTargetNameformstringNo
OfferShiftformstringNo
WantShiftformstringNo
ConflictOkformboolNo
ConflictLabelformstringNo
CanRespondformboolNo
CoverageSelfEligibility Parameters:
NameParameterData TypeRequiredDescription
ToneformstringNo
TextformstringNo
CanClaimformboolNo
ClaimLabelformstringNo
CoverageSelfMatrixRow Parameters:
NameParameterData TypeRequiredDescription
NameformstringNo
NoteformstringNo
ToneformstringNo

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.

POST /v1/coverage/self/swap HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
Content-Type: text/jsv
Content-Length: length

{
	AItemId: 0,
	BItemId: 0,
	TargetContactID: 0,
	Broadcast: False,
	TeamChannelId: 0
}
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
	}
}