AppointmentWindowInfo

Name AppointmentWindowInfo
Usage AppointmentService
getAppointmentWindow getAppointmentWindowsByIds getAppointmentWindowsByPeriod searchForAppointmentWindows validateAppointmentWindow createAppointmentWindow updateAppointmentWindow
Type Complex

Description

Information about an appointment window

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  
startDate Start Date Date Window start date ("Aug 05, 2012")     One No  
endDate End Date Date Window end date ("Aug 07, 2012"). Window end date does not constrain a slot duration. It is to ensure that the slot start time is not after the window end date.     One No Choosing this field expands number_of_persons_per_slot so all the persons in a population are assigned to the available slots.
slotRule Slot Rules AppointmentSlotRuleInfo Slot rules for appointment slot generation     One No  
periodMilestoneId Period Milestone Id String Appointment period milestone     One No This milestone may be mapped to an ATP ("FALL2013")
assignedPopulationId Assigned Population Id String The Population Id to which the appointment window is assigned.     One No  
assignedOrderTypeKey Assigned Order Type Key String Ordering for appointment slots assignment ("random"/"last name"/"GPA")     One No  
maxAppointmentsPerSlot Max Appointments Per Slot Integer Maximum number of persons that can be assigned to an appointment slot     One No Choosing this field expands the number_of_appointment_slots so all the persons in a population are assigned.
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