Skip to content

Resolves an inclusive local-date range with partial diagnostics.

POST
/api/workspace/work-schedule/effective-schedule/query
curl --request POST \
--url https://example.com/api/workspace/work-schedule/effective-schedule/query \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data '{ "StartLocalDate": "2026-04-15", "EndLocalDate": "2026-04-15", "WorkerIds": [ "example" ], "SiteIds": [ "example" ], "SelectedLocalTime": "example" }'
access_token
string

Optional access token for clients that cannot set Authorization headers. Prefer Authorization: Bearer <token> when possible.

Queries an inclusive local-date range for authorized Workers and Sites.

object
StartLocalDate
string format: date
EndLocalDate
string format: date
WorkerIds
Array<string>
nullable
SiteIds
Array<string>
nullable
SelectedLocalTime
string format: time
nullable
Examplegenerated
{
"StartLocalDate": "2026-04-15",
"EndLocalDate": "2026-04-15",
"WorkerIds": [
"example"
],
"SiteIds": [
"example"
],
"SelectedLocalTime": "example"
}

OK

Media typeapplication/json
object
Data

Partial-success effective schedule projection whose applied evidence contains only subject impacts with Applied status.

object
StartLocalDate
string format: date
EndLocalDate
string format: date
SiteDays
Array<object>
nullable

Site hours for one local day.

object
SiteId
string
nullable
LocalDate
string format: date
OperationalLocationId
string
nullable
IanaTimeZoneId
string
nullable
Intervals
Array<object>
nullable

One complete logical working interval. Applied exceptions have authoritative Applied status, and collision identifiers refer only to collisions returned in the same projection.

object
IntervalId
string
nullable
WorkerId
string
nullable
SiteId
string
nullable
CalendarId
string
nullable
CalendarName
string
nullable
CalendarRevisionId
string
nullable
CalendarRevisionNumber
integer format: int32
nullable
IanaTimeZoneId
string
nullable
LocalStart
string format: date-time
LocalEnd
string format: date-time
UtcStart
string format: date-time
UtcEnd
string format: date-time
GrossDurationMicroseconds
integer format: int64
NetDurationMicroseconds
integer format: int64
Breaks
Array<object>
nullable

One resolved break in a logical interval.

object
Name
string
nullable
LocalStart
string format: date-time
LocalEnd
string format: date-time
UtcStart
string format: date-time
UtcEnd
string format: date-time
DurationMicroseconds
integer format: int64
Label
string
nullable
DstAdjusted
boolean
SourceBoundary

Authored source boundaries retained after precedence slicing.

object
SourceKind
string
nullable
LocalStart
string format: date-time
LocalEnd
string format: date-time
UtcStart
string format: date-time
UtcEnd
string format: date-time
SourceId
string
nullable
AppliedExceptions
Array<object>
nullable

One active exception that affected a final interval or removed time.

object
ExceptionId
string
nullable
ChainRootId
string
nullable
Kind
string
nullable
ScopeType
string
nullable
ScopeId
string
nullable
WorkerId
string
nullable
SiteId
string
nullable
ReasonCode
string
nullable
ReasonText
string
nullable
AuthorityTier
string
nullable
LocalStart
string format: date-time
LocalEnd
string format: date-time
UtcStart
string format: date-time
UtcEnd
string format: date-time
CollisionIds
Array<string>
nullable
WorkerIntervals
Array<object>
nullable

One complete logical working interval. Applied exceptions have authoritative Applied status, and collision identifiers refer only to collisions returned in the same projection.

object
IntervalId
string
nullable
WorkerId
string
nullable
SiteId
string
nullable
CalendarId
string
nullable
CalendarName
string
nullable
CalendarRevisionId
string
nullable
CalendarRevisionNumber
integer format: int32
nullable
IanaTimeZoneId
string
nullable
LocalStart
string format: date-time
LocalEnd
string format: date-time
UtcStart
string format: date-time
UtcEnd
string format: date-time
GrossDurationMicroseconds
integer format: int64
NetDurationMicroseconds
integer format: int64
Breaks
Array<object>
nullable

