ExemptionRequestInfo

Name ExemptionRequestInfo
Usage ExemptionService
getExemptionRequest getExemptionRequestsByIds validateExemptionRequest createExemptionRequest updateExemptionRequest getRequestsByPerson getRequestsByRequester
Type Complex

Description

Information about an ExemptionRequest.

The qualifier, if it exists, qualifies the restriction exemption to
a scope, such as for a particular Program.

There can only be one override structure per exemption request. The
override structure available in this ExmeptionRequest is
constrained by the ExemptionRequest Type. What about populations
such as all athletes, or some other group of people?

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  
processKey Process Key String The key of a Process that indicates to what Process in the
the exemption is requested, if any.		     One No  
checkKey Check Id String The Id of a Check that indicates to what Check in the Process
the exemption is requested, if any.		     One No  
personId Person Id String The Id of the Person for whom the request is requested Required Read only on update One No  
requesterId Requester Id String The Id of the Person making the request.

If not specified it should default to the person identified in the supplied
contextInfo.		     One No  
requestDate Request Date Date The date of this exemption request.

If not specified it should default to today's date.		 Required   One No  
approvedByPersonId Approved By Person Id String The Id of the Person who approved this request.     One No  
approvedDate Approved Date Date The date this request was approved.     One No  
dateOverride Date Override DateOverrideInfo The detailed data for a date override.     One No  
milestoneOverride Milestone Override MilestoneOverrideInfo The data for a milestone override.

TODO: understand the exact usage of this.		     One No  
learningResultOverride Learning Result Override LearningResultOverrideInfo The data for a learning result override.

This is deprecated because it is just a PLACEHOLDER for eventual overrides
that are used in degree audit.		     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