AppointmentSlotInfo

Name AppointmentSlotInfo
Usage AppointmentService
getAppointmentSlot getAppointmentSlotsByIds getAppointmentSlotsByPersonAndPeriod getAppointmentSlotsByWindow searchForAppointmentSlots validateAppointmentSlot createAppointmentSlot generateAppointmentSlotsByWindow updateAppointmentSlot
Type Complex

Description

Appointment slot information belonging to a person

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  
startDate Start Date Time Date Appointment start date and time ("Aug 05,2012 9:10am") Required   One No  
endDate End Date Time Date Appointment end date and time ("Aug 05,2012 9:20am")

If null then it means it has no end but in practice the
logic that checks to see if the student can register needs to also
check the milestone for the overall registration period to see
if the date is not past that date.		     One No Duration can be used here instead. However, since duration is in
AppointmentWindow, it is more useful to have actual end date and time on
an individual appointment
appointmentWindowId Window Id String Appointment window from which this appointment was generated Required Read only One 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