One resolved break in a logical interval.

object
Name
string
nullable
LocalStart
string format: date-time
LocalEnd
string format: date-time
UtcStart
string format: date-time
UtcEnd
string format: date-time
DurationMicroseconds
integer format: int64
Label
string
nullable
DstAdjusted
boolean
SourceBoundary

Authored source boundaries retained after precedence slicing.

object
SourceKind
string
nullable
LocalStart
string format: date-time
LocalEnd
string format: date-time
UtcStart
string format: date-time
UtcEnd
string format: date-time
SourceId
string
nullable
AppliedExceptions
Array<object>
nullable

One active exception that affected a final interval or removed time.

object
ExceptionId
string
nullable
ChainRootId
string
nullable
Kind
string
nullable
ScopeType
string
nullable
ScopeId
string
nullable
WorkerId
string
nullable
SiteId
string
nullable
ReasonCode
string
nullable
ReasonText
string
nullable
AuthorityTier
string
nullable
LocalStart
string format: date-time
LocalEnd
string format: date-time
UtcStart
string format: date-time
UtcEnd
string format: date-time
CollisionIds
Array<string>
nullable
WorkerDayContexts
Array<object>
nullable

Governed civil-time context for one authorized Worker and local date.

object
WorkerId
string
nullable
LocalDate
string format: date
SiteContexts
Array<object>
nullable

One governed Site and named Calendar context that applies to part of a Worker’s local day.

object
SiteId

Authorized visible Site identifier.

string
nullable
OperationalLocationId

Operational Location identifier that supplies civil-time context, when available.

string
nullable
IanaTimeZoneId

IANA time-zone identifier for the context.

string
nullable
AssignmentSourceKind

Exact relation kind that selected the Site.

string
nullable
AssignmentSourceId

Identifier of the exact relation that selected the Site.

string
nullable
WorkingCalendarId

Field-safe Calendar evidence selected for the visible context, when assigned; it does not grant Calendar aggregate access.

string
nullable
WorkingCalendarName

Field-safe Calendar display evidence returned under effective-schedule read after Site visibility filtering; it does not grant Calendar aggregate access.

string
nullable
CalendarSourceKind

Exact relation kind that selected WorkingCalendarId.

string
nullable
CalendarSourceId

Identifier of the exact relation that selected WorkingCalendarId.

string
nullable
ActiveUtcStart

Unambiguous inclusive UTC start of this context.

string format: date-time
ActiveUtcEnd

Unambiguous exclusive UTC end of this context.

string format: date-time
SelectedMoment

Authoritative selected-moment status after field-safe Site projection.

object
SelectedLocalDateTime
string format: date-time
Status
string
nullable
SiteContexts
Array<object>
nullable

One field-safe governing Site candidate for the requested Worker wall-clock moment.

object
SiteId
string
nullable
IanaTimeZoneId
string
nullable
ActiveLocalStart
string format: date-time
ActiveLocalEnd
string format: date-time
ActiveUtcStart
string format: date-time
ActiveUtcEnd
string format: date-time
ResolvedLocalDateTime
string format: date-time
ResolvedUtc
string format: date-time
DstAdjusted
boolean
DstAmbiguous
boolean
Diagnostics
Array<string>
nullable
SiteReferences
Array<object>
nullable

A field-safe Site reference reached through an authorized Worker projection.

object
Id
string
nullable
DisplayName
string
nullable
Number
string
nullable
AppliedExceptions
Array<object>
nullable

One active exception that affected a final interval or removed time.

object
ExceptionId
string
nullable
ChainRootId
string
nullable
Kind
string
nullable
ScopeType
string
nullable
ScopeId
string
nullable
WorkerId
string
nullable
SiteId
string
nullable
ReasonCode
string
nullable
ReasonText
string
nullable
AuthorityTier
string
nullable
LocalStart
string format: date-time
LocalEnd
string format: date-time
UtcStart
string format: date-time
UtcEnd
string format: date-time
ExceptionImpacts
Array<object>
nullable

