Trendsic Platform Service

<back to all web services

CoveragePlannedRequest

Requires Authentication
The following routes are available for this service:
GET/v1/coverage/planned
CoveragePlannedResponse Parameters:
NameParameterData TypeRequiredDescription
ItemsformList<CoveragePlannedItem>No
ResponseStatusformResponseStatusNo
CoveragePlannedItem Parameters:
NameParameterData TypeRequiredDescription
WorkerTimeOffIDformintNo
ContactIdformintNo
WorkerNameformstringNo
InitialsformstringNo
DatesformstringNo
ReasonformstringNo
StageformstringNo
StageLabelformstringNo
NeedBookformboolNo
CoverageGapIdformint?No
ChecksformList<CoveragePtoCheck>No
DenyReasonformstringNo
CoveragePtoCheck Parameters:
NameParameterData TypeRequiredDescription
OkformboolNo
TextformstringNo

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/planned HTTP/1.1 
Host: api.dev.dynamics.trendsic.com 
Accept: text/jsv
HTTP/1.1 200 OK
Content-Type: text/jsv
Content-Length: length

{
	Items: 
	[
		{
			WorkerTimeOffID: 0,
			ContactId: 0,
			WorkerName: String,
			Initials: String,
			Dates: String,
			Reason: String,
			Stage: String,
			StageLabel: String,
			NeedBook: False,
			CoverageGapId: 0,
			Checks: 
			[
				{
					Ok: False,
					Text: String
				}
			],
			DenyReason: String
		}
	],
	ResponseStatus: 
	{
		ErrorCode: String,
		Message: String,
		StackTrace: String,
		Errors: 
		[
			{
				ErrorCode: String,
				FieldName: String,
				Message: String,
				Meta: 
				{
					String: String
				}
			}
		],
		Meta: 
		{
			String: String
		}
	}
}