Trendsic Platform Service

<back to all web services

CoverageSelfReleaseRequest

Requires Authentication
The following routes are available for this service:
POST,OPTIONS/v1/coverage/self/release
"use strict";
export class CoverageSelfEligibility {
    /** @param {{Tone?:string,Text?:string,CanClaim?:boolean,ClaimLabel?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Tone;
    /** @type {string} */
    Text;
    /** @type {boolean} */
    CanClaim;
    /** @type {string} */
    ClaimLabel;
}
export class CoverageSelfMatrixRow {
    /** @param {{Name?:string,Note?:string,Tone?:string}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {string} */
    Name;
    /** @type {string} */
    Note;
    /** @type {string} */
    Tone;
}
export class CoverageSelfCard {
    /** @param {{CoverageGapId?:number,Kind?:string,Status?:string,ShiftDay?:string,ShiftWindow?:string,ShiftStartUtc?:string,Site?:string,RoleNeeded?:string,ExpiryLabel?:string,PosterName?:string,EligibleCount?:number,IneligibleCount?:number,MyEligibility?:CoverageSelfEligibility,Matrix?:CoverageSelfMatrixRow[],SwapState?:string,SwapFromName?:string,SwapTargetName?:string,OfferShift?:string,WantShift?:string,ConflictOk?:boolean,ConflictLabel?:string,CanRespond?:boolean}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    CoverageGapId;
    /** @type {string} */
    Kind;
    /** @type {string} */
    Status;
    /** @type {string} */
    ShiftDay;
    /** @type {string} */
    ShiftWindow;
    /** @type {?string} */
    ShiftStartUtc;
    /** @type {string} */
    Site;
    /** @type {string} */
    RoleNeeded;
    /** @type {string} */
    ExpiryLabel;
    /** @type {string} */
    PosterName;
    /** @type {number} */
    EligibleCount;
    /** @type {number} */
    IneligibleCount;
    /** @type {CoverageSelfEligibility} */
    MyEligibility;
    /** @type {CoverageSelfMatrixRow[]} */
    Matrix = [];
    /** @type {string} */
    SwapState;
    /** @type {string} */
    SwapFromName;
    /** @type {string} */
    SwapTargetName;
    /** @type {string} */
    OfferShift;
    /** @type {string} */
    WantShift;
    /** @type {boolean} */
    ConflictOk;
    /** @type {string} */
    ConflictLabel;
    /** @type {boolean} */
    CanRespond;
}
export class CoverageSelfCardResponse {
    /** @param {{ResponseStatus?:ResponseStatus,Card?:CoverageSelfCard}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {ResponseStatus} */
    ResponseStatus;
    /** @type {CoverageSelfCard} */
    Card;
}
export class CoverageSelfReleaseRequest {
    /** @param {{WorkerScheduleItemID?:number,Note?:string,Audience?:string,Expiry?:string,TeamChannelId?:number}} [init] */
    constructor(init) { Object.assign(this, init) }
    /** @type {number} */
    WorkerScheduleItemID;
    /** @type {string} */
    Note;
    /** @type {string} */
    Audience;
    /** @type {string} */
    Expiry;
    /** @type {number} */
    TeamChannelId;
}

JavaScript CoverageSelfReleaseRequest 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.

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

{
	WorkerScheduleItemID: 0,
	Note: String,
	Audience: String,
	Expiry: String,
	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
	}
}