Authoritative source and final intervals and Calendar contexts for one exception in this projection.

object
ExceptionId

Identifier of the exception whose effect is explained.

string
nullable
ChainRootId

Identifier of the append-only exception chain.

string
nullable
WorkerId

Affected Worker identifier, when the exception has Worker scope.

string
nullable
SiteId

Affected Site identifier, when the exception has Site context.

string
nullable
Status

Whether the exception changed effective Site, time, zone, Calendar, or Calendar revision facts.

string
nullable
BeforeIntervals

Effective intervals before applying this exception.

Array<object>
nullable

One authoritative source or final interval, including its Calendar revision and selection source.

object
IntervalId

Stable effective interval identifier.

string
nullable
WorkerId

Worker identifier for Worker projections, or null for Site-only projections.

string
nullable
SiteId

Authorized visible Site identifier that owns the interval.

string
nullable
IanaTimeZoneId

IANA time-zone identifier used for local boundaries.

string
nullable
LocalStart

Unspecified-kind local start.

string format: date-time
LocalEnd

Unspecified-kind local end.

string format: date-time
UtcStart

Unambiguous inclusive UTC start.

string format: date-time
UtcEnd

Unambiguous exclusive UTC end.

string format: date-time
CalendarId

Field-safe Calendar evidence that produced the visible interval, when calendar-backed; it does not grant Calendar aggregate access.

string
nullable
CalendarName

Field-safe Calendar display evidence returned under effective-schedule read after Site visibility filtering; it does not grant Calendar aggregate access.

string
nullable
CalendarRevisionId

Published Calendar revision identifier that produced the interval, when available.

string
nullable
CalendarRevisionNumber

Published Calendar revision number that produced the interval, when available.

integer format: int32
nullable
CalendarSourceKind

Exact assignment or exception relation kind that selected CalendarId.

string
nullable
CalendarSourceId

Identifier of the exact assignment or exception relation that selected CalendarId.

string
nullable
AfterIntervals

Effective intervals after applying this exception.

Array<object>
nullable

One authoritative source or final interval, including its Calendar revision and selection source.

object
IntervalId

Stable effective interval identifier.

string
nullable
WorkerId

Worker identifier for Worker projections, or null for Site-only projections.

string
nullable
SiteId

Authorized visible Site identifier that owns the interval.

string
nullable
IanaTimeZoneId

IANA time-zone identifier used for local boundaries.

string
nullable
LocalStart

Unspecified-kind local start.

string format: date-time
LocalEnd

Unspecified-kind local end.

string format: date-time
UtcStart

Unambiguous inclusive UTC start.

string format: date-time
UtcEnd

Unambiguous exclusive UTC end.

string format: date-time
CalendarId

Field-safe Calendar evidence that produced the visible interval, when calendar-backed; it does not grant Calendar aggregate access.

string
nullable
CalendarName

Field-safe Calendar display evidence returned under effective-schedule read after Site visibility filtering; it does not grant Calendar aggregate access.

string
nullable
CalendarRevisionId

Published Calendar revision identifier that produced the interval, when available.

string
nullable
CalendarRevisionNumber

Published Calendar revision number that produced the interval, when available.

integer format: int32
nullable
CalendarSourceKind

Exact assignment or exception relation kind that selected CalendarId.

string
nullable
CalendarSourceId

Identifier of the exact assignment or exception relation that selected CalendarId.

string
nullable
BeforeCalendars

Dated Calendar contexts before the exception, retained even when no source interval exists.

Array<object>
nullable

One dated, zone-specific Calendar and relation source that governed a visible subject before or after an exception.

object
WorkerId

Worker identifier for worker context, or null for Site context.

string
nullable
SiteId

Authorized visible Site identifier governed by this context.

