Trendsic Platform Service

<back to all web services

CoverageSelfAvailGetRequest

Requires Authentication
The following routes are available for this service:
GET,OPTIONS/v1/coverage/self/availability
import java.math.*
import java.util.*
import java.io.InputStream
import net.servicestack.client.*


open class CoverageSelfAvailGetRequest
{
}

open class CoverageSelfAvailResponse
{
    open var ResponseStatus:ResponseStatus? = null
    open var Days:ArrayList<CoverageSelfAvailDay> = ArrayList<CoverageSelfAvailDay>()
    open var Prefs:WorkerSchedulingPrefs? = null
    open var RulesSummary:String? = null
    open var TimeOffNoticeDays:Int? = null
}

open class CoverageSelfAvailDay
{
    open var Day:String? = null
    open var Open:Boolean? = null
    open var Windows:ArrayList<CoverageSelfAvailWindow> = ArrayList<CoverageSelfAvailWindow>()
}

open class CoverageSelfAvailWindow
{
    open var Start:String? = null
    open var End:String? = null
    open var Preferred:Boolean? = null
}

open class WorkerSchedulingPrefs
{
    open var ContactID:Int? = null
    open var PreferredWeeklyHours:Int? = null
    open var PreferredMonthlyHours:Int? = null
    open var MinShiftMinutes:Int? = null
    open var MaxConsecutiveDays:Int? = null
}

Kotlin CoverageSelfAvailGetRequest 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/availability 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
		}
	},
	Days: 
	[
		{
			Day: String,
			Open: False,
			Windows: 
			[
				{
					Start: String,
					End: String,
					Preferred: False
				}
			]
		}
	],
	Prefs: 
	{
		ContactID: 0,
		PreferredWeeklyHours: 0,
		PreferredMonthlyHours: 0,
		MinShiftMinutes: 0,
		MaxConsecutiveDays: 0
	},
	RulesSummary: String,
	TimeOffNoticeDays: 0
}