ScheduleInfo

Name ScheduleInfo
Usage SchedulingService
getSchedule getSchedulesByIds searchForSchedules validateSchedule createSchedule updateSchedule
Type Complex

Description

Information about a Schedule.

Structure Definition

ShortName Name Type Description Required? Read only? Cardinality XML Attribute? Implementation Notes
id Unique Id String The system assigned unique id to identify this Object.
Could be implemented as as sequence number or as a UUID.

Attempts to set this value on creates should result in a ReadOnlyException being thrown

An Id:

  • An id is used when the actual value is unimportant and
    can therefore be a large hex value for example

  • An id value might be 23b9ca9bd203df902

  • An Id is never intended to be used directly by an end
    user.

  • Ids are assumed to be of different values in different
    KS implementations

  • Id values are generated by the service
    implementations

  • Id values are never expected to be used in
    Configuration or Application code

 Required on updates Read only One Yes  
typeKey Type Key String A unique identifier for the type of this object. Required Read only One Yes  
stateKey State Key String A unique identifier for the state of this object. Required   One Yes  
name Name String A display name for this entity.     One No  
descr Description RichTextInfo A description of the entity.     One No  
atpId Atp Id String The ATP Id. Schedule Components are applied to this ATP. Required   One No  
scheduleComponents Schedule Components ScheduleComponentInfoList The Schedule Components. These provide a list of Time Slots
coupled with Room locations.		     Many No  
blackoutDates Blackout Dates DateRangeInfoList A list of blackout dates where a meeting time implied by the
ScheduleComponent is skipped.		     Many No  
blackoutMilestoneIds Blackout Milestone Ids StringList A list of Milestone Ids where a meeting time that occurs
within a Milestone is considered a blackout date. Milestones of
any of the Milestone Types that exist in the related ATP are
used to determine the blackout dates.		     Many No  
additionalMeetingTimes Meeting Times MeetingTimeInfoList A list of one-time MeetingTimes to add to this Schedule.     Many No  
meta Meta MetaInfo Create and last update info for the structure. This is optional
and treated as read only since the data is set by the internals
of the service during maintenance operations.

Contains audit trail information about the creation and last
update of this object Also contains the version ind used for
optimistic locking.

Attempts to set or update should result in a ReadOnlyException
being thrown.		 Required on updates Read only One No  
attributes Dynamic Attributes AttributeInfoList List of dynamic attributes, each holding a key-value pair that
can be configured to hold additional information for an
implementing institution.

Note: the key may be repeated more than once to simulate a list
of values.		     Many No