string
nullable
LocalDate

Local date interpreted in IanaTimeZoneId.

string format: date
IanaTimeZoneId

IANA time-zone identifier that makes LocalDate unambiguous.

string
nullable
WorkingCalendarId

Field-safe Calendar evidence selected for this visible context, or null when none is assigned; it does not grant Calendar aggregate access.

string
nullable
WorkingCalendarName

Field-safe Calendar display evidence returned under effective-schedule read after Site visibility filtering; it does not grant Calendar aggregate access.

string
nullable
CalendarSourceKind

Exact assignment or exception relation kind that selected WorkingCalendarId.

string
nullable
CalendarSourceId

Identifier of the exact assignment or exception relation that selected WorkingCalendarId.

string
nullable
ActiveUtcStart

Unambiguous inclusive UTC start of this context.

string format: date-time
ActiveUtcEnd

Unambiguous exclusive UTC end of this context.

string format: date-time
AfterCalendars

Dated Calendar contexts after the exception, retained even when the final schedule has no interval.

Array<object>
nullable

One dated, zone-specific Calendar and relation source that governed a visible subject before or after an exception.

object
WorkerId

Worker identifier for worker context, or null for Site context.

string
nullable
SiteId

Authorized visible Site identifier governed by this context.

string
nullable
LocalDate

Local date interpreted in IanaTimeZoneId.

string format: date
IanaTimeZoneId

IANA time-zone identifier that makes LocalDate unambiguous.

string
nullable
WorkingCalendarId

Field-safe Calendar evidence selected for this visible context, or null when none is assigned; it does not grant Calendar aggregate access.

string
nullable
WorkingCalendarName

Field-safe Calendar display evidence returned under effective-schedule read after Site visibility filtering; it does not grant Calendar aggregate access.

string
nullable
CalendarSourceKind

Exact assignment or exception relation kind that selected WorkingCalendarId.

string
nullable
CalendarSourceId

Identifier of the exact assignment or exception relation that selected WorkingCalendarId.

string
nullable
ActiveUtcStart

Unambiguous inclusive UTC start of this context.

string format: date-time
ActiveUtcEnd

Unambiguous exclusive UTC end of this context.

string format: date-time
WinnerExceptionIds

Entity-Security-visible exception identifiers that won relevant overlap collisions. This can be empty for Overridden when every winner is hidden.

Array<string>
nullable
Collisions
Array<object>
nullable

Deterministic explanation of an exception collision after Entity Security filtering. The response omits a collision when fewer than two visible candidates remain.

object
CollisionId

Identifier of the visible collision evidence.

string
nullable
WorkerId

Affected Worker identifier, when applicable.

string
nullable
SiteId

Affected visible Site identifier, when applicable.

string
nullable
LocalStart

Inclusive local start of the collision window.

string format: date-time
LocalEnd

Exclusive local end of the collision window.

string format: date-time
WinnerExceptionId

Identifier of the visible winning exception.

string
nullable
CandidateExceptionIds

Identifiers of the visible candidates. At least two are present in every returned collision.

Array<string>
nullable
ResolutionReason

Deterministic precedence rule used to choose the visible winner.

string
nullable
Diagnostics
Array<object>
nullable

One structured partial-resolution diagnostic.

object
Code
string
nullable
LocalDate
string format: date
WorkerId
string
nullable
SiteId
string
nullable
CalendarId
string
nullable
Field
string
nullable
Errors
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Warnings
Array<object>
nullable
object
Code
required
string
nullable
Message
required
string
nullable
Target
string
nullable
Field
string
nullable
Metadata
object
key
additional properties
string
nullable
Type
integer format: int32
Allowed values: 0 1 2
Severity
integer format: int32
Allowed values: 0 1 2
Success
boolean
Example
{
"Errors": [
{
"Type": 0,
"Severity": 0
}
],
"Warnings": [
{
"Type": 0,
"Severity": 0
}
]
}