REST Objects TimeConstraint

5.0.0

The TimeConstraint object object can be part of:

The Appointment Book object, in the following location:
- Appointment Book > TimeConstraint
In this situation, a TimeConstraint object represents a period of time when it is permitted to carry out the work of a Work Item when performing an appointment booking.

or:

The Work Item object, in the following locations:
- Work Item > TimeConstraint
In this situation, a TimeConstraint object represents a period of time when it is permitted to carry out the associated booked Work Item.

On this page:

Related pages:

TimeConstraint Object Format

JSON Format

{
	"Desc": "",
	"Period": {
		"Start": "",
		"End": ""
	},
	"Range": {
		"Days": "0000000",
		"RangeStartDt": "",
		"RangeEndDt": "",
		"DayStartTm": "",
		"DayEndTm": "",
		"TZ": ""
	},
	"Type": 1001
}

TimeConstraint Object Properties

Property		Type	Required?	Description	Field Mappings
Property		Type	Required?	Description	ServiceDispatch	ServiceMobility	ServiceScheduling
`Desc`		`string`	No	A description of the time constraint.		`/TimeConstraints/Desc`
`Period`		`object`	No	When present, the TimeConstraint object represents a single, exact period in time. A TimeConstraint has either a Period or a Range, but not both.
	`Start`	`string`	No	The start of the exact period in time, in UTC.		`/TimeConstraints/Period/Start`	`earliest`
	`End`	`string`	No	The end of the exact period in time, in UTC.		`/TimeConstraints/Period/End`	`latest`
`Range`		`object`	No	When present, the TimeConstraint object is represents a period of time that repeats on certain days of the week, between two dates. A TimeConstraint has either a Period or a Range, but not both.
	`Days`	`string`	No	Which days of the week the repeating pattern applies to. A string of seven `0` or `1` values to represent each day of the week, off or on. First element is for Sunday. e.g. "`0111110`" represents Mon-Fri.
	`RangeStartDt`	`string`	No	The first date on which the repeating pattern applies to. If this is not supplied, the repeat is assumed to apply for all dates up to and including `RangeEndDt`. If neither `RangeStartDt` nor `RangeEndDt` is supplied, the pattern applies to all dates. This is an ISO-8601 date in the format `YYYY-MM-DD`.
	`RangeEndDt`	`string`	No	The last date on which the repeating pattern applies to. If this is not supplied, the repeat is assumed to apply for all dates after and including `RangeStartDt`. If neither `RangeStartDt` nor `RangeEndDt` is supplied, the pattern applies to all dates. This is an ISO-8601 date in the format `YYYY-MM-DD`.
	`DayStartTm`	`string`	No	The local time for the start of the constraint on each active day in the range (as defined by `Days`). This is an ISO-8601 time in the format `HH:mm`.
	`DayEndTm`	`string`	No	The local time for the end of the constraint on each active day in the range (as defined by `Days`). This is an ISO-8601 time in the format `HH:mm`.
	`TZ`	`string`	No	The timezone to be used in order to calculate the time indicated by the period e.g. "Europe/London", "America/New_York". String is an IANA timezone string (see https://en.wikipedia.org/wiki/List_of_tz_database_time_zones)
`Type`		`integer`	No	The type of constraint: `10`: Appointment `20`: Contract `30`: Shift		`/TimeConstraints/